#include <CastPath.h>

Public Member Functions
virtual const WakeCaster *	Engine () const =0
	The engine shown by the BodyWake: its own WakeCaster, the group's for a member; null when nothing is cast.

virtual marenv::wake::WakeQuery	Query () const =0
	The query of the object's own flow (its registered field skipped, its private field composed in), before its jet is excluded; empty when nothing is cast.

virtual const OwnSourceMap *	OwnSources () const
	The own sources of the private field (ReceiverBinding::ownSources); null without them.

virtual int	OwnPoint () const
	The point of the own sources that every sample point leaves out (ReceiverBinding::ownPoint); -1: each point its own.

virtual bool	CastBody (double T, const double X, const WakeCastingObject body, ISimObjectLogger &logger)

virtual void	CastSet (double T, const double *X, const WakeSourceSet &set, ISimObjectLogger &logger)

Detailed Description

How a BodyWake casts: none, its own engine (a single body or a source set), or a group's.

Not thread-safe: Cast() runs in PreOdeFcn, which FhSim runs serially.

Member Function Documentation

virtual bool environment::wake::detail::CastPath::CastBody	(	double	T,
		const double *	X,
		const WakeCastingObject *	body,
		ISimObjectLogger &	logger
	)

virtual

Casts a body (SingleBodyWake): rebuilds its wake when due, or hands it to the group.

Parameters

[in]	T	Simulation time at the start of the step [s].
[in]	X	The global state vector, or null.
[in]	body	The body; null: nothing to cast (logged once with `CastWake`).
[in]	logger	The FhSim log.

Exceptions

std::logic_error from a path that casts no body (a source set's): SingleBodyWake never makes one.

virtual void environment::wake::detail::CastPath::CastSet	(	double	T,
		const double *	X,
		const WakeSourceSet &	set,
		ISimObjectLogger &	logger
	)

virtual

Casts a source set (SourceSetBodyWake): rebuilds its wakes when due.

Parameters

[in]	T	Simulation time at the start of the step [s].
[in]	X	The global state vector.
[in]	set	The object's sources.
[in]	logger	The FhSim log.

Exceptions

std::logic_error from a path that casts no source set (a single body's): SourceSetBodyWake never makes one.

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