environmentmodels::Environment Class Reference

Inheritance diagram for environmentmodels::Environment:

Collaboration diagram for environmentmodels::Environment:

Public Member Functions
	Environment (string simObjectName, ISimObjectCreator *creator)
	~Environment (void)
	Destructor.
void	OdeFcn (const double dT, const double *const adX, double *const adXDot, const bool bIsMajorTimeStep)

Constructor & Destructor Documentation

Environment()

environmentmodels::Environment::Environment	(	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 bool	bIsMajorTimeStep
	)

ODE callback — no dynamic state; forwards time to the wave field.

Parameters

[in]	dT	Current simulation time [s].
[in]	adX	Current state vector (unused).
[out]	adXDot	State derivative vector (unused; set to zero).
[in]	bIsMajorTimeStep	True on major (output) timesteps.

---

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

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