environmentmodels::WakeGroup Class Reference

Inheritance diagram for environmentmodels::WakeGroup:

Collaboration diagram for environmentmodels::WakeGroup:

Public Member Functions
	WakeGroup (std::string SimObjectName, ISimObjectCreator *Creator)
void	SharedResourceSetup (ISimObjectCreator *Creator) override
void	PreOdeFcn (double T, const double *X, IStateUpdater *updater) override
void	OdeFcn (double T, const double *X, double *XDot) const override
	No state: nothing to integrate.
const environment::wake::detail::WakeGroupCaster &	Group () const
	The group's caster and members.

Constructor & Destructor Documentation

WakeGroup()

environmentmodels::WakeGroup::WakeGroup	(	std::string	SimObjectName,
		ISimObjectCreator *	Creator
	)

Reads the wake parameters of a source set.

Parameters

[in]	SimObjectName	Unique name; the members name it, and the lumped field is registered under it.
[in]	Creator	Supplies the parameters and is the group's log.

Exceptions

std::invalid_argument

on an invalid wake parameter, and without CastWake, after reporting it.

Member Function Documentation

PreOdeFcn()

void environmentmodels::WakeGroup::PreOdeFcn ( double  T, const double *  X, IStateUpdater *  updater  )

override

Rebuilds the group's wakes when due, unless a member did at this time.

Parameters

[in]	T	Simulation time [s].
[in]	X	Simulation state.
[in]	updater	State updater; not used.

SharedResourceSetup()

void environmentmodels::WakeGroup::SharedResourceSetup ( ISimObjectCreator *  Creator )

override

Makes the group known to the Environment, so that every member finds it in its FinalSetup.

Parameters

[in]

Creator

Supplies the shared Environment resource.

Exceptions

std::runtime_error

if the shared Environment resource is missing.

---

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

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