EPMacro {eplusr} | R Documentation |
Run EnergyPlus and its various processors
Description
Run EnergyPlus and its various processors
Usage
EPMacro(
model,
output_dir = NULL,
output_prefix = NULL,
wait = TRUE,
echo = TRUE,
eplus = NULL
)
ExpandObjects(
model,
output_dir = NULL,
output_prefix = NULL,
wait = TRUE,
echo = TRUE,
eplus = NULL,
idd = NULL
)
Basement(
model,
weather,
output_dir = NULL,
output_prefix = NULL,
wait = TRUE,
echo = TRUE,
eplus = NULL,
idd = NULL
)
Slab(
model,
weather,
output_dir = NULL,
output_prefix = NULL,
wait = TRUE,
echo = TRUE,
eplus = NULL,
idd = NULL
)
EnergyPlus(
model,
weather,
output_dir = NULL,
output_prefix = NULL,
output_suffix = c("C", "L", "D"),
wait = TRUE,
echo = TRUE,
annual = FALSE,
design_day = FALSE,
idd = NULL,
eplus = NULL
)
convertESOMTR(
eso,
output_dir = NULL,
output_prefix = NULL,
rules = NULL,
wait = TRUE,
echo = TRUE,
eplus = NULL
)
ReadVarsESO(
eso,
output_dir = NULL,
output_prefix = NULL,
output_suffix = c("C", "L", "D"),
max_col = NULL,
wait = TRUE,
echo = TRUE,
eplus = NULL
)
HVAC_Diagram(
bnd,
output_dir = NULL,
output_prefix = NULL,
wait = TRUE,
echo = TRUE,
eplus = NULL
)
energyplus(
model,
weather,
output_dir = NULL,
output_prefix = NULL,
output_suffix = c("C", "L", "D"),
epmacro = TRUE,
expand_obj = TRUE,
annual = FALSE,
design_day = FALSE,
eso_to_ip = FALSE,
readvars = TRUE,
echo = TRUE,
wait = TRUE,
idd = NULL,
eplus = NULL,
resources = NULL
)
Arguments
model |
[ |
output_dir |
[ |
output_prefix |
[ |
wait |
[ |
echo |
[ |
eplus |
[ |
idd |
[ |
weather |
[ |
output_suffix |
[
|
annual |
[ |
design_day |
[ |
eso |
[ |
bnd |
[ |
epmacro |
[ |
expand_obj |
[ |
eso_to_ip |
[ |
readvars |
[ |
resources |
[ |
Details
EPMacro()
calls the EnergyPlus EPMacro processor.
ExpandObjects()
calls the EnergyPlus ExpandObjects processor.
Basement()
calls the EnergyPlus Basement preprocessor.
Slab()
calls the EnergyPlus Slab preprocessor.
EnergyPlus()
calls EnergyPlus itself.
convertESOMTR()
calls EnergyPlus convertESOMTR post-processor.
ReadVarsESO()
calls EnergyPlus ReadVarsESO post-processor.
HVAC_Diagram()
calls EnergyPlus HVAC-Diagram post-processor.
energyplus()
is the one which correctly chains all the steps that call
those pre- and post- processors to form a complete EnergyPlus simulation.
Value
Functions except for energyplus()
return a list of two elements:
-
file
: a named list of full paths of output files -
run
: a named list of outputs from the process.
energyplus()
returns a list of 7 elements:
-
ver
: EnergyPlus version used -
energyplus
: EnergyPlus installation directory -
start_time
: aPOSIXct()
giving the local time when the simulation starts -
end_time
: aPOSIXct()
giving the local time when the simulation ends -
output_dir
: full path of output directory of simulation outputs -
file
: a named list of relative paths of output files underoutput_dir
-
run
: a data.table of each outputs from the all called processes
Note
energyplus()
can only run in waiting mode.