Class BBMDynamics

• Defined in File BBMDynamics.hpp

Inheritance Relationships

Base Types

• public Nextsim::IDynamics (Class IDynamics)

• public Nextsim::Configured< BBMDynamics > (Template Class Configured)

Class Documentation

class BBMDynamics : public Nextsim::IDynamics, public Nextsim::Configured<BBMDynamics>

Public Types

enum [anonymous]

Values:

enumerator C_KEY

enumerator NU_KEY

enumerator YOUNG_KEY

enumerator P0_KEY

enumerator LAMBDA0_KEY

enumerator ALPHA_KEY

enumerator EXPPMAX_KEY

enumerator MU_KEY

enumerator NMAX_KEY

enumerator CLAB_KEY

enumerator NSTEPS_KEY

enumerator RHOI_KEY

enumerator RHOA_KEY

enumerator RHOO_KEY

enumerator CATM_KEY

enumerator COCEAN_KEY

enumerator FC_KEY

enumerator ANGLE_KEY

Public Functions

BBMDynamics()

inline virtual std::string getName() const override

Returns the name of the component.

virtual void prepareAdvection() override

virtual void update(const TimestepTime &tst) override

virtual void advectField(FloatType timestep, ModelArray &field, FloatType lowerLimit = -std::numeric_limits<FloatType>::infinity(), FloatType upperLimit = std::numeric_limits<FloatType>::infinity()) override

virtual void setData(const ModelState::DataMap&) override

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

Parameters:

state – The ModelState containing the data to be set.

virtual void configure() override

The configuration function.

virtual ConfigMap getConfiguration() const override

Returns the current configuration of the object.

Public Static Functions

static HelpMap &getHelpText(HelpMap &map, bool getAll)

static HelpMap &getHelpRecursive(HelpMap&, bool getAll)