Class IFreezingPoint¶
Defined in File IFreezingPoint.hpp
Inheritance Relationships¶
Base Type¶
public Nextsim::ModelComponent(Class ModelComponent)
Derived Types¶
public Nextsim::LinearFreezingImpl(Class LinearFreezingImpl)public Nextsim::UnescoFreezingImpl(Class UnescoFreezingImpl)
Class Documentation¶
-
class IFreezingPoint : public Nextsim::ModelComponent¶
The interface class for calculation of the freezing point of seawater.
Subclassed by Nextsim::LinearFreezingImpl, Nextsim::UnescoFreezingImpl
Public Functions
-
virtual ~IFreezingPoint() = default¶
-
inline virtual void setData(const ModelState::DataMap &state) override¶
Set the initial data of the component from the passed ModelState.
- Parameters:
state – The ModelState containing the data to be set.
-
virtual FloatType operator()(FloatType sss) const = 0¶
A virtual function that calculates the freezing point of seawater.
Freezing point in ˚C of water with the given salinity at standard pressure.
- Parameters:
sss – Sea surface salinity [PSU]
-
virtual void update(ModelArrayAuto &tf, const ConstModelArrayAuto &sss) const = 0¶
A virtual function that calculates the freezing point of seawater for the whole field.
Freezing point in ˚C of water with the given salinity at standard pressure.
- Parameters:
tf – Target for the freezing point [˚C].
sss – Sea surface salinity [PSU]
-
virtual ~IFreezingPoint() = default¶