environmentmodels::Environment Class Reference

Inheritance diagram for environmentmodels::Environment:

Collaboration diagram for environmentmodels::Environment:

Public Member Functions
	Environment (std::string simObjectName, ISimObjectCreator *creator)
	~Environment (void)
	Destructor.
void	OdeFcn (const double dT, const double *const adX, double *const adXDot) const override
void	PreOdeFcn (double T, const double *X) override

Constructor & Destructor Documentation

Environment()

environmentmodels::Environment::Environment	(	std::string	simObjectName,
		ISimObjectCreator *	creator
	)

Construct and initialise the environment from XML parameters.

Parameters

[in]	simObjectName	Unique name for this simulation object.
[in]	creator	Pointer to the object creator/registry.

Member Function Documentation

OdeFcn()

void environmentmodels::Environment::OdeFcn ( const double  dT, const double *const  adX, double *const  adXDot  ) const

override

ODE callback — the Environment has no dynamic state, so this does nothing.

Parameters

[in]	dT	Current simulation time [s] (unused).
[in]	adX	Current state vector (unused).
[out]	adXDot	State derivative vector (unused; not written).

PreOdeFcn()

void environmentmodels::Environment::PreOdeFcn ( double  T, const double *  X  )

override

Advances the moving scalar fields (aggregation fields) to time T, in whole update intervals.

Parameters

[in]	T	Current simulation time [s].
[in]	X	Current state vector (unused).

---

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

• webfhsim/reloadrepos/fhsim_environment/src/environment/Environment.h