welltestpy.data.HeadVar
- class HeadVar(value, symbol='h', units='m', description='head given in meters')[source]
Bases:
Variable
Variable class special for groundwater head.
- Parameters
Notes
Here the variable name is fix set to
"head"
.- Attributes
Methods
__call__
([value])Call a variable.
save
([path, name])Save a variable to file.
- __call__(value=None)
Call a variable.
Here you can set a new value or you can get the value of the variable.
- Parameters
value (
int
orfloat
ornumpy.ndarray
,)optional – Value of the Variable. Default:
None
- Returns
value – Value of the Variable.
- Return type
int
orfloat
ornumpy.ndarray
- save(path='', name=None)
Save a variable to file.
This writes the variable to a csv file.
- Parameters
Notes
The file will get the suffix
".var"
.
- property value
Value.
- Type
int
orfloat
ornumpy.ndarray