General Description

A Parameter which returns the value from an annual harmonic series.

This Parameter comprises a series N cosine function with a period of 365 days. The calculation is performed using the Julien day of the year minus 1. This causes a small discontinuity in non-leap years. API Reference

$f(t)=A+∑n=1NAn⋅cos((2πnt)/365+ϕn)$

Attributes

Example

coming soon...

{

}

General Description

Parameter that integrates a piecewise function.

This parameter calculates the integral of a piecewise function. The piecewise function is given as two arrays (x and y) and is assumed to start from (0, 0). The values of x should be monotonically increasing and greater than zero. API Reference

Attributes

Example

coming soon...

{

}

General Description

Parameter that returns the delayed flow for a node after a given number of timesteps or days. API Reference

Attributes

Example

coming soon...

{

}

General Description

Parameter that provides the flow from a node from the previous time-step. API Reference

Notes: This parameter keeps track of the previous time step’s flow on the given node. These values can be used in calculations for the current timestep as though this was any other parameter.

Attributes

Example

coming soon...

{

}

General Description

Parameter that returns the current discount factor based on discount rate and a base year. API Reference

Attributes

Example

coming soon...

{

}

General Description

Parameter track the deficit (max_flow - actual flow) of a Node. API Reference

Notes: This parameter is a little unusual in that it’s value is calculated during the after method, not calc_values. It is intended to be used in combination with a recorder (e.g. NumpyArrayNodeRecorder) to record the deficit ( defined as requested - actual flow) at a node. Note that this means recording this parameter does not give you the value that was used by the solver in this timestep. Alternatively, this parameter can be used in the model by other parameters and will evaluate to yesterdays deficit, where the deficit in the zeroth timestep is zero.

Attributes

Example

coming soon...

{

}

General Description

Parameter that utilises a different child parameter in each scenario ensemble.

This parameter is used to switch between different child parameters based on different ensembles in a given Scenario. It can be used to vary data in a non-scenario aware parameter type across multiple scenario ensembles. For example, many of control curve or interpolation parameters do not explicitly support scenarios. This parameter can be used to test multiple control curve definitions as part of a single simulation. API Reference

Attributes

Example

coming soon...

{

}