FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
ConstantScalarField.h
1#pragma once
2
8#include <cmath>
9#include <marenv/field/ScalarField.h>
10#include <stdexcept>
11#include <string>
12#include <utility>
13#include <vector>
14
16{
17
28{
29public:
41 ConstantScalarField(std::string name,
42 Quantity quantity,
43 std::string unit,
44 double value,
45 std::vector<Property> properties = {})
46 : ScalarField(std::move(name), quantity, std::move(unit), std::move(properties))
47 , m_value(value)
48 {
49 if (!std::isfinite(m_value))
50 throw std::invalid_argument("ConstantScalarField '" + Name() + "': the value must be finite");
51 }
52
54 ~ConstantScalarField() override = default;
55
59 marenv::Status GetValue([[maybe_unused]] double time, [[maybe_unused]] const double position[3], double& value) const override
60 {
61 value = m_value;
62 return marenv::Status::OK;
63 }
64
68 [[nodiscard]] bool IsTimeInvariant() const override { return true; }
69
73 [[nodiscard]] bool IsThreadSafe() const override { return true; }
74
75private:
76 double m_value;
77};
78
79} // namespace marenv::field
Definition ConstantScalarField.h:28
marenv::Status GetValue(double time, const double position[3], double &value) const override
Definition ConstantScalarField.h:59
~ConstantScalarField() override=default
Default destructor.
ConstantScalarField(std::string name, Quantity quantity, std::string unit, double value, std::vector< Property > properties={})
Definition ConstantScalarField.h:41
bool IsThreadSafe() const override
Definition ConstantScalarField.h:73
bool IsTimeInvariant() const override
Definition ConstantScalarField.h:68
Definition ScalarField.h:81
const std::string & Name() const
Definition ScalarField.h:138
Quantity
Definition ScalarField.h:45
Status
Definition marenv.h:44
@ OK
The value is valid.
Scalar environment fields and their static metadata.
Definition ConstantScalarField.h:16