WsfGuidedMover::State Class Reference

#include <WsfGuidedMover.hpp>

Collaboration diagram for WsfGuidedMover::State:

Public Member Functions
	State ()
	State (const State &aOther)=default
void	Print (ut::log::MessageStream &aMsgStream, double aFMM_Time)
State	Advance (double aDeltaT, const KinematicState &aKinematicState) const
void	UpdateOrientationData (double aSimTime, double aDeltaTime)
void	UpdateOtherStateData (double aSimTime)
void	TakeEulerStep (double aDeltaTime, const KinematicState &aDerivatives, const State &aInitialState, bool aIntegrateMass=false)
void	ComputeDerivatives (const double aAppliedForcesECS[3])
UtVec3d	ComputeDerivatives (const double aAppliedForcesECS[3]) const
void	ComputeGravitationalForce (double aGravitationalForceWCS[3]) const
KinematicState	GetDerivatives () const
KinematicState	GetUnpoweredDerivatives () const

Public Attributes
const WsfGuidedMover *	mMoverPtr {nullptr}
double	mTime
double	mWorld_ToECS_Transform [3][3]
double	mLocation [3]
double	mVelocity [3]
double	mAcceleration [3]
double	mAppliedForcesECS [3]
double	mLastThrustForcesECS [3]
double	mLastAeroForcesECS [3]
double	mPsi
double	mTheta
double	mPhi
double	mAltitude
double	mSpeed
double	mMach
double	mMass
double	mCurrentThrust
double	mCurrentFuelFlowRate
double	mThrustDurationExtension
	The amount of time the thrust duration is extended due to commanded throttle.
double	mDivertFuelMass
double	mCurrentFuelMass
CoordinateFrame	mCoordinateFrame {CoordinateFrame::cCF_WCS}
double	mECI_SwitchTime {-1.0E-30}
	The time when the WCS->ECI frame switch occurred.
bool	mLaunchToOrbit {false}
bool	mMaintainInclination {false}
	For launch-to-orbit, maintain the inclination as defined by the launch conditions (latitude and launch heading).

Detailed Description

Entity state data. The data is in WCS (ECEF) when the coordinate frame is WCS, and ECI when the coordinate frame is ECI. This is currently in spherical coordinates.

Constructor & Destructor Documentation

State() [1/2]

WsfGuidedMover::State::State

(

)

References mAcceleration, mAltitude, mAppliedForcesECS, mCurrentFuelFlowRate, mCurrentFuelMass, mCurrentThrust, mDivertFuelMass, mLastAeroForcesECS, mLastThrustForcesECS, mLocation, mMach, mMass, mPhi, mPsi, mSpeed, mTheta, mThrustDurationExtension, mTime, mVelocity, and mWorld_ToECS_Transform.

Referenced by Advance(), State(), and TakeEulerStep().

State() [2/2]

WsfGuidedMover::State::State ( const State & aOther )

default

References Advance(), ComputeDerivatives(), ComputeGravitationalForce(), GetDerivatives(), GetUnpoweredDerivatives(), Print(), State(), TakeEulerStep(), UpdateOrientationData(), and UpdateOtherStateData().

Member Function Documentation

Advance()

WsfGuidedMover::State WsfGuidedMover::State::Advance	(	double	aDeltaT,
		const KinematicState &	aKinematicState ) const

References WsfGuidedMoverBase::cPHASE_BURN, GetUnpoweredDerivatives(), mCurrentFuelFlowRate, mCurrentFuelMass, mMoverPtr, State(), and TakeEulerStep().

Referenced by State().

ComputeDerivatives() [1/2]

void WsfGuidedMover::State::ComputeDerivatives

(

const double

aAppliedForcesECS[3]

)

References ComputeGravitationalForce(), mAcceleration, mMass, and mWorld_ToECS_Transform.

Referenced by WsfGuidedMover::AdvanceTimeTrapezoidal(), WsfGuidedMover::ComputeFullForces(), GetUnpoweredDerivatives(), WsfGuidedMover::IntegrateEOM(), and State().

ComputeDerivatives() [2/2]

UtVec3d WsfGuidedMover::State::ComputeDerivatives

(

const double

aAppliedForcesECS[3]

)

const

References ComputeGravitationalForce(), mMass, and mWorld_ToECS_Transform.

ComputeGravitationalForce()

void WsfGuidedMover::State::ComputeGravitationalForce

(

double

aGravitationalForceWCS[3]

)

const

References mLocation.

Referenced by ComputeDerivatives(), ComputeDerivatives(), and State().

GetDerivatives()

WsfGuidedMover::KinematicState WsfGuidedMover::State::GetDerivatives

(

)

const

References mAcceleration, mCurrentFuelFlowRate, and mVelocity.

Referenced by WsfGuidedMover::IntegrateEOM(), and State().

GetUnpoweredDerivatives()

WsfGuidedMover::KinematicState WsfGuidedMover::State::GetUnpoweredDerivatives

(

)

const

References ComputeDerivatives(), mAppliedForcesECS, mLastThrustForcesECS, and mVelocity.

Referenced by Advance(), and State().

Print()

void WsfGuidedMover::State::Print	(	ut::log::MessageStream &	aMsgStream,
		double	aFMM_Time )

References mAcceleration, mLocation, mPhi, mPsi, mTheta, mTime, mVelocity, and mWorld_ToECS_Transform.

Referenced by State(), and UpdateOtherStateData().

TakeEulerStep()

void WsfGuidedMover::State::TakeEulerStep	(	double	aDeltaTime,
		const KinematicState &	aDerivatives,
		const State &	aInitialState,
		bool	aIntegrateMass = false )

References WsfGuidedMover::KinematicState::GetDmDt(), WsfGuidedMover::KinematicState::GetDvDt(), WsfGuidedMover::KinematicState::GetDxDt(), mCurrentFuelMass, mLocation, mTime, mVelocity, State(), and UpdateOtherStateData().

Referenced by Advance(), WsfGuidedMover::IntegrateEOM(), and State().

UpdateOrientationData()

void WsfGuidedMover::State::UpdateOrientationData	(	double	aSimTime,
		double	aDeltaTime )

References WsfGuidedMover::cCF_ECI, mCoordinateFrame, mECI_SwitchTime, mLaunchToOrbit, mLocation, mMaintainInclination, mPhi, mPsi, mTheta, mTime, mVelocity, and mWorld_ToECS_Transform.

Referenced by State(), and UpdateOtherStateData().

UpdateOtherStateData()

void WsfGuidedMover::State::UpdateOtherStateData

(

double

aSimTime

)

References WsfGuidedMover::cCF_WCS, deltaTime, mAltitude, mCoordinateFrame, mLocation, mMach, mMoverPtr, mSpeed, mTime, mVelocity, Print(), and UpdateOrientationData().

Referenced by WsfGuidedMover::AdvanceTimeLegacyRK4(), WsfGuidedMover::AdvanceTimeTrapezoidal(), State(), and TakeEulerStep().

Member Data Documentation

mAcceleration

double WsfGuidedMover::State::mAcceleration[3]

Referenced by WsfGuidedMover::AdvanceTimeLegacyRK4(), WsfGuidedMover::AdvanceTimeTrapezoidal(), ComputeDerivatives(), GetDerivatives(), Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), and WsfGuidedMover::UpdateExternalState().

mAltitude

double WsfGuidedMover::State::mAltitude

Referenced by WsfGuidedMover::ComputeDivertForces(), WsfGuidedMover::GetHorizontalThrust(), WsfGuidedMover::GetLevelFlightThrust(), WsfGuidedMover::SelectCoordinateFrame(), State(), and UpdateOtherStateData().

mAppliedForcesECS

double WsfGuidedMover::State::mAppliedForcesECS[3]

Referenced by WsfGuidedMover::ComputeFullForces(), GetUnpoweredDerivatives(), and State().

mCoordinateFrame

CoordinateFrame WsfGuidedMover::State::mCoordinateFrame {CoordinateFrame::cCF_WCS}

Referenced by WsfGuidedMover::SelectCoordinateFrame(), WsfGuidedMover::SwitchCoordinateFrame(), WsfGuidedMover::UpdateExternalState(), UpdateOrientationData(), and UpdateOtherStateData().

mCurrentFuelFlowRate

double WsfGuidedMover::State::mCurrentFuelFlowRate

Referenced by Advance(), WsfGuidedMover::ComputeThrustForces(), WsfGuidedMover::ComputeThrustForCommandedSpeed(), GetDerivatives(), WsfGuidedMover::GetHorizontalThrust(), and State().

mCurrentFuelMass

double WsfGuidedMover::State::mCurrentFuelMass

Referenced by Advance(), State(), and TakeEulerStep().

mCurrentThrust

double WsfGuidedMover::State::mCurrentThrust

Referenced by WsfGuidedMover::ComputeThrustForces(), WsfGuidedMover::ComputeThrustForCommandedSpeed(), and State().

mDivertFuelMass

double WsfGuidedMover::State::mDivertFuelMass

Referenced by WsfGuidedMover::ComputeDivertForces(), and State().

mECI_SwitchTime

double WsfGuidedMover::State::mECI_SwitchTime {-1.0E-30}

The time when the WCS->ECI frame switch occurred.

Referenced by WsfGuidedMover::UpdateExternalState(), and UpdateOrientationData().

mLastAeroForcesECS

double WsfGuidedMover::State::mLastAeroForcesECS[3]

Referenced by WsfGuidedMover::ComputeFullForces(), and State().

mLastThrustForcesECS

double WsfGuidedMover::State::mLastThrustForcesECS[3]

Referenced by WsfGuidedMover::ComputeFullForces(), GetUnpoweredDerivatives(), and State().

mLaunchToOrbit

bool WsfGuidedMover::State::mLaunchToOrbit {false}

'true' if the mission is launch-to-orbit

Referenced by WsfGuidedMover::SwitchCoordinateFrame(), and UpdateOrientationData().

mLocation

double WsfGuidedMover::State::mLocation[3]

Referenced by WsfGuidedMover::AdvanceTimeLegacyRK4(), WsfGuidedMover::AdvanceTimeTrapezoidal(), ComputeGravitationalForce(), Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), TakeEulerStep(), WsfGuidedMover::UpdateExternalState(), UpdateOrientationData(), and UpdateOtherStateData().

mMach

double WsfGuidedMover::State::mMach

Referenced by WsfGuidedMover::GetLevelFlightThrust(), State(), and UpdateOtherStateData().

mMaintainInclination

bool WsfGuidedMover::State::mMaintainInclination {false}

For launch-to-orbit, maintain the inclination as defined by the launch conditions (latitude and launch heading).

Referenced by WsfGuidedMover::SwitchCoordinateFrame(), and UpdateOrientationData().

mMass

double WsfGuidedMover::State::mMass

Referenced by ComputeDerivatives(), ComputeDerivatives(), and State().

mMoverPtr

const WsfGuidedMover* WsfGuidedMover::State::mMoverPtr {nullptr}

Referenced by Advance(), WsfGuidedMover::AdvanceTimeLegacyRK4(), WsfGuidedMover::AdvanceTimeTrapezoidal(), WsfGuidedMover::IntegrateEOM(), and UpdateOtherStateData().

mPhi

double WsfGuidedMover::State::mPhi

Referenced by Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), and UpdateOrientationData().

mPsi

double WsfGuidedMover::State::mPsi

Referenced by Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), and UpdateOrientationData().

mSpeed

double WsfGuidedMover::State::mSpeed

Referenced by State(), WsfGuidedMover::SwitchCoordinateFrame(), and UpdateOtherStateData().

mTheta

double WsfGuidedMover::State::mTheta

Referenced by Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), and UpdateOrientationData().

mThrustDurationExtension

double WsfGuidedMover::State::mThrustDurationExtension

The amount of time the thrust duration is extended due to commanded throttle.

Referenced by WsfGuidedMover::GetHorizontalThrust(), and State().

mTime

double WsfGuidedMover::State::mTime

Referenced by WsfGuidedMover::AdvanceTimeLegacyRK2(), WsfGuidedMover::AdvanceTimeLegacyRK4(), WsfGuidedMover::AdvanceTimeTrapezoidal(), Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), TakeEulerStep(), WsfGuidedMover::UpdateExternalState(), UpdateOrientationData(), and UpdateOtherStateData().

mVelocity

double WsfGuidedMover::State::mVelocity[3]

Referenced by WsfGuidedMover::AdvanceTimeLegacyRK4(), WsfGuidedMover::AdvanceTimeTrapezoidal(), GetDerivatives(), GetUnpoweredDerivatives(), Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), TakeEulerStep(), WsfGuidedMover::UpdateExternalState(), UpdateOrientationData(), and UpdateOtherStateData().

mWorld_ToECS_Transform

double WsfGuidedMover::State::mWorld_ToECS_Transform[3][3]

Referenced by ComputeDerivatives(), ComputeDerivatives(), Print(), State(), WsfGuidedMover::SwitchCoordinateFrame(), WsfGuidedMover::UpdateExternalState(), and UpdateOrientationData().

---

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

• WsfGuidedMover.hpp
• WsfGuidedMover.cpp