Inheritance diagram for Nextsim::Dynamics:

Collaboration diagram for Nextsim::Dynamics:

Public Member Functions
std::string	getName () const override
	Returns the name of the component.

void	update (const TimestepTime &tst) override

void	setData (const ModelState::DataMap &) override
	Set the initial data of the component from the passed ModelState.

Public Member Functions inherited from Nextsim::IDynamics
ModelState	getState () const override
	Returns a ModelState from this component.

ModelState	getState (const OutputLevel &) const override
	Returns a ModelState from this component at a specified level.

std::string	getName () const override
	Returns the name of the component.

void	setData (const ModelState::DataMap &ms) override
	Set the initial data of the component from the passed ModelState.

Public Member Functions inherited from Nextsim::ModelComponent
virtual ModelState	getStateRecursive (const OutputSpec &os) const
	Returns the state of the ModelComponent and any ModelComponents it depends on.

virtual std::unordered_set< std::string >	hFields () const
	Returns the names of all Type::H ModelArrays defined in this component.

virtual std::unordered_set< std::string >	uFields () const
	Returns the names of all Type::U ModelArrays defined in this component.

virtual std::unordered_set< std::string >	vFields () const
	Returns the names of all Type::V ModelArrays defined in this component.

virtual std::unordered_set< std::string >	zFields () const
	Returns the names of all Type::Z ModelArrays defined in this component.

Additional Inherited Members
Public Types inherited from Nextsim::ModelComponent
enum class	ProtectedArray { H_ICE , C_ICE , H_SNOW , T_ICE , T_AIR , DEW_2M , P_AIR , MIXRAT , SW_IN , LW_IN , MLD , SNOW , SSS , SST , EXT_SSS , EXT_SST , EVAP_MINUS_PRECIP , ML_BULK_CP , TF , WIND_SPEED , WIND_U , WIND_V , HTRUE_ICE , HTRUE_SNOW , OCEAN_U , OCEAN_V , ICE_U , ICE_V , SLAB_SST , SLAB_SSS , SLAB_QDW , SLAB_FDW , COUNT }

enum class	SharedArray { H_ICE = SharedArrayOffset , C_ICE , H_SNOW , T_ICE , Q_IA , Q_IC , Q_IO , Q_OW , DQIA_DT , Q_PEN_SW , HSNOW_MELT , SUBLIM , DELTA_HICE , DELTA_CICE , NEW_ICE , COUNT }

typedef Logged::level	OutputLevel

typedef std::function< void(size_t, const TimestepTime &)>	IteratedFn

Static Public Member Functions inherited from Nextsim::ModelComponent
static void	setAllModuleData (const ModelState &stateIn)

static ModelState	getAllModuleState ()

static void	unregisterAllModules ()

static void	getAllFieldNames (std::unordered_set< std::string > &uF, std::unordered_set< std::string > &vF, std::unordered_set< std::string > &zF)

static void	registerExternalSharedArray (SharedArray type, ModelArray *addr)
	Registers a ModelArray into a SharedArray slot from outside any ModelComponent object. Intended for testing and debugging.

static void	registerExternalProtectedArray (ProtectedArray type, ModelArray *addr)
	Registers a ModelArray into a ProtectedArray slot from outside any ModelComponent object. Intended for testing and debugging.

static const MARBackingStore &	getSharedArray ()
	Returns a const reference to the store for SharedArray fields.

static const MARConstBackingStore &	getProtectedArray ()
	Returns a const reference to the store for ProtectedArray fields.

Static Public Attributes inherited from Nextsim::ModelComponent
static const size_t	SharedArrayOffset = 0

Protected Member Functions inherited from Nextsim::ModelComponent
void	registerModule ()

Static Protected Member Functions inherited from Nextsim::ModelComponent
static void	registerSharedArray (SharedArray type, ModelArray *addr)

static void	registerProtectedArray (ProtectedArray type, const ModelArray *addr)

static void	overElements (IteratedFn fn, const TimestepTime &tst)

static void	setOceanMask (const ModelArray &mask)
	Sets the model-wide land-ocean mask (for HField arrays).

static void	noLandMask ()

static ModelArray	mask (const ModelArray &data)
	Returns a copy of the provided ModelArray, masked according to the land-ocean mask.

static const ModelArray &	oceanMask ()
	Returns the ocean mask.

Protected Attributes inherited from Nextsim::IDynamics
HField	uice

HField	vice

ModelArrayRef< ModelComponent::SharedArray::H_ICE, MARBackingStore, RW >	hice

ModelArrayRef< ModelComponent::SharedArray::C_ICE, MARBackingStore, RW >	cice

ModelArrayRef< ModelComponent::SharedArray::H_SNOW, MARBackingStore, RW >	hsnow

Static Protected Attributes inherited from Nextsim::ModelComponent
static ModelArray *	p_oceanMaskH = nullptr

Detailed Description

Definition at line 19 of file Dynamics.hpp.

Constructor & Destructor Documentation

◆ Dynamics()

Nextsim::Dynamics::Dynamics ( )

Definition at line 20 of file Dynamics.cpp.

Member Function Documentation

◆ getName()

std::string Nextsim::Dynamics::getName ( ) const

inlineoverridevirtual

Returns the name of the component.

Implements Nextsim::ModelComponent.

Definition at line 23 of file Dynamics.hpp.

◆ setData()

void Nextsim::Dynamics::setData ( const ModelState::DataMap & state )

overridevirtual

Set the initial data of the component from the passed ModelState.

Parameters

state The ModelState containing the data to be set.

Implements Nextsim::ModelComponent.

Definition at line 27 of file Dynamics.cpp.

◆ update()

void Nextsim::Dynamics::update ( const TimestepTime & tst )

overridevirtual

Implements Nextsim::IDynamics.

Definition at line 44 of file Dynamics.cpp.

The documentation for this class was generated from the following files:

/github/workspace/core/src/modules/include/Dynamics.hpp
/github/workspace/core/src/modules/Dynamics.cpp

Public Member Functions