1 of 5

Control Curve Parameters

Base Control Curve

General Description

Base class for all Parameters that rely on a the attached Node containing a control_curve Parameter.

Attributes

Name

Description

Required

Example

coming soon...

Control Curve Interpolated Parameter

General Description

A control curve Parameter that interpolates between three or more values.

Return values are linearly interpolated between control curves, with the first and last value being 100% and 0% respectively. API Reference

Attributes

Name

Description

Required

storage_node

An optional Storage node that can be used to query the current percentage volume

Yes

control_curves

The Parameter objects to use as a control curve(s)

Yes

values

A list of values to return corresponding to the control curves. The length of the list should be 2 + len(control_curves)

Yes

parameters

If values is None then parameters can specify a Parameter object to use at each of the control curves. The number of parameters should be 2 + len(control_curves)

Yes

Example

coming soon...

{

}

Control Curve Piecewise Interpolated Parameter

General Description

A control curve Parameter that interpolates between two or more pairs of values.

Return values are linearly interpolated between a pair of values depending on the current storage. The first pair is used between maximum and the first control curve, the next pair between the first control curve and second control curve, and so on until the last pair is used between the last control curve and the minimum value. The first value in each pair is the value at the upper position, and the second the value at the lower position.

Attributes

Name

Description

Required

Example

coming soon...

Control Curve Index Parameter

Example

{
	"type": "controlcurveindexparameter",
	"storage_node": "Reservoir name",
	"control_curves": [
		{
			"type": "monthlyprofileparameter",
			"values": [
				0.45,
				0.45,
			  	0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.6,
				0.6
				]
		},
		{
			"type": "constant",
			"value": 0.4
		},		
		{
			"type": "constant",
			"value": 0.1
		}		
	]
}

The above code defines 3 reservoir control curves for the reservoir called "Reservoir name". It returns an Index depending on how full the reservoir is:

To see how this index is used with an Indexed Array Parameter click here.

Control Curve Index Parameter

Example

{
	"type": "controlcurveindexparameter",
	"storage_node": "Reservoir name",
	"control_curves": [
		{
			"type": "monthlyprofileparameter",
			"values": [
				0.45,
				0.45,
			  	0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.6,
				0.6
				]
		},
		{
			"type": "constant",
			"value": 0.4
		},		
		{
			"type": "constant",
			"value": 0.1
		}		
	]
}

The above code defines 3 reservoir control curves for the reservoir called "Reservoir name". It returns an Index depending on how full the reservoir is:

To see how this index is used with an Indexed Array Parameter click here.

Control Curve Interpolated Parameter

General Description

A control curve Parameter that interpolates between three or more values.

Return values are linearly interpolated between control curves, with the first and last value being 100% and 0% respectively. API Reference

Attributes

Name

Description

Required

storage_node

An optional Storage node that can be used to query the current percentage volume

Yes

control_curves

The Parameter objects to use as a control curve(s)

Yes

values

A list of values to return corresponding to the control curves. The length of the list should be 2 + len(control_curves)

Yes

parameters

If values is None then parameters can specify a Parameter object to use at each of the control curves. The number of parameters should be 2 + len(control_curves)

Yes

Example

coming soon...

{

}