Nextsim::DevStep Class Reference

A class providing a simple implementation of Iterator. More...

#include <DevStep.hpp>

Inheritance diagram for Nextsim::DevStep:

Collaboration diagram for Nextsim::DevStep:

Public Member Functions
void	writeRestartFile (const std::string &filePath) override
	Writes a restart file containing the current model state to the given file location.
void	setData (PrognosticData &pDat) override
	Sets the data object that will be used within the timesteps.
void	setMetadata (ModelMetadata &metadata) override
	Sets the metadata object that will be used within the timesteps.
void	init () override
	Initializes the model, based on some environment stored in the implementing class.
void	start (const TimePoint &startTime) override
void	iterate (const TimestepTime &dt) override
void	stop (const TimePoint &stopTime) override
Public Member Functions inherited from Nextsim::IModelStep
void	setInitFile (const std::string &filePath)
	Sets the path to the initial file for later reference.
Public Member Functions inherited from Nextsim::Iterator::Iterant
	Iterant (const Iterant &copyFrom)=default
Iterant &	operator= (const Iterant &copyFrom)=default
	Iterant (Iterant &&)=default
Iterant &	operator= (Iterant &&)=default

Additional Inherited Members
Protected Attributes inherited from Nextsim::IModelStep
std::string	initialRestartFilePath

Detailed Description

A class providing a simple implementation of Iterator.

Definition at line 19 of file DevStep.hpp.

Member Function Documentation

init()

void Nextsim::DevStep::init ( )

overridevirtual

Initializes the model, based on some environment stored in the implementing class.

Implements Nextsim::IModelStep.

Definition at line 15 of file DevStep.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

iterate()

void Nextsim::DevStep::iterate ( const TimestepTime & dt )

overridevirtual

Performs one iteration a specified length

Parameters

dt	The length of the timestep.

Implements Nextsim::IModelStep.

Definition at line 22 of file DevStep.cpp.

Here is the call graph for this function:

setData()

void Nextsim::DevStep::setData ( PrognosticData & data )

inlineoverridevirtual

Sets the data object that will be used within the timesteps.

Parameters

data	The PrognosticData holding the model data.

Implements Nextsim::IModelStep.

Definition at line 27 of file DevStep.hpp.

Here is the caller graph for this function:

setMetadata()

void Nextsim::DevStep::setMetadata ( ModelMetadata & meta )

inlineoverridevirtual

Sets the metadata object that will be used within the timesteps.

The ModelMetadata object will contain much constant information, primarily metadata about the model set up, but also time-dependent metadata, including the current time for which the model data is valid.

Parameters

meta	A ModelMetadata reference to the metadata instance

Implements Nextsim::IModelStep.

Definition at line 28 of file DevStep.hpp.

Here is the caller graph for this function:

start()

void Nextsim::DevStep::start ( const TimePoint & startTime )

inlineoverridevirtual

Initializes the iterant based on the start time.

Parameters

startTime

the time at the initialization of the iterant.

Implements Nextsim::IModelStep.

Definition at line 32 of file DevStep.hpp.

stop()

void Nextsim::DevStep::stop ( const TimePoint & stopTime )

inlineoverridevirtual

Finalizes the iterant based on the stop time.

Parameters

stopTime

the time at the finalization of the iterant.

Implements Nextsim::IModelStep.

Definition at line 34 of file DevStep.hpp.

writeRestartFile()

void Nextsim::DevStep::writeRestartFile ( const std::string & filePath )

inlineoverridevirtual

Writes a restart file containing the current model state to the given file location.

Parameters

filePath

The path to the location to write the file.

Implements Nextsim::IModelStep.

Definition at line 25 of file DevStep.hpp.

---

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

• /github/workspace/core/src/include/DevStep.hpp
• /github/workspace/core/src/DevStep.cpp