Constant

module wntr.msx.elements

class Constant

Bases: VariableBase

Constant coefficient for use in expressions.

Parameters:

• name (str) – Name of the variable.

• value – Constant value.

• units – Units for the variable, by default None

• note (str | dict | wntr.epanet.util.ENcomment) – Supplementary information regarding this variable, by default None

• _vars – Reaction system this constant is a part of, by default None

---

__init__(name, value, *, units=None, note=None, _vars=None)

Variable ABC init method.

Make sure you call this method from your concrete subclass __init__ method:

super().__init__(name, note=note)

Parameters:

• name (str) – Name/symbol for the variable. Must be a valid MSX variable name

• note ((str | dict | ENcomment), optional keyword) – Supplementary information regarding this variable, by default None (see-also NoteType)

Raises:

• KeyExistsError – Name is already taken

• ValueError – Name is a reserved word

to_dict()

Dictionary representation of the object

name: str

Name/ID of this variable, must be a valid EPANET/MSX ID

note: str | dict | ENcomment

Optional note regarding the variable (see NoteType)

units: str

Units of the constant

value: float

Value of the constant

property var_type: VariableType

Type of variable, CONSTANT.