WSF
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
wsf::six_dof::RocketLiquidPropellantEngine Class Reference

#include <WsfSixDOF_RocketLiquidPropellantEngine.hpp>

Inheritance diagram for wsf::six_dof::RocketLiquidPropellantEngine:
Inheritance graph
[legend]
Collaboration diagram for wsf::six_dof::RocketLiquidPropellantEngine:
Collaboration graph
[legend]

Public Member Functions

 RocketLiquidPropellantEngine (ThrustProducerObject *aParentObject)
 ~RocketLiquidPropellantEngine ()
RocketLiquidPropellantEngine & operator= (const RocketLiquidPropellantEngine &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
double GetPercentMaxThrust () const
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
bool AfterburnerOn () const
bool Contrailing () const
bool EngineSmoking () const
void MakeEngineSmoke (bool aSmoking)
virtual bool AfterburnerIsPresent () const

Protected Member Functions

 RocketLiquidPropellantEngine (const RocketLiquidPropellantEngine &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 MayProduceSmokeTrail () const override
Protected Member Functions inherited from wsf::six_dof::Engine
 Engine (const Engine &aSrc)

Protected Attributes

double mThrottleLeverPosition = 0.0
double mLastThrottleLeverPosition = 0.0
UtCloneablePtr< UtTable::Curve > mNormalizedThrustAlt {nullptr}
UtCloneablePtr< UtTable::Curve > mIspAlt {nullptr}
UtCloneablePtr< UtTable::Curve > mThrottleVersusTime {nullptr}
double mMaxThrustSeaLevel = 0.0
double mMaxThrottle = 1.0
double mMinThrottle = 0.0
double mMaxMassFlowSeaLevel = 0.0
double mMaxMassFlowVacuum = 0.0
double mEngineThrustPercent = 0.0
bool mIsBurning = false
double mBurnTime_Sec = 0.0
double mNormalizedSpinUp_per_sec = 0.0
double mNormalizedSpinDown_per_sec = 0.0
double mCurrentFuelBurnRate_pph = 0.0
bool mGenerateSmokeTrail = false
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

◆ RocketLiquidPropellantEngine() [1/2]

wsf::six_dof::RocketLiquidPropellantEngine::RocketLiquidPropellantEngine ( ThrustProducerObject * aParentObject)
explicit

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

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

◆ ~RocketLiquidPropellantEngine()

wsf::six_dof::RocketLiquidPropellantEngine::~RocketLiquidPropellantEngine ( )

◆ RocketLiquidPropellantEngine() [2/2]

wsf::six_dof::RocketLiquidPropellantEngine::RocketLiquidPropellantEngine ( const RocketLiquidPropellantEngine & aSrc)
protected

References wsf::six_dof::Engine::Engine(), mBurnTime_Sec, mEngineThrustPercent, mGenerateSmokeTrail, mIsBurning, mIspAlt, mLastThrottleLeverPosition, mMaxMassFlowSeaLevel, mMaxMassFlowVacuum, mMaxThrottle, mMaxThrustSeaLevel, mMinThrottle, mNormalizedSpinDown_per_sec, mNormalizedSpinUp_per_sec, mNormalizedThrustAlt, mThrottleLeverPosition, mThrottleVersusTime, and RocketLiquidPropellantEngine().

Member Function Documentation

◆ CalculateThrust()

void wsf::six_dof::RocketLiquidPropellantEngine::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 wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, wsf::six_dof::utils::LimitThrottleNormalized(), 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, mEngineThrustPercent, mGenerateSmokeTrail, mIsBurning, mIspAlt, mLastThrottleLeverPosition, mMaxMassFlowSeaLevel, mMaxThrustSeaLevel, mNormalizedSpinDown_per_sec, mNormalizedSpinUp_per_sec, mNormalizedThrustAlt, wsf::six_dof::Engine::mParentThrustProducerPtr, wsf::six_dof::Engine::mProducingSmokeTrail, wsf::six_dof::Engine::mShutdownFraction_nanosec, wsf::six_dof::Engine::mShutdownInProgress, mThrottleLeverPosition, wsf::six_dof::utils::TimeToTime(), and wsf::six_dof::Mover::WithinContrailAltitudeBand().

Referenced by operator=().

◆ Clone()

wsf::six_dof::Engine * wsf::six_dof::RocketLiquidPropellantEngine::Clone ( ) const
overridevirtual

Implements wsf::six_dof::Engine.

References RocketLiquidPropellantEngine().

Referenced by operator=().

◆ DeriveFrom()

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

Reimplemented from wsf::six_dof::Engine.

References wsf::six_dof::Engine::DeriveFrom(), wsf::six_dof::Engine::Engine(), mBurnTime_Sec, mCurrentFuelBurnRate_pph, wsf::six_dof::Engine::mCurrentFuelTank, mEngineThrustPercent, mGenerateSmokeTrail, mIsBurning, mIspAlt, mLastThrottleLeverPosition, mMaxMassFlowSeaLevel, mMaxMassFlowVacuum, mMaxThrottle, mMaxThrustSeaLevel, mMinThrottle, mNormalizedSpinDown_per_sec, mNormalizedSpinUp_per_sec, mNormalizedThrustAlt, mThrottleLeverPosition, mThrottleVersusTime, and RocketLiquidPropellantEngine().

Referenced by operator=().

◆ GetFuelBurnRate_pph()

double wsf::six_dof::RocketLiquidPropellantEngine::GetFuelBurnRate_pph ( ) const
overridevirtual

Implements wsf::six_dof::Engine.

References mCurrentFuelBurnRate_pph.

Referenced by operator=().

◆ GetMaximumPotentialThrust_lbs()

double wsf::six_dof::RocketLiquidPropellantEngine::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 mIspAlt, mMaxMassFlowSeaLevel, and mNormalizedThrustAlt.

Referenced by operator=().

◆ GetMinimumPotentialThrust_lbs()

double wsf::six_dof::RocketLiquidPropellantEngine::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.

Referenced by operator=().

◆ GetPercentMaxThrust()

double wsf::six_dof::RocketLiquidPropellantEngine::GetPercentMaxThrust ( ) const

References mEngineThrustPercent.

Referenced by operator=().

◆ GetThrottlePosition()

double wsf::six_dof::RocketLiquidPropellantEngine::GetThrottlePosition ( ) const
overridevirtual

Implements wsf::six_dof::Engine.

References mThrottleLeverPosition.

Referenced by operator=().

◆ Ignite()

void wsf::six_dof::RocketLiquidPropellantEngine::Ignite ( int64_t aIgniteTimeInFrame_nanosec)
overridevirtual

Implements wsf::six_dof::Engine.

References wsf::six_dof::Engine::mIgniteTimeInFrame_nanosec, mIsBurning, and mThrottleLeverPosition.

Referenced by operator=().

◆ Initialize()

bool wsf::six_dof::RocketLiquidPropellantEngine::Initialize ( int64_t aSimTime_nanosec)
overridevirtual

Implements wsf::six_dof::Engine.

References mIspAlt, mMaxMassFlowSeaLevel, and mMaxThrustSeaLevel.

Referenced by operator=().

◆ MayProduceSmokeTrail()

bool wsf::six_dof::RocketLiquidPropellantEngine::MayProduceSmokeTrail ( ) const
inlineoverrideprotectedvirtual

Reimplemented from wsf::six_dof::Engine.

References mGenerateSmokeTrail.

◆ operator=()

RocketLiquidPropellantEngine & wsf::six_dof::RocketLiquidPropellantEngine::operator= ( const RocketLiquidPropellantEngine & other)
delete

References CalculateThrust(), Clone(), DeriveFrom(), wsf::six_dof::Engine::Engine(), GetFuelBurnRate_pph(), GetMaximumPotentialThrust_lbs(), GetMinimumPotentialThrust_lbs(), GetPercentMaxThrust(), GetThrottlePosition(), Ignite(), Initialize(), ProcessInput(), RocketLiquidPropellantEngine(), SetThrottlePosition(), and Shutdown().

◆ ProcessInput()

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

Implements wsf::six_dof::Engine.

References mGenerateSmokeTrail, mIspAlt, mMaxMassFlowSeaLevel, mMaxThrustSeaLevel, mNormalizedSpinDown_per_sec, mNormalizedSpinUp_per_sec, and mNormalizedThrustAlt.

Referenced by operator=().

◆ SetThrottlePosition()

void wsf::six_dof::RocketLiquidPropellantEngine::SetThrottlePosition ( double aThrottleLeverPosition)
overridevirtual

Implements wsf::six_dof::Engine.

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

Referenced by operator=().

◆ Shutdown()

void wsf::six_dof::RocketLiquidPropellantEngine::Shutdown ( int64_t aTerminateTime_nanosec = 0)
overridevirtual

Implements wsf::six_dof::Engine.

References mIsBurning, wsf::six_dof::Engine::mShutdownFraction_nanosec, wsf::six_dof::Engine::mShutdownInProgress, and mThrottleLeverPosition.

Referenced by operator=().

Member Data Documentation

◆ mBurnTime_Sec

double wsf::six_dof::RocketLiquidPropellantEngine::mBurnTime_Sec = 0.0
protected

Referenced by DeriveFrom(), and RocketLiquidPropellantEngine().

◆ mCurrentFuelBurnRate_pph

double wsf::six_dof::RocketLiquidPropellantEngine::mCurrentFuelBurnRate_pph = 0.0
protected

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

◆ mEngineThrustPercent

double wsf::six_dof::RocketLiquidPropellantEngine::mEngineThrustPercent = 0.0
protected

Referenced by CalculateThrust(), DeriveFrom(), GetPercentMaxThrust(), and RocketLiquidPropellantEngine().

◆ mGenerateSmokeTrail

bool wsf::six_dof::RocketLiquidPropellantEngine::mGenerateSmokeTrail = false
protected

Referenced by CalculateThrust(), DeriveFrom(), MayProduceSmokeTrail(), ProcessInput(), and RocketLiquidPropellantEngine().

◆ mIsBurning

bool wsf::six_dof::RocketLiquidPropellantEngine::mIsBurning = false
protected

Referenced by CalculateThrust(), DeriveFrom(), Ignite(), RocketLiquidPropellantEngine(), and Shutdown().

◆ mIspAlt

UtCloneablePtr<UtTable::Curve> wsf::six_dof::RocketLiquidPropellantEngine::mIspAlt {nullptr}
protected

Referenced by CalculateThrust(), DeriveFrom(), GetMaximumPotentialThrust_lbs(), Initialize(), ProcessInput(), and RocketLiquidPropellantEngine().

◆ mLastThrottleLeverPosition

double wsf::six_dof::RocketLiquidPropellantEngine::mLastThrottleLeverPosition = 0.0
protected

Referenced by CalculateThrust(), DeriveFrom(), and RocketLiquidPropellantEngine().

◆ mMaxMassFlowSeaLevel

double wsf::six_dof::RocketLiquidPropellantEngine::mMaxMassFlowSeaLevel = 0.0
protected

Referenced by CalculateThrust(), DeriveFrom(), GetMaximumPotentialThrust_lbs(), Initialize(), ProcessInput(), and RocketLiquidPropellantEngine().

◆ mMaxMassFlowVacuum

double wsf::six_dof::RocketLiquidPropellantEngine::mMaxMassFlowVacuum = 0.0
protected

Referenced by DeriveFrom(), and RocketLiquidPropellantEngine().

◆ mMaxThrottle

double wsf::six_dof::RocketLiquidPropellantEngine::mMaxThrottle = 1.0
protected

Referenced by DeriveFrom(), RocketLiquidPropellantEngine(), and SetThrottlePosition().

◆ mMaxThrustSeaLevel

double wsf::six_dof::RocketLiquidPropellantEngine::mMaxThrustSeaLevel = 0.0
protected

Referenced by CalculateThrust(), DeriveFrom(), Initialize(), ProcessInput(), and RocketLiquidPropellantEngine().

◆ mMinThrottle

double wsf::six_dof::RocketLiquidPropellantEngine::mMinThrottle = 0.0
protected

Referenced by DeriveFrom(), RocketLiquidPropellantEngine(), and SetThrottlePosition().

◆ mNormalizedSpinDown_per_sec

double wsf::six_dof::RocketLiquidPropellantEngine::mNormalizedSpinDown_per_sec = 0.0
protected

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

◆ mNormalizedSpinUp_per_sec

double wsf::six_dof::RocketLiquidPropellantEngine::mNormalizedSpinUp_per_sec = 0.0
protected

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

◆ mNormalizedThrustAlt

UtCloneablePtr<UtTable::Curve> wsf::six_dof::RocketLiquidPropellantEngine::mNormalizedThrustAlt {nullptr}
protected

Referenced by CalculateThrust(), DeriveFrom(), GetMaximumPotentialThrust_lbs(), ProcessInput(), and RocketLiquidPropellantEngine().

◆ mThrottleLeverPosition

double wsf::six_dof::RocketLiquidPropellantEngine::mThrottleLeverPosition = 0.0
protected

Referenced by CalculateThrust(), DeriveFrom(), GetThrottlePosition(), Ignite(), RocketLiquidPropellantEngine(), SetThrottlePosition(), and Shutdown().

◆ mThrottleVersusTime

UtCloneablePtr<UtTable::Curve> wsf::six_dof::RocketLiquidPropellantEngine::mThrottleVersusTime {nullptr}
protected

Referenced by DeriveFrom(), and RocketLiquidPropellantEngine().

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved