testmodels::TestParticleField Class Reference

Inheritance diagram for testmodels::TestParticleField:

Collaboration diagram for testmodels::TestParticleField:

Public Member Functions
	TestParticleField (std::string SimObjectName, ISimObjectCreator *Creator)
void	OdeFcn (const double T, const double *const X, double *const XDot) const override
	ODE function - integrate particle dynamics.
void	FinalSetup (const double T, const double *const X, ISimObjectCreator *const Creator)
	Final setup - register state indices.
const double *	Position (const double T, const double *const X)
const double *	Velocity (const double T, const double *const X)

Constructor & Destructor Documentation

TestParticleField()

testmodels::TestParticleField::TestParticleField	(	std::string	SimObjectName,
		ISimObjectCreator *	Creator
	)

Construct particle field test.

Parameters

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

Member Function Documentation

Position()

const double * testmodels::TestParticleField::Position	(	const double	T,
		const double *const	X
	)

Get particle positions.

Parameters

[in]	T	Simulation time.
[in]	X	State vector.

Returns

Pointer to position array.

Velocity()

const double * testmodels::TestParticleField::Velocity	(	const double	T,
		const double *const	X
	)

Get particle velocities.

Parameters

[in]	T	Simulation time.
[in]	X	State vector.

Returns

Pointer to velocity array.

---

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

• /update_root/webfhsim/reloadrepos/fhsim_environment/src/testmodels/TestParticleField.h