wsf::six_dof::RamjetEngine Class Reference

#include <WsfSixDOF_RamjetEngine.hpp>

Inheritance diagram for wsf::six_dof::RamjetEngine:

Collaboration diagram for wsf::six_dof::RamjetEngine:

Public Member Functions
	RamjetEngine (ThrustProducerObject *aParentObject)
	~RamjetEngine ()=default
RamjetEngine &	operator= (const RamjetEngine &other)=delete
bool	ProcessInput (UtInput &aInput, TypeManager *aTypeManager) override
bool	Initialize (int64_t aSimTime_nanosec) override
Engine *	Clone () const override
void	DeriveFrom (const Engine *aSrc) override
void	InjectFuel (bool aInjectFuel)
double	GetFuelBurnRate_pph () const override
double	GetMaximumPotentialThrust_lbs (double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad) override
double	GetMinimumPotentialThrust_lbs (double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad) override
void	SetThrottlePosition (double aThrottleLeverPosition) override
double	GetThrottlePosition () const override
void	Ignite (int64_t aIgniteTimeInFrame_nanosec) override
void	Shutdown (int64_t aTerminateTime_nanosec=0) override
Public Member Functions inherited from wsf::six_dof::Engine
	Engine (ThrustProducerObject *aParentObject)
virtual	~Engine ()=default
Engine &	operator= (const Engine &other)=delete
ThrustProducerObject *	GetParentThrustProducer ()
void	SetParentThrustProducer (ThrustProducerObject *aThrustProducerPtr)
double	GetThrust_lbs () const
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
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
	RamjetEngine (const RamjetEngine &aSrc)
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 &aForceAndMoment, double &aFuelBurnRate_pps, double &aFuelBurned_lbs, bool aUpdateData) override
bool	CalcThrustMultiplier (bool aDeadEngine, double &aFuelBurnRequest_lbs, double &aThrust_lbs)
Protected Member Functions inherited from wsf::six_dof::Engine
	Engine (const Engine &aSrc)

Protected Attributes
UtCloneablePtr< UtTable::Table >	mThrustAltMachTable_lbs {nullptr}
UtCloneablePtr< UtTable::Table >	mTsfcAltMachTable_pph {nullptr}
double	mCurrentFuelBurnRate_pph = 0.0
bool	mAfterburnerAppearanceWhenOperating = false
bool	mInjectFuel = false
bool	mLatchFuelInjection = false
bool	mInjectFuelTriggered = false
bool	mUseProportionalThrottle = false
double	mMinProportionalThrust = 0.0
double	mThrottleLeverPosition = 0.0
double	mOverallThrustMultiplier = 0.0
Protected Attributes inherited from wsf::six_dof::Engine
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

RamjetEngine() [1/2]

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

explicit

References wsf::six_dof::Engine::Engine(), and wsf::six_dof::Engine::mTypeOfEngine.

Referenced by Clone(), DeriveFrom(), operator=(), and RamjetEngine().

~RamjetEngine()

wsf::six_dof::RamjetEngine::~RamjetEngine ( )

default

RamjetEngine() [2/2]

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

protected

References wsf::six_dof::Engine::Engine(), mAfterburnerAppearanceWhenOperating, mCurrentFuelBurnRate_pph, mInjectFuelTriggered, mLatchFuelInjection, mMinProportionalThrust, mOverallThrustMultiplier, mThrottleLeverPosition, mThrustAltMachTable_lbs, mTsfcAltMachTable_pph, mUseProportionalThrottle, and RamjetEngine().

Member Function Documentation

CalcThrustMultiplier()

bool wsf::six_dof::RamjetEngine::CalcThrustMultiplier ( bool aDeadEngine, double & aFuelBurnRequest_lbs, double & aThrust_lbs )

protected

References wsf::six_dof::utils::LimitThrottleNormalized(), mInjectFuel, mInjectFuelTriggered, mLatchFuelInjection, mMinProportionalThrust, mOverallThrustMultiplier, mThrottleLeverPosition, and mUseProportionalThrottle.

Referenced by CalculateThrust().

CalculateThrust()

void wsf::six_dof::RamjetEngine::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 & aForceAndMoment, double & aFuelBurnRate_pps, double & aFuelBurned_lbs, bool aUpdateData )

overrideprotectedvirtual

Implements wsf::six_dof::Engine.

References CalcThrustMultiplier(), wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, mAfterburnerAppearanceWhenOperating, wsf::six_dof::Engine::mAfterburnerOn, wsf::six_dof::Engine::mContrailing, mCurrentFuelBurnRate_pph, wsf::six_dof::Engine::mCurrentFuelTank, wsf::six_dof::Engine::mCurrentThrust_lbs, wsf::six_dof::Engine::mEngineDamageSmokeActivated, wsf::six_dof::Engine::mEngineOperating, wsf::six_dof::Engine::mEngineSmoking, wsf::six_dof::Engine::mParentThrustProducerPtr, wsf::six_dof::Engine::mProducingSmokeTrail, mThrustAltMachTable_lbs, mTsfcAltMachTable_pph, and wsf::six_dof::Mover::WithinContrailAltitudeBand().

Clone()

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

overridevirtual

Implements wsf::six_dof::Engine.

References RamjetEngine().

Referenced by operator=().

DeriveFrom()

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

overridevirtual

Reimplemented from wsf::six_dof::Engine.

References wsf::six_dof::Engine::DeriveFrom(), wsf::six_dof::Engine::Engine(), mAfterburnerAppearanceWhenOperating, mCurrentFuelBurnRate_pph, mInjectFuelTriggered, mLatchFuelInjection, mMinProportionalThrust, mOverallThrustMultiplier, mThrottleLeverPosition, mThrustAltMachTable_lbs, mTsfcAltMachTable_pph, mUseProportionalThrottle, and RamjetEngine().

Referenced by operator=().

GetFuelBurnRate_pph()

double wsf::six_dof::RamjetEngine::GetFuelBurnRate_pph ( ) const

overridevirtual

Implements wsf::six_dof::Engine.

References mCurrentFuelBurnRate_pph.

GetMaximumPotentialThrust_lbs()

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

overridevirtual

Implements wsf::six_dof::Engine.

References wsf::six_dof::Engine::CalculateThrust().

GetMinimumPotentialThrust_lbs()

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

overridevirtual

Implements wsf::six_dof::Engine.

References wsf::six_dof::Engine::CalculateThrust().

GetThrottlePosition()

double wsf::six_dof::RamjetEngine::GetThrottlePosition ( ) const

overridevirtual

Implements wsf::six_dof::Engine.

References mThrottleLeverPosition.

Ignite()

void wsf::six_dof::RamjetEngine::Ignite ( int64_t aIgniteTimeInFrame_nanosec )

overridevirtual

Implements wsf::six_dof::Engine.

References mInjectFuel, and mThrottleLeverPosition.

Initialize()

bool wsf::six_dof::RamjetEngine::Initialize ( int64_t aSimTime_nanosec )

overridevirtual

Implements wsf::six_dof::Engine.

Referenced by operator=().

InjectFuel()

void wsf::six_dof::RamjetEngine::InjectFuel ( bool aInjectFuel )

inline

References mInjectFuel.

operator=()

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

delete

References Clone(), DeriveFrom(), wsf::six_dof::Engine::Engine(), Initialize(), ProcessInput(), and RamjetEngine().

ProcessInput()

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

overridevirtual

Implements wsf::six_dof::Engine.

References mAfterburnerAppearanceWhenOperating, mLatchFuelInjection, mMinProportionalThrust, mThrustAltMachTable_lbs, mTsfcAltMachTable_pph, and mUseProportionalThrottle.

Referenced by operator=().

SetThrottlePosition()

void wsf::six_dof::RamjetEngine::SetThrottlePosition ( double aThrottleLeverPosition )

overridevirtual

Implements wsf::six_dof::Engine.

References wsf::six_dof::utils::LimitThrottleNormalized(), and mThrottleLeverPosition.

Shutdown()

void wsf::six_dof::RamjetEngine::Shutdown ( int64_t aTerminateTime_nanosec = 0 )

overridevirtual

Implements wsf::six_dof::Engine.

References mInjectFuel, and mThrottleLeverPosition.

Member Data Documentation

mAfterburnerAppearanceWhenOperating

bool wsf::six_dof::RamjetEngine::mAfterburnerAppearanceWhenOperating = false

protected

Referenced by CalculateThrust(), DeriveFrom(), ProcessInput(), and RamjetEngine().

mCurrentFuelBurnRate_pph

double wsf::six_dof::RamjetEngine::mCurrentFuelBurnRate_pph = 0.0

protected

Referenced by CalculateThrust(), DeriveFrom(), GetFuelBurnRate_pph(), and RamjetEngine().

mInjectFuel

bool wsf::six_dof::RamjetEngine::mInjectFuel = false

protected

Referenced by CalcThrustMultiplier(), Ignite(), InjectFuel(), and Shutdown().

mInjectFuelTriggered

bool wsf::six_dof::RamjetEngine::mInjectFuelTriggered = false

protected

Referenced by CalcThrustMultiplier(), DeriveFrom(), and RamjetEngine().

mLatchFuelInjection

bool wsf::six_dof::RamjetEngine::mLatchFuelInjection = false

protected

Referenced by CalcThrustMultiplier(), DeriveFrom(), ProcessInput(), and RamjetEngine().

mMinProportionalThrust

double wsf::six_dof::RamjetEngine::mMinProportionalThrust = 0.0

protected

Referenced by CalcThrustMultiplier(), DeriveFrom(), ProcessInput(), and RamjetEngine().

mOverallThrustMultiplier

double wsf::six_dof::RamjetEngine::mOverallThrustMultiplier = 0.0

protected

Referenced by CalcThrustMultiplier(), DeriveFrom(), and RamjetEngine().

mThrottleLeverPosition

double wsf::six_dof::RamjetEngine::mThrottleLeverPosition = 0.0

protected

Referenced by CalcThrustMultiplier(), DeriveFrom(), GetThrottlePosition(), Ignite(), RamjetEngine(), SetThrottlePosition(), and Shutdown().

mThrustAltMachTable_lbs

UtCloneablePtr<UtTable::Table> wsf::six_dof::RamjetEngine::mThrustAltMachTable_lbs {nullptr}

protected

Referenced by CalculateThrust(), DeriveFrom(), ProcessInput(), and RamjetEngine().

mTsfcAltMachTable_pph

UtCloneablePtr<UtTable::Table> wsf::six_dof::RamjetEngine::mTsfcAltMachTable_pph {nullptr}

protected

Referenced by CalculateThrust(), DeriveFrom(), ProcessInput(), and RamjetEngine().

mUseProportionalThrottle

bool wsf::six_dof::RamjetEngine::mUseProportionalThrottle = false

protected

Referenced by CalcThrustMultiplier(), DeriveFrom(), ProcessInput(), and RamjetEngine().

---

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

• WsfSixDOF_RamjetEngine.hpp
• WsfSixDOF_RamjetEngine.cpp