define_starting_values {heemod}

Define Starting State Values

Description

This function is meant to be used inside define_strategy() and define_state().

Usage

define_starting_values(...)

define_starting_values_(.dots)

Arguments

...

Name-value pairs of expressions defining starting values. The names must correspond to an existing state value.

.dots

Used to work around non-standard evaluation.

Details

The behaviour is different following the function using define_starting_values() as an argument.

• When used inside define_strategy(), the state values are modified for the first cycle in each state

• When used inside define_state(), the state values are modified for counts entering the state

Value

An object similar to the return value of define_parameters().