esm.MRD.input.conc {heR.Simulation}R Documentation

Multi-Room Dwelling Concentration Function

Description

Function to calculate room concentrations for the "Multi-Room Dwelling" exposure simulation model (ESM)

Usage

esm.MRD.input.conc(case, instances, inputs, index.inputs = NULL, times,
                   timeres = NULL, breaks = TRUE, options = NULL,
                   silent = FALSE)

Arguments

case the number of the current individual/case
instances a list containing data and indices for the currently-simulated house and its occupants
inputs a list containing the raw data inputs and distribution specifications
index.inputs a list containing the raw index inputs correspondng to the data in inputs
times a vector of times specifying the time domain and breaks used in the the final calculation of exposures
timeres the time resolution of the final exposure calculation, specified as a power of ten, e.g., 0.1, 1, or 10
breaks logical, whether exposures are calculated in terms of time series breaks or as bulk values of time spent in different exposure-related locations or activities, currently only the value of TRUE is relevant
options a list of options, see esm for details
silent logical, whether warnings are suppressed or not

Details

This function uses the cmpt function to calculate the time series of pollutant concentrations in each room.

Takes as input an instances list containing current data and index components for the house and its occupants, and returns the updated instances list. Also takes all other input-related arguments, and time-related arguments.

Here we create the final ``master event object'', which contains all the events needed to determine concentrations/exposures, by populating it with the time increments in times and the regular, atomic time increments specified by timeres. See esm.MRD.input.environ for preparation of the event time series for door and window positions, forced ventilation and other house conditions and occupant behaviors.

Value

A list containing the following components:

data a list of simulation data values for the current house and occupants, updated with the time series of room concentrations and concentration statistics. The concentrations are included as a subcomponent of a CN component of the list in the form of a cmpt output object. The CN component also contains a stats component containing the following statistics on the room concentrations:
room.mean
the mean concentration in each room
nsmk.mean
mean in nonsmoking rooms
smk.mean
mean in smoking rooms
main.means
mean in ``main'' rooms
ovrl.mean
mean across all ``main'' rooms
ovrl.sd
standard deviation across all ``main'' rooms
rel.sd
relative standard deviation across all ``main'' rooms
mean.abs.dev
mean absolute deviation across all ``main'' rooms
rel.mean.abs.dev
relative absolute mean deviation across all ``main'' rooms
index a list of demographic, geographic or other indices corresponding to the current house and occupants

Author(s)

Neil Klepeis

See Also

Concentrations are calculated using the cmpt function in the heR.IndoorAir package.

Other functions besides this one that are used in the preparation of input for the multi-room dwelling exposure simulation model are: esm.MRD.input.source; esm.MRD.input.receptor; and esm.MRD.input.environ.

Functions used in the multi-room dwelling exposure simulation model are esm.MRD.input, esm.MRD.expos and esm.MRD.output.

Distributions specifications are made using the distrib function.

The root function for executing an exposure simulation model is esm


[Package heR.Simulation version 0.0.3 Index]