#include <WsfSixDOF_Engine.hpp>

Inheritance diagram for wsf::six_dof::Engine:

[legend]

Collaboration diagram for wsf::six_dof::Engine:

[legend]

Public Member Functions
	Engine (ThrustProducerObject *aParentObject)
virtual	~Engine ()=default
Engine &	operator= (const Engine &other)=delete
virtual Engine *	Clone () const =0
virtual bool	ProcessInput (UtInput &aInput, TypeManager *aTypeManager)=0
virtual bool	Initialize (int64_t aSimTime_nanosec)=0
virtual void	DeriveFrom (const Engine *aSrc)
ThrustProducerObject *	GetParentThrustProducer ()
void	SetParentThrustProducer (ThrustProducerObject *aThrustProducerPtr)
double	GetThrust_lbs () const
virtual double	GetMaximumPotentialThrust_lbs (double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad)=0
virtual double	GetMinimumPotentialThrust_lbs (double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad)=0
void	CalculateThrust (double aDeltaT_sec, double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad, double &aForce_lbs, double &aFuelBurnRate_pps, double &aFuelBurned_lbs)
void	UpdateThrust (double aDeltaT_sec, double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad, double &aForce_lbs, double &aFuelBurnRate_pps, double &aFuelBurned_lbs)
bool	CheckCurrentFuelTank ()
virtual bool	SetFuelTank (const std::string &aFuelTankName)
const FuelTank *	GetFuelTank () const
virtual double	GetFuelBurnRate_pph () const =0
virtual double	GetThrottlePosition () const =0
virtual void	SetThrottlePosition (double aThrottleLeverPosition)=0
virtual void	Ignite (int64_t aIgniteTimeInFrame_nanosec)=0
virtual void	Shutdown (int64_t aTerminateTime_nanosec=0)=0
bool	EngineOperating () const
virtual bool	MayHaveEngineOperating () const
virtual bool	MayProduceEngineSmoke () const
virtual bool	MayContrail () const
bool	ProducingSmokeTrail () const
virtual bool	MayProduceSmokeTrail () const
bool	AfterburnerOn () const
bool	Contrailing () const
bool	EngineSmoking () const
void	MakeEngineSmoke (bool aSmoking)
virtual bool	AfterburnerIsPresent () const

Protected Member Functions
	Engine (const Engine &aSrc)
virtual void	CalculateThrust (double aDeltaT_sec, double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad, double &aForce_lbs, double &aFuelBurnRate_pps, double &aFuelBurned_lbs, bool aUpdateData)=0

Protected Attributes
ThrustProducerObject *	mParentThrustProducerPtr = nullptr
std::string	mTypeOfEngine
FuelTank *	mCurrentFuelTank = nullptr
double	mCurrentThrust_lbs = 0.0
bool	mShutdownInProgress = false
int64_t	mShutdownFraction_nanosec = 0
int64_t	mIgniteTimeInFrame_nanosec = 0
bool	mEngineOperating = false
bool	mContrailing = false
bool	mAfterburnerPresent = false
bool	mAfterburnerOn = false
bool	mProducingSmokeTrail = false
bool	mEngineDamageSmokeActivated = false
bool	mEngineSmoking = false

Constructor & Destructor Documentation

◆ Engine() [1/2]

wsf::six_dof::Engine::Engine ( ThrustProducerObject * aParentObject )

explicit

References mParentThrustProducerPtr.

◆ ~Engine()

virtual wsf::six_dof::Engine::~Engine ( )

virtualdefault

◆ Engine() [2/2]

wsf::six_dof::Engine::Engine ( const Engine & aSrc )

explicitprotected

References Engine(), mAfterburnerOn, mAfterburnerPresent, mContrailing, mCurrentFuelTank, mCurrentThrust_lbs, mEngineDamageSmokeActivated, mEngineOperating, mEngineSmoking, mIgniteTimeInFrame_nanosec, mParentThrustProducerPtr, mProducingSmokeTrail, mShutdownFraction_nanosec, mShutdownInProgress, and mTypeOfEngine.

Member Function Documentation

◆ AfterburnerIsPresent()

virtual bool wsf::six_dof::Engine::AfterburnerIsPresent ( ) const

inlinevirtual

References mAfterburnerPresent.

Referenced by wsf::six_dof::JetEngine::Ignite().

◆ AfterburnerOn()

bool wsf::six_dof::Engine::AfterburnerOn ( ) const

inline

References mAfterburnerOn.

◆ CalculateThrust() [1/2]

void wsf::six_dof::Engine::CalculateThrust	(	double	aDeltaT_sec,
		double	aAlt_ft,
		double	aDynPress_lbsqft,
		double	aStatPress_lbssqft,
		double	aSpeed_fps,
		double	aMach,
		double	aAlpha_rad,
		double	aBeta_rad,
		double &	aForce_lbs,
		double &	aFuelBurnRate_pps,
		double &	aFuelBurned_lbs )

References CalculateThrust().

Referenced by CalculateThrust(), wsf::six_dof::RamjetEngine::GetMaximumPotentialThrust_lbs(), wsf::six_dof::RocketSolidPropellantEngine::GetMaximumPotentialThrust_lbs(), GetMinimumPotentialThrust_lbs(), wsf::six_dof::RamjetEngine::GetMinimumPotentialThrust_lbs(), and UpdateThrust().

◆ CalculateThrust() [2/2]

virtual void wsf::six_dof::Engine::CalculateThrust	(	double	aDeltaT_sec,
		double	aAlt_ft,
		double	aDynPress_lbsqft,
		double	aStatPress_lbssqft,
		double	aSpeed_fps,
		double	aMach,
		double	aAlpha_rad,
		double	aBeta_rad,
		double &	aForce_lbs,
		double &	aFuelBurnRate_pps,
		double &	aFuelBurned_lbs,
		bool	aUpdateData )

protectedpure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ CheckCurrentFuelTank()

bool wsf::six_dof::Engine::CheckCurrentFuelTank ( )

References mCurrentFuelTank, and mParentThrustProducerPtr.

Referenced by GetMinimumPotentialThrust_lbs().

◆ Clone()

virtual Engine * wsf::six_dof::Engine::Clone ( ) const

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

References Engine().

Referenced by wsf::six_dof::MoverTestObject::GetTestEngineFromThrustProducer().

◆ Contrailing()

bool wsf::six_dof::Engine::Contrailing ( ) const

inline

References mContrailing.

◆ DeriveFrom()

void wsf::six_dof::Engine::DeriveFrom ( const Engine * aSrc )

virtual

Reimplemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

References Engine(), and mTypeOfEngine.

Referenced by wsf::six_dof::JetEngine::DeriveFrom(), wsf::six_dof::RamjetEngine::DeriveFrom(), wsf::six_dof::RocketLiquidPropellantEngine::DeriveFrom(), wsf::six_dof::RocketSolidPropellantEngine::DeriveFrom(), and Initialize().

◆ EngineOperating()

bool wsf::six_dof::Engine::EngineOperating ( ) const

inline

References mEngineOperating.

◆ EngineSmoking()

bool wsf::six_dof::Engine::EngineSmoking ( ) const

inline

References mEngineSmoking.

◆ GetFuelBurnRate_pph()

virtual double wsf::six_dof::Engine::GetFuelBurnRate_pph ( ) const

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ GetFuelTank()

const FuelTank * wsf::six_dof::Engine::GetFuelTank ( ) const

inline

References mCurrentFuelTank.

Referenced by wsf::six_dof::MoverTestObject::GetTestEngineFromThrustProducer().

◆ GetMaximumPotentialThrust_lbs()

virtual double wsf::six_dof::Engine::GetMaximumPotentialThrust_lbs	(	double	aAlt_ft,
		double	aDynPress_lbsqft,
		double	aStatPress_lbssqft,
		double	aSpeed_fps,
		double	aMach,
		double	aAlpha_rad,
		double	aBeta_rad )

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ GetMinimumPotentialThrust_lbs()

virtual double wsf::six_dof::Engine::GetMinimumPotentialThrust_lbs	(	double	aAlt_ft,
		double	aDynPress_lbsqft,
		double	aStatPress_lbssqft,
		double	aSpeed_fps,
		double	aMach,
		double	aAlpha_rad,
		double	aBeta_rad )

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

References CalculateThrust(), CheckCurrentFuelTank(), SetFuelTank(), and UpdateThrust().

◆ GetParentThrustProducer()

ThrustProducerObject * wsf::six_dof::Engine::GetParentThrustProducer ( )

inline

References mParentThrustProducerPtr.

◆ GetThrottlePosition()

virtual double wsf::six_dof::Engine::GetThrottlePosition ( ) const

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ GetThrust_lbs()

double wsf::six_dof::Engine::GetThrust_lbs ( ) const

inline

References mCurrentThrust_lbs.

◆ Ignite()

virtual void wsf::six_dof::Engine::Ignite ( int64_t aIgniteTimeInFrame_nanosec )

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ Initialize()

virtual bool wsf::six_dof::Engine::Initialize ( int64_t aSimTime_nanosec )

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

References DeriveFrom(), and Engine().

◆ MakeEngineSmoke()

void wsf::six_dof::Engine::MakeEngineSmoke ( bool aSmoking )

inline

References mEngineDamageSmokeActivated.

◆ MayContrail()

virtual bool wsf::six_dof::Engine::MayContrail ( ) const

inlinevirtual

◆ MayHaveEngineOperating()

virtual bool wsf::six_dof::Engine::MayHaveEngineOperating ( ) const

inlinevirtual

◆ MayProduceEngineSmoke()

virtual bool wsf::six_dof::Engine::MayProduceEngineSmoke ( ) const

inlinevirtual

◆ MayProduceSmokeTrail()

virtual bool wsf::six_dof::Engine::MayProduceSmokeTrail ( ) const

inlinevirtual

Reimplemented in wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ operator=()

Engine & wsf::six_dof::Engine::operator= ( const Engine & other )

delete

References Engine().

◆ ProcessInput()

virtual bool wsf::six_dof::Engine::ProcessInput	(	UtInput &	aInput,
		TypeManager *	aTypeManager )

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ ProducingSmokeTrail()

bool wsf::six_dof::Engine::ProducingSmokeTrail ( ) const

inline

References mProducingSmokeTrail.

◆ SetFuelTank()

bool wsf::six_dof::Engine::SetFuelTank ( const std::string & aFuelTankName )

virtual

References mCurrentFuelTank, and mParentThrustProducerPtr.

Referenced by GetMinimumPotentialThrust_lbs().

◆ SetParentThrustProducer()

void wsf::six_dof::Engine::SetParentThrustProducer ( ThrustProducerObject * aThrustProducerPtr )

inline

References mParentThrustProducerPtr.

◆ SetThrottlePosition()

virtual void wsf::six_dof::Engine::SetThrottlePosition ( double aThrottleLeverPosition )

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ Shutdown()

virtual void wsf::six_dof::Engine::Shutdown ( int64_t aTerminateTime_nanosec = 0 )

pure virtual

Implemented in wsf::six_dof::JetEngine, wsf::six_dof::RamjetEngine, wsf::six_dof::RocketLiquidPropellantEngine, and wsf::six_dof::RocketSolidPropellantEngine.

◆ UpdateThrust()

void wsf::six_dof::Engine::UpdateThrust	(	double	aDeltaT_sec,
		double	aAlt_ft,
		double	aDynPress_lbsqft,
		double	aStatPress_lbssqft,
		double	aSpeed_fps,
		double	aMach,
		double	aAlpha_rad,
		double	aBeta_rad,
		double &	aForce_lbs,
		double &	aFuelBurnRate_pps,
		double &	aFuelBurned_lbs )

References CalculateThrust().

Referenced by GetMinimumPotentialThrust_lbs().

Member Data Documentation

◆ mAfterburnerOn

bool wsf::six_dof::Engine::mAfterburnerOn = false

protected

Referenced by AfterburnerOn(), wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), and Engine().

◆ mAfterburnerPresent

bool wsf::six_dof::Engine::mAfterburnerPresent = false

protected

Referenced by AfterburnerIsPresent(), wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::JetEngine::DetermineIfAfterburnerIsPresent(), Engine(), and wsf::six_dof::JetEngine::SetThrottlePosition().

◆ mContrailing

bool wsf::six_dof::Engine::mContrailing = false

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Contrailing(), and Engine().

◆ mCurrentFuelTank

FuelTank* wsf::six_dof::Engine::mCurrentFuelTank = nullptr

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), CheckCurrentFuelTank(), wsf::six_dof::RocketLiquidPropellantEngine::DeriveFrom(), wsf::six_dof::RocketSolidPropellantEngine::DeriveFrom(), Engine(), GetFuelTank(), SetFuelTank(), and wsf::six_dof::RocketSolidPropellantEngine::UpdatePropellantMass().

◆ mCurrentThrust_lbs

double wsf::six_dof::Engine::mCurrentThrust_lbs = 0.0

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), and GetThrust_lbs().

◆ mEngineDamageSmokeActivated

bool wsf::six_dof::Engine::mEngineDamageSmokeActivated = false

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), and MakeEngineSmoke().

◆ mEngineOperating

bool wsf::six_dof::Engine::mEngineOperating = false

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), and EngineOperating().

◆ mEngineSmoking

bool wsf::six_dof::Engine::mEngineSmoking = false

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), and EngineSmoking().

◆ mIgniteTimeInFrame_nanosec

int64_t wsf::six_dof::Engine::mIgniteTimeInFrame_nanosec = 0

protected

Referenced by wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), wsf::six_dof::RocketLiquidPropellantEngine::Ignite(), and wsf::six_dof::RocketSolidPropellantEngine::Ignite().

◆ mParentThrustProducerPtr

ThrustProducerObject* wsf::six_dof::Engine::mParentThrustProducerPtr = nullptr

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), CheckCurrentFuelTank(), Engine(), Engine(), GetParentThrustProducer(), SetFuelTank(), and SetParentThrustProducer().

◆ mProducingSmokeTrail

bool wsf::six_dof::Engine::mProducingSmokeTrail = false

protected

Referenced by wsf::six_dof::JetEngine::CalculateThrust(), wsf::six_dof::RamjetEngine::CalculateThrust(), wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), and ProducingSmokeTrail().

◆ mShutdownFraction_nanosec

int64_t wsf::six_dof::Engine::mShutdownFraction_nanosec = 0

protected

Referenced by wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), wsf::six_dof::RocketLiquidPropellantEngine::Shutdown(), and wsf::six_dof::RocketSolidPropellantEngine::Shutdown().

◆ mShutdownInProgress

bool wsf::six_dof::Engine::mShutdownInProgress = false

protected

Referenced by wsf::six_dof::RocketLiquidPropellantEngine::CalculateThrust(), wsf::six_dof::RocketSolidPropellantEngine::CalculateThrust(), Engine(), wsf::six_dof::RocketLiquidPropellantEngine::Shutdown(), and wsf::six_dof::RocketSolidPropellantEngine::Shutdown().

◆ mTypeOfEngine

std::string wsf::six_dof::Engine::mTypeOfEngine

protected

Referenced by DeriveFrom(), Engine(), wsf::six_dof::JetEngine::JetEngine(), wsf::six_dof::RamjetEngine::RamjetEngine(), wsf::six_dof::RocketLiquidPropellantEngine::RocketLiquidPropellantEngine(), and wsf::six_dof::RocketSolidPropellantEngine::RocketSolidPropellantEngine().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ Engine() [1/2]

◆ ~Engine()

◆ Engine() [2/2]

Member Function Documentation

◆ AfterburnerIsPresent()

◆ AfterburnerOn()

◆ CalculateThrust() [1/2]

◆ CalculateThrust() [2/2]

◆ CheckCurrentFuelTank()

◆ Clone()

◆ Contrailing()

◆ DeriveFrom()

◆ EngineOperating()

◆ EngineSmoking()

◆ GetFuelBurnRate_pph()

◆ GetFuelTank()

◆ GetMaximumPotentialThrust_lbs()

◆ GetMinimumPotentialThrust_lbs()

◆ GetParentThrustProducer()

◆ GetThrottlePosition()

◆ GetThrust_lbs()

◆ Ignite()

◆ Initialize()

◆ MakeEngineSmoke()

◆ MayContrail()

◆ MayHaveEngineOperating()

◆ MayProduceEngineSmoke()

◆ MayProduceSmokeTrail()

◆ operator=()

◆ ProcessInput()

◆ ProducingSmokeTrail()

◆ SetFuelTank()

◆ SetParentThrustProducer()

◆ SetThrottlePosition()

◆ Shutdown()

◆ UpdateThrust()

Member Data Documentation

◆ mAfterburnerOn

◆ mAfterburnerPresent

◆ mContrailing

◆ mCurrentFuelTank

◆ mCurrentThrust_lbs

◆ mEngineDamageSmokeActivated

◆ mEngineOperating

◆ mEngineSmoking

◆ mIgniteTimeInFrame_nanosec

◆ mParentThrustProducerPtr

◆ mProducingSmokeTrail

◆ mShutdownFraction_nanosec

◆ mShutdownInProgress

◆ mTypeOfEngine