FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
ParametricScalarField.h
1#pragma once
2
8#include <array>
9#include <marenv/field/ScalarField.h>
10#include <marenv/seafloor/BathymetryField.h>
11#include <memory>
12#include <optional>
13#include <string>
14#include <vector>
15
16namespace marenv::field
17{
18
20enum class ZReference
21{
24 Surface,
29};
30
32enum class FeatureType
33{
45};
46
53struct Feature
54{
59 std::array<double, 3> centre {0.0, 0.0, 0.0};
62 std::array<double, 3> sigma {1.0, 1.0, 1.0};
65 double headingRad = 0.0;
68 double cosHeading = 1.0;
69 double sinHeading = 0.0;
70 double amplitude = 0.0;
73 double width = 1.0;
74};
75
78{
79 Constant,
81};
82
85{
87 double constant = 0.0;
88 std::vector<double> depth;
89 std::vector<double> value;
90};
91
94{
95 std::array<double, 3> minimum;
96 std::array<double, 3> maximum;
97};
98
107{
112 bool maskBelowSeabed = false;
114 std::vector<Feature> features;
117 std::optional<double> minimum;
119 std::optional<double> maximum;
123 std::optional<DomainBox> domain;
124};
125
166{
167public:
188 ParametricScalarField(std::string name,
189 Quantity quantity,
190 std::string unit,
192 std::shared_ptr<marenv::seafloor::BathymetryField> seafloor,
193 std::vector<Property> properties = {});
194
196 ~ParametricScalarField() override = default;
197
201 marenv::Status GetValue(double time, const double position[3], double& value) const override;
202
206 [[nodiscard]] bool IsTimeInvariant() const override { return true; }
207
218 [[nodiscard]] bool IsThreadSafe() const override { return true; }
219
220private:
228 [[nodiscard]] marenv::Status EvaluateBackground(double zEff, double& value) const;
229
231 [[nodiscard]] static double EvaluateFeature(const Feature& feature, double x, double y, double zEff);
232
234 [[nodiscard]] bool InsideDomain(double x, double y, double zEff) const;
235
236 ParametricFieldSpec m_spec;
237 std::shared_ptr<marenv::seafloor::BathymetryField> m_seafloor;
238 std::optional<marenv::calc::DepthProfile> m_backgroundProfile;
239 bool m_needsSeafloor;
240 double m_minimum;
241 double m_maximum;
242};
243
244} // namespace marenv::field
Definition ParametricScalarField.h:166
ParametricScalarField(std::string name, Quantity quantity, std::string unit, ParametricFieldSpec spec, std::shared_ptr< marenv::seafloor::BathymetryField > seafloor, std::vector< Property > properties={})
bool IsTimeInvariant() const override
Definition ParametricScalarField.h:206
marenv::Status GetValue(double time, const double position[3], double &value) const override
~ParametricScalarField() override=default
Default destructor.
bool IsThreadSafe() const override
Definition ParametricScalarField.h:218
Definition ScalarField.h:81
Quantity
Definition ScalarField.h:45
Status
Definition marenv.h:44
Scalar environment fields and their static metadata.
Definition ConstantScalarField.h:16
FeatureType
The analytic shapes a ParametricScalarField feature can take.
Definition ParametricScalarField.h:33
BackgroundType
How the horizontally uniform baseline of a ParametricScalarField is defined.
Definition ParametricScalarField.h:78
@ DepthProfile
Piecewise-linear vertical profile, clamped outside its layer range.
@ Constant
The same value everywhere.
ZReference
What the vertical coordinate of a ParametricScalarField configuration is measured from.
Definition ParametricScalarField.h:21
The horizontally uniform baseline a ParametricScalarField's features are added to.
Definition ParametricScalarField.h:85
std::vector< double > depth
DepthProfile: layer coordinates [m], strictly increasing.
Definition ParametricScalarField.h:88
std::vector< double > value
DepthProfile: value at each layer. Same length as depth.
Definition ParametricScalarField.h:89
BackgroundType type
Which member set is read.
Definition ParametricScalarField.h:86
double constant
Constant: the value everywhere.
Definition ParametricScalarField.h:87
An axis-aligned box outside which a ParametricScalarField reports its values inaccurate.
Definition ParametricScalarField.h:94
std::array< double, 3 > maximum
Upper corner [north, east, vertical] [m].
Definition ParametricScalarField.h:96
std::array< double, 3 > minimum
Lower corner [north, east, vertical] [m].
Definition ParametricScalarField.h:95
Definition ParametricScalarField.h:54
double sinHeading
sin(headingRad); filled with cosHeading.
Definition ParametricScalarField.h:69
double headingRad
Definition ParametricScalarField.h:65
double cosHeading
Definition ParametricScalarField.h:68
FeatureType type
Which shape to evaluate.
Definition ParametricScalarField.h:55
std::array< double, 3 > centre
Definition ParametricScalarField.h:59
std::array< double, 3 > sigma
Definition ParametricScalarField.h:62
double width
Definition ParametricScalarField.h:73
double amplitude
Peak contribution of the feature, in the field's unit.
Definition ParametricScalarField.h:70
Definition ParametricScalarField.h:107
Background background
The horizontally uniform baseline.
Definition ParametricScalarField.h:113
std::vector< Feature > features
Contributions summed on top of the baseline.
Definition ParametricScalarField.h:114
bool maskBelowSeabed
Definition ParametricScalarField.h:112
std::optional< double > maximum
Definition ParametricScalarField.h:119
std::optional< DomainBox > domain
Definition ParametricScalarField.h:123
std::optional< double > minimum
Definition ParametricScalarField.h:117
ZReference zReference
What the vertical coordinates mean.
Definition ParametricScalarField.h:108