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

#include <WsfSixDOF_RocketSolidPropellantEngine.hpp>

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

Public Member Functions

 RocketSolidPropellantEngine (ThrustProducerObject *aParentObject)
 ~RocketSolidPropellantEngine () override
RocketSolidPropellantEngine & operator= (const RocketSolidPropellantEngine &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 IgniteNow ()
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

 RocketSolidPropellantEngine (const RocketSolidPropellantEngine &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
double Thrust_lbs (double aBurnTime_Sec, double aAlt_ft, double &aMassFlow_pps)
void UpdatePropellantMass (double aRemainingPropellant_lbs)
bool MayProduceSmokeTrail () const override
Protected Member Functions inherited from wsf::six_dof::Engine
 Engine (const Engine &aSrc)

Protected Attributes

UtCloneablePtr< UtTable::Curve > mThrustSeaLevelVersusTime {nullptr}
UtCloneablePtr< UtTable::Curve > mThrustVacuumVersusTime {nullptr}
UtCloneablePtr< UtTable::Curve > mIspAlt {nullptr}
double mIspSeaLevel = 0.0
double mIspVacuum = 0.0
double mRatedThrust_lbs = 0.0
double mLastThrust_lbs = 0.0
bool mIsBurning = false
double mBurnTime_sec = 0.0
double mCurrentFuelBurnRate_pph = 0.0
bool mGenerateSmokeTrail = true
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

◆ RocketSolidPropellantEngine() [1/2]

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

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

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

◆ ~RocketSolidPropellantEngine()

wsf::six_dof::RocketSolidPropellantEngine::~RocketSolidPropellantEngine ( )
override

◆ RocketSolidPropellantEngine() [2/2]

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

References wsf::six_dof::Engine::Engine(), mBurnTime_sec, mCurrentFuelBurnRate_pph, mGenerateSmokeTrail, mIsBurning, mIspAlt, mIspSeaLevel, mIspVacuum, mLastThrust_lbs, mRatedThrust_lbs, mThrustSeaLevelVersusTime, mThrustVacuumVersusTime, and RocketSolidPropellantEngine().

Member Function Documentation

◆ CalculateThrust()

void wsf::six_dof::RocketSolidPropellantEngine::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, mBurnTime_sec, 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, mGenerateSmokeTrail, wsf::six_dof::Engine::mIgniteTimeInFrame_nanosec, mIsBurning, mLastThrust_lbs, wsf::six_dof::Engine::mParentThrustProducerPtr, wsf::six_dof::Engine::mProducingSmokeTrail, wsf::six_dof::Engine::mShutdownFraction_nanosec, wsf::six_dof::Engine::mShutdownInProgress, Thrust_lbs(), wsf::six_dof::utils::TimeToTime(), UpdatePropellantMass(), and wsf::six_dof::Mover::WithinContrailAltitudeBand().

◆ Clone()

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

Implements wsf::six_dof::Engine.

References RocketSolidPropellantEngine().

Referenced by operator=().

◆ DeriveFrom()

void wsf::six_dof::RocketSolidPropellantEngine::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, mGenerateSmokeTrail, mIsBurning, mIspAlt, mIspSeaLevel, mIspVacuum, mLastThrust_lbs, mRatedThrust_lbs, mThrustSeaLevelVersusTime, mThrustVacuumVersusTime, and RocketSolidPropellantEngine().

Referenced by operator=().

◆ GetFuelBurnRate_pph()

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

Implements wsf::six_dof::Engine.

References mCurrentFuelBurnRate_pph.

◆ GetMaximumPotentialThrust_lbs()

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

◆ GetPercentMaxThrust()

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

References mLastThrust_lbs, and mRatedThrust_lbs.

◆ GetThrottlePosition()

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

Implements wsf::six_dof::Engine.

References mIsBurning.

◆ Ignite()

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

Implements wsf::six_dof::Engine.

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

◆ IgniteNow()

void wsf::six_dof::RocketSolidPropellantEngine::IgniteNow ( )
inline

References mIsBurning.

Referenced by SetThrottlePosition().

◆ Initialize()

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

Implements wsf::six_dof::Engine.

References mIspAlt, mIspSeaLevel, and mIspVacuum.

Referenced by operator=().

◆ MayProduceSmokeTrail()

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

Reimplemented from wsf::six_dof::Engine.

References mGenerateSmokeTrail.

◆ operator=()

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

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

◆ ProcessInput()

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

Implements wsf::six_dof::Engine.

References mGenerateSmokeTrail, mIspAlt, mRatedThrust_lbs, mThrustSeaLevelVersusTime, and mThrustVacuumVersusTime.

Referenced by operator=().

◆ SetThrottlePosition()

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

Implements wsf::six_dof::Engine.

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

◆ Shutdown()

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

Implements wsf::six_dof::Engine.

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

◆ Thrust_lbs()

double wsf::six_dof::RocketSolidPropellantEngine::Thrust_lbs ( double aBurnTime_Sec,
double aAlt_ft,
double & aMassFlow_pps )
protected

References mIspAlt, mIspSeaLevel, mIspVacuum, mThrustSeaLevelVersusTime, and mThrustVacuumVersusTime.

Referenced by CalculateThrust().

◆ UpdatePropellantMass()

void wsf::six_dof::RocketSolidPropellantEngine::UpdatePropellantMass ( double aRemainingPropellant_lbs)
protected

References wsf::six_dof::Engine::mCurrentFuelTank.

Referenced by CalculateThrust().

Member Data Documentation

◆ mBurnTime_sec

double wsf::six_dof::RocketSolidPropellantEngine::mBurnTime_sec = 0.0
protected

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

◆ mCurrentFuelBurnRate_pph

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

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

◆ mGenerateSmokeTrail

bool wsf::six_dof::RocketSolidPropellantEngine::mGenerateSmokeTrail = true
protected

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

◆ mIsBurning

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

Referenced by CalculateThrust(), DeriveFrom(), GetThrottlePosition(), Ignite(), IgniteNow(), RocketSolidPropellantEngine(), and Shutdown().

◆ mIspAlt

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

Referenced by DeriveFrom(), Initialize(), ProcessInput(), RocketSolidPropellantEngine(), and Thrust_lbs().

◆ mIspSeaLevel

double wsf::six_dof::RocketSolidPropellantEngine::mIspSeaLevel = 0.0
protected

Referenced by DeriveFrom(), Initialize(), RocketSolidPropellantEngine(), and Thrust_lbs().

◆ mIspVacuum

double wsf::six_dof::RocketSolidPropellantEngine::mIspVacuum = 0.0
protected

Referenced by DeriveFrom(), Initialize(), RocketSolidPropellantEngine(), and Thrust_lbs().

◆ mLastThrust_lbs

double wsf::six_dof::RocketSolidPropellantEngine::mLastThrust_lbs = 0.0
protected

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

◆ mRatedThrust_lbs

double wsf::six_dof::RocketSolidPropellantEngine::mRatedThrust_lbs = 0.0
protected

Referenced by DeriveFrom(), GetPercentMaxThrust(), ProcessInput(), and RocketSolidPropellantEngine().

◆ mThrustSeaLevelVersusTime

UtCloneablePtr<UtTable::Curve> wsf::six_dof::RocketSolidPropellantEngine::mThrustSeaLevelVersusTime {nullptr}
protected

Referenced by DeriveFrom(), ProcessInput(), RocketSolidPropellantEngine(), and Thrust_lbs().

◆ mThrustVacuumVersusTime

UtCloneablePtr<UtTable::Curve> wsf::six_dof::RocketSolidPropellantEngine::mThrustVacuumVersusTime {nullptr}
protected

Referenced by DeriveFrom(), ProcessInput(), RocketSolidPropellantEngine(), and Thrust_lbs().

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