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

Multi-Room Dwelling Input Function

Description

Produce final input data for a current instance of the "Multi-Room Dwelling" exposure simulation model (ESM) using specified distributions and raw data

Usage

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

Arguments

case the number of the current indivdual or case being simulated
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 is intended to be called from the esm function and not called directly by the user. However, it can be called directly for use in debugging.

There are four other functions that this function calls to prepare the input data for the Multi-Room Dwelling exposure simulation model (ESM):

esm.MRD.input.source
source-person locations and activity, emission factors
esm.MRD.input.receptor
receptor-person locations and activity
esm.MRD.input.environ
building characteristics, control scenarios, event time series such as door and window position and forced ventilation
esm.MRD.input.conc
time series of room pollutant concentrations

These ESM input functions translate from convenient user inputs into more complex data forms used as input into simulation functions, e.g., multi-compartment concentrations, house layout, house flows, house connections, and exposures. They prepare the final input for the simulation based on raw user data input (or function input) and user options.

We pass the inputs into each input function, which in turn process the inputs and contribute their own data ``instance'' for the individual(s) currently being processed. In other words, we are handing off the ``ball'' (raw data inputs) to each ``player'' (function), which runs it part of the way downfield, i.e., towards the final goal of a complete input specification for the present exposure calculation.

To synchronize times, locations, door position, window position, central air, etc., we create a single master time-activity object containing event sets for each type of event with enough breaks to delineate the times that these events occur. There are likely to be a number of repeated events for some of the time lines.

The documentation for each component function listed above contains the details of how model input is produced and in what form it is returned. See the esm function for more information on the form of options and other arguments.

Value

A list containing ``instances'' or particular values of input corresponding to the simulated house and occupants. The list has list components:

data the final set of simulated input data including a master event object and room concentration time series
index values of demographic, geographic, and indentification information for the current set of house occupants


See the documentation for the functions listed above for details on the contents of the returned data and index components.

Author(s)

Neil Klepeis

See Also

This function calls the following functions to assist in preparing the final multi-room dwelling model input: esm.MRD.input.source; esm.MRD.input.receptor; esm.MRD.input.environ; and esm.MRD.input.conc.

Other functions used in the multi-room dwelling exposure simulation model are 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]