FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
ScalarField.h
1#pragma once
2
8#include <array>
9#include <marenv/calc/DepthProfile.h>
10#include <marenv/marenv.h>
11#include <span>
12#include <string>
13#include <utility>
14#include <vector>
15
17namespace marenv::field
18{
19
30{
31 std::string key;
32 double value;
33};
34
44enum class Quantity
45{
47 Salinity,
49 Other
50};
51
81{
82public:
84 virtual ~ScalarField() = default;
85
100 virtual marenv::Status GetValue(double time, const double position[3], double& value) const = 0;
101
109 [[nodiscard]] virtual bool IsTimeInvariant() const { return false; }
110
120 [[nodiscard]] virtual bool IsThreadSafe() const { return false; }
121
133 virtual void GetValues(double time, std::span<const std::array<double, 3>> positions, std::span<double> values, std::span<marenv::Status> statuses) const;
134
138 [[nodiscard]] const std::string& Name() const { return m_name; }
139
143 [[nodiscard]] Quantity GetQuantity() const { return m_quantity; }
144
150 [[nodiscard]] const std::string& Unit() const { return m_unit; }
151
155 [[nodiscard]] const std::vector<Property>& Properties() const { return m_properties; }
156
162 [[nodiscard]] bool Has(const std::string& key) const;
163
170 [[nodiscard]] double Get(const std::string& key, double fallback = 0.0) const;
171
176 [[nodiscard]] const std::string& Species() const { return m_species; }
177
182 void SetSpecies(std::string species) { m_species = std::move(species); }
183
184protected:
195 ScalarField(std::string name, Quantity quantity, std::string unit, std::vector<Property> properties);
196
197private:
198 std::string m_name;
199 Quantity m_quantity;
200 std::string m_unit;
201 std::vector<Property> m_properties;
202 std::string m_species;
203};
204
225marenv::calc::DepthProfile MakeDepthProfile(std::vector<double> depths, std::vector<double> values, const std::string& context);
226
227} // namespace marenv::field
Definition DepthProfile.h:28
Definition ScalarField.h:81
ScalarField(std::string name, Quantity quantity, std::string unit, std::vector< Property > properties)
bool Has(const std::string &key) const
virtual bool IsThreadSafe() const
Definition ScalarField.h:120
Quantity GetQuantity() const
Definition ScalarField.h:143
double Get(const std::string &key, double fallback=0.0) const
virtual marenv::Status GetValue(double time, const double position[3], double &value) const =0
const std::string & Species() const
Definition ScalarField.h:176
virtual void GetValues(double time, std::span< const std::array< double, 3 > > positions, std::span< double > values, std::span< marenv::Status > statuses) const
virtual bool IsTimeInvariant() const
Definition ScalarField.h:109
const std::string & Name() const
Definition ScalarField.h:138
virtual ~ScalarField()=default
Virtual destructor.
void SetSpecies(std::string species)
Definition ScalarField.h:182
const std::vector< Property > & Properties() const
Definition ScalarField.h:155
const std::string & Unit() const
Definition ScalarField.h:150
marenv::calc::DepthProfile MakeDepthProfile(std::vector< double > depths, std::vector< double > values, const std::string &context)
Quantity
Definition ScalarField.h:45
@ SpeciesConcentration
Biomass concentration of one species, conventionally [kg/m^3].
@ Other
Anything else.
@ Salinity
Water salinity, conventionally [PSU].
@ Temperature
Water temperature, conventionally [degC].
Status
Definition marenv.h:44
Scalar environment fields and their static metadata.
Definition ConstantScalarField.h:16
Policy mixin: this type is neither copyable nor movable.
Definition marenv.h:112
Definition ScalarField.h:30
double value
Property value.
Definition ScalarField.h:32
std::string key
Property key, e.g. "LengthM". The unit is defined by the key.
Definition ScalarField.h:31