|
FhSim
3.1.0
Marine systems simulation
|
#include <ParametricScalarField.h>
Collaboration diagram for marenv::field::ParametricFieldSpec:Public Attributes | |
| ZReference | zReference = ZReference::Surface |
| What the vertical coordinates mean. | |
| bool | maskBelowSeabed = false |
| Background | background |
| The horizontally uniform baseline. | |
| std::vector< Feature > | features |
| Contributions summed on top of the baseline. | |
| std::optional< double > | minimum |
| std::optional< double > | maximum |
| std::optional< DomainBox > | domain |
The complete configuration of a ParametricScalarField.
| std::optional<DomainBox> marenv::field::ParametricFieldSpec::domain |
Optional validity box. Inside it GetValue returns marenv::Status::OK; outside it the value is still evaluated but reported as marenv::Status::OUT_OF_RANGE_INACCURATE.
| bool marenv::field::ParametricFieldSpec::maskBelowSeabed = false |
When true, a query below the seabed returns 0 and marenv::Status::OUT_OF_RANGE_INACCURATE instead of an extrapolated value. Needs the bathymetry given at construction; from XML that is the Environment's at setup.
| std::optional<double> marenv::field::ParametricFieldSpec::maximum |
Upper clamp limit. When unset it defaults to positive infinity.
| std::optional<double> marenv::field::ParametricFieldSpec::minimum |
Lower clamp limit. When unset it defaults to 0 for Quantity::SpeciesConcentration - a negative biomass is meaningless - and to negative infinity otherwise.