param: Create and Run Parametric Analysis, and Collect Results

Description Details Usage Create Get Seed Model and Weather Apply Design Alternatives Run and Collect Results Author(s)

Description

ParametricJob class provides a prototype of conducting parametric analysis of EnergyPlus simulations.

Details

Basically, it is a collection of multiple EplusJob objects.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
param <- param_job(idf, epw)
param$apply_measure(measure, ..., .names = NULL)
param$run(dir = NULL, parallel_backend = future::multiprocess)
param$kill(which = NULL)
param$status(which = NULL)
param$errors(info = FALSE)
param$output_dir(which = NULL)
param$locate_output(which = NULL, suffix = ".err", strict = TRUE)
param$report_data_dict(which = NULL)
param$report_data(which = NULL, key_value = NULL, name = NULL, year = NULL, tz = "GMT", case = "auto")
param$tabular_data(which = NULL)
param$print()

Create

1

Arguments

Get Seed Model and Weather

1
2
param$seed()
param$weather()

$seed() will return the input Idf object.

$weather() will return the input Epw object.

Apply Design Alternatives

1
param$apply_measure(measure, ..., .names = NULL)

$apply_measure() allows to apply a measure to an Idf and creates parametric models for analysis. Basically, a measure is just a function that takes an Idf object and other arguments as input, and returns a modified Idf object as output. Use ... to supply different arguments to that measure. Under the hook, mapply() is used to create multiple Idfs according to the input values.

Arguments

Run and Collect Results

1
2
3
4
5
6
7
8
9
param$run(dir = NULL, parallel_backend = future::multiprocess)
param$kill(which = NULL)
param$status(which = NULL)
param$errors(info = FALSE)
param$output_dir(which = NULL)
param$locate_output(which = NULL, suffix = ".err", strict = TRUE)
param$report_data_dict(which = NULL)
param$report_data(which = NULL, key_value = NULL, name = NULL, year = NULL, tz = "GMT", case = "auto")
param$tabular_data(which = NULL)

All those functions have the same meaning in EplusJob class, except that they only return the results of specified simulation.

Arguments

All other arguments have the same meanings as in EplusJob class.

Author(s)

Hongyuan Jia


hongyuanjia/eplusr documentation built on Aug. 12, 2018, 12:24 p.m.