ogstools.ogs6py.parameters module#
- class ogstools.ogs6py.parameters.Parameters[source]#
Bases:
BuildTree
Class for managing the parameters section of the project file.
- add_parameter(**args)[source]#
Adds a parameter.
Parameters#
- namestr
name of the parameter
- typestr
type of the parameter, one of Constant, CurveScaled, Function, Group, MeshElement, MeshNode, RandomFieldMeshElement, Raster, or TimeDependentHeterogeneousParameter
- valuefloat or str
value for a constant parameter
- valuesfloat or str
values for a constant parameter
- expressionstr
expression describing a function (valid for function parameter)
- curvestr
name of the curve (used in CurveScaled parameter)
- parameterstr
used in CurveScaled parameter, name of the parameter scaled by the curve
- meshstr
used in MeshElement or MeshNode parameter; specification of the mesh the parameter is defined on
- field_namestr
used in MeshElement or MeshNode parameter; reference to the PropertyVector / DataArray given in the mesh
- timelist
used in TimeDependentHeterogeneousParameter
- parameter_namelist
used in CurveScaled to specify the parameter that shall be scaled use_local_coordinate_system : bool or str