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

#include <WsfSixDOF_FuelTank.hpp>

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

Public Member Functions

 FuelTank ()
 ~FuelTank ()
FuelTank & operator= (const FuelTank &other)=delete
FuelTank * Clone () const
bool ProcessInput (UtInput &aInput)
bool Initialize (int64_t aSimTime_nanosec)
void Update (int64_t aSimTime_nanosec)
const MassProperties & GetMassProperties () const
void SetPropulsionSystem (PropulsionSystem *aParent)
bool FuelFlowPathIntact (const PropulsionSystem *aSystemDrawingFuel)
bool CalculateFuelBurn (double aDeltaT_sec, double aFuelBurnRequest_lbs, double &aFuelActuallyProvided_lbs, double &aNewFuelMass_lbs, UtVec3dX &aCgLocation_ft)
bool UpdateFuelBurn (double aDeltaT_sec, double aFuelBurnRequest_lbs, double &aFuelActuallyProvided_lbs, double &aNewFuelMass_lbs, UtVec3dX &aCgLocation_ft)
bool CalculateFuelFill (double aDeltaT_sec, double aFuelAddRequest_lbs, double &aFuelActuallyProvided_lbs, double &aNewFuelMass_lbs, UtVec3dX &aCgLocation_ft)
bool UpdateFuelFill (double aDeltaT_sec, double aFuelAddRequest_lbs, double &aFuelActuallyProvided_lbs, double &aNewFuelMass_lbs, UtVec3dX &aCgLocation_ft)
bool CalculateFuelTransfer (double aDeltaT_sec, double aFuelAddRequest_lbs, double &aFuelActuallyProvided_lbs, double &aNewFuelMass_lbs, UtVec3dX &aCgLocation_ft)
bool UpdateFuelTransfer (double aDeltaT_sec, double aFuelAddRequest_lbs, double &aFuelActuallyProvided_lbs, double &aNewFuelMass_lbs, UtVec3dX &aCgLocation_ft)
void SetMaxFuelQuantity (double aFuelQuantity_lbs)
double GetFuelCapacity_lbs () const
double GetPercentFull () const
void SetCurrentFuelQuantity (double aFuelQuantity_lbs)
double GetCurrentFuelQuantity_lbs () const
double GetFuelFraction () const
double GetFuelFlow_pps () const
double GetFuelFlow_pph () const
double GetFuelFillRate_pps () const
double GetFuelFillRate_pph () const
double GetMaxFuelTransferRate_pps () const
double GetFuelTransferRate_pps () const
double GetFuelTransferRate_pph () const
void SetFullCgLocation_ft (const UtVec3dX &aCgLocation_ft)
void SetEmptyCgLocation_ft (const UtVec3dX &aCgLocation_ft)
UtVec3dX GetCurrentCgLocation_ft () const
UtVec3dX GetFullCgLocation_ft () const
UtVec3dX GetEmptyCgLocation_ft () const
void SetMaxFlowRate_pps (double aMaxFlowRate_pps)
void CalculateCurrentMassProperties ()
Public Member Functions inherited from wsf::six_dof::Object
 Object ()=default
virtual ~Object ()=default
virtual std::string GetName () const
virtual void SetName (const std::string &aName)
virtual Mover * GetParentVehicle () const
virtual void SetParentVehicle (Mover *aParentVehicle)

Protected Member Functions

 FuelTank (const FuelTank &aSrc)
UtVec3dX CalcCgLocation_ft (double aFuelQuantity_lbs)
Protected Member Functions inherited from wsf::six_dof::Object
 Object (const Object &)=default

Protected Attributes

PropulsionSystem * mPropulsionSystem = nullptr
MassProperties mMassProperties
double mMaxFlowRate_pps = 0.0
double mMaxFillRate_pps = 0.0
double mMaxTransferRate_pps = 0.0
double mMaxQuantity_lbs = 0.0
double mCurrentFuelFlow_pps = 0.0
double mCurrentFillRate_pps = 0.0
double mCurrentTransferRate_pps = 0.0
double mCurrentQuantity_lbs = 0.0
double mTempCurrentFuelFlow_pps = 0.0
double mTempCurrentFillRate_pps = 0.0
double mTempCurrentTransferRate_pps = 0.0
UtVec3dX mCurrentCgLocation_ft
UtVec3dX mFullCgLocation_ft
UtVec3dX mEmptyCgLocation_ft
UtVec3dX mCgEmptyToFullVector
int64_t mLastSimTime_nanosec = 0
Protected Attributes inherited from wsf::six_dof::Object
std::string mObjName = ""
Mover * mParentVehicle = nullptr

Friends

class PropulsionSystem

Constructor & Destructor Documentation

◆ FuelTank() [1/2]

wsf::six_dof::FuelTank::FuelTank ( )
explicit

References mEmptyCgLocation_ft, mFullCgLocation_ft, wsf::six_dof::Object::Object(), SetEmptyCgLocation_ft(), and SetFullCgLocation_ft().

Referenced by Clone(), FuelTank(), operator=(), and PropulsionSystem.

◆ ~FuelTank()

wsf::six_dof::FuelTank::~FuelTank ( )

◆ FuelTank() [2/2]

wsf::six_dof::FuelTank::FuelTank ( const FuelTank & aSrc)
explicitprotected

References FuelTank(), mCurrentCgLocation_ft, mCurrentFillRate_pps, mCurrentFuelFlow_pps, mCurrentQuantity_lbs, mCurrentTransferRate_pps, mEmptyCgLocation_ft, mFullCgLocation_ft, mLastSimTime_nanosec, mMassProperties, mMaxFillRate_pps, mMaxFlowRate_pps, mMaxQuantity_lbs, mMaxTransferRate_pps, mPropulsionSystem, mTempCurrentFillRate_pps, mTempCurrentFuelFlow_pps, mTempCurrentTransferRate_pps, wsf::six_dof::Object::Object(), SetEmptyCgLocation_ft(), and SetFullCgLocation_ft().

Member Function Documentation

◆ CalcCgLocation_ft()

UtVec3dX wsf::six_dof::FuelTank::CalcCgLocation_ft ( double aFuelQuantity_lbs)
protected

References mCgEmptyToFullVector, mEmptyCgLocation_ft, and mMaxQuantity_lbs.

Referenced by CalculateCurrentMassProperties(), CalculateFuelBurn(), CalculateFuelFill(), CalculateFuelTransfer(), and ProcessInput().

◆ CalculateCurrentMassProperties()

void wsf::six_dof::FuelTank::CalculateCurrentMassProperties ( )

References CalcCgLocation_ft(), mCurrentQuantity_lbs, and mMassProperties.

Referenced by wsf::six_dof::PropulsionSystem::GetMassProperties(), and Initialize().

◆ CalculateFuelBurn()

bool wsf::six_dof::FuelTank::CalculateFuelBurn ( double aDeltaT_sec,
double aFuelBurnRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalcCgLocation_ft(), wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, and mMaxFlowRate_pps.

Referenced by UpdateFuelBurn().

◆ CalculateFuelFill()

bool wsf::six_dof::FuelTank::CalculateFuelFill ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalcCgLocation_ft(), wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxFillRate_pps, and mMaxQuantity_lbs.

Referenced by UpdateFuelFill().

◆ CalculateFuelTransfer()

bool wsf::six_dof::FuelTank::CalculateFuelTransfer ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalcCgLocation_ft(), wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxQuantity_lbs, and mMaxTransferRate_pps.

Referenced by wsf::six_dof::PropulsionSystem::Update(), and UpdateFuelTransfer().

◆ Clone()

wsf::six_dof::FuelTank * wsf::six_dof::FuelTank::Clone ( ) const

References FuelTank().

Referenced by operator=().

◆ FuelFlowPathIntact()

bool wsf::six_dof::FuelTank::FuelFlowPathIntact ( const PropulsionSystem * aSystemDrawingFuel)

References wsf::six_dof::Mover::GetName(), wsf::six_dof::Object::GetName(), wsf::six_dof::Object::GetParentVehicle(), wsf::six_dof::Mover::GetSubobjectByName(), wsf::six_dof::Object::mParentVehicle, mPropulsionSystem, and PropulsionSystem.

Referenced by wsf::six_dof::PropulsionSystem::RemoveInvalidFuelTransfers().

◆ GetCurrentCgLocation_ft()

UtVec3dX wsf::six_dof::FuelTank::GetCurrentCgLocation_ft ( ) const

References mCurrentCgLocation_ft.

◆ GetCurrentFuelQuantity_lbs()

double wsf::six_dof::FuelTank::GetCurrentFuelQuantity_lbs ( ) const

References mCurrentQuantity_lbs.

Referenced by wsf::six_dof::Mover::GetFuelInTank(), and wsf::six_dof::PropulsionSystem::Update().

◆ GetEmptyCgLocation_ft()

UtVec3dX wsf::six_dof::FuelTank::GetEmptyCgLocation_ft ( ) const

References mEmptyCgLocation_ft.

◆ GetFuelCapacity_lbs()

double wsf::six_dof::FuelTank::GetFuelCapacity_lbs ( ) const

References mMaxQuantity_lbs.

Referenced by wsf::six_dof::Mover::GetFuelTankCapacity(), wsf::six_dof::Mover::SetFuelInTank_lbs(), and wsf::six_dof::PropulsionSystem::Update().

◆ GetFuelFillRate_pph()

double wsf::six_dof::FuelTank::GetFuelFillRate_pph ( ) const

References mCurrentFillRate_pps.

◆ GetFuelFillRate_pps()

double wsf::six_dof::FuelTank::GetFuelFillRate_pps ( ) const

References mCurrentFillRate_pps.

◆ GetFuelFlow_pph()

double wsf::six_dof::FuelTank::GetFuelFlow_pph ( ) const

References mCurrentFuelFlow_pps.

◆ GetFuelFlow_pps()

double wsf::six_dof::FuelTank::GetFuelFlow_pps ( ) const

References mCurrentFuelFlow_pps.

◆ GetFuelFraction()

double wsf::six_dof::FuelTank::GetFuelFraction ( ) const

References mCurrentQuantity_lbs, and mMaxQuantity_lbs.

◆ GetFuelTransferRate_pph()

double wsf::six_dof::FuelTank::GetFuelTransferRate_pph ( ) const

References mCurrentTransferRate_pps.

◆ GetFuelTransferRate_pps()

double wsf::six_dof::FuelTank::GetFuelTransferRate_pps ( ) const

References mCurrentTransferRate_pps.

◆ GetFullCgLocation_ft()

UtVec3dX wsf::six_dof::FuelTank::GetFullCgLocation_ft ( ) const

References mFullCgLocation_ft.

◆ GetMassProperties()

const MassProperties & wsf::six_dof::FuelTank::GetMassProperties ( ) const
inline

References mMassProperties.

Referenced by wsf::six_dof::PropulsionSystem::GetMassProperties().

◆ GetMaxFuelTransferRate_pps()

double wsf::six_dof::FuelTank::GetMaxFuelTransferRate_pps ( ) const

References mMaxTransferRate_pps.

Referenced by wsf::six_dof::PropulsionSystem::Update().

◆ GetPercentFull()

double wsf::six_dof::FuelTank::GetPercentFull ( ) const

References mCurrentQuantity_lbs, and mMaxQuantity_lbs.

◆ Initialize()

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

References CalculateCurrentMassProperties(), and mLastSimTime_nanosec.

Referenced by operator=().

◆ operator=()

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

References Clone(), FuelTank(), Initialize(), and ProcessInput().

◆ ProcessInput()

bool wsf::six_dof::FuelTank::ProcessInput ( UtInput & aInput)

References CalcCgLocation_ft(), mCurrentCgLocation_ft, mCurrentQuantity_lbs, mEmptyCgLocation_ft, mFullCgLocation_ft, mMaxFillRate_pps, mMaxFlowRate_pps, mMaxQuantity_lbs, mMaxTransferRate_pps, SetEmptyCgLocation_ft(), SetFullCgLocation_ft(), and wsf::six_dof::Object::SetName().

Referenced by operator=().

◆ SetCurrentFuelQuantity()

void wsf::six_dof::FuelTank::SetCurrentFuelQuantity ( double aFuelQuantity_lbs)

References mCurrentQuantity_lbs.

Referenced by wsf::six_dof::PropulsionSystem::ModifyFuelQuantity(), and wsf::six_dof::Mover::SetFuelInTank_lbs().

◆ SetEmptyCgLocation_ft()

void wsf::six_dof::FuelTank::SetEmptyCgLocation_ft ( const UtVec3dX & aCgLocation_ft)

References mCgEmptyToFullVector, mEmptyCgLocation_ft, and mFullCgLocation_ft.

Referenced by FuelTank(), FuelTank(), and ProcessInput().

◆ SetFullCgLocation_ft()

void wsf::six_dof::FuelTank::SetFullCgLocation_ft ( const UtVec3dX & aCgLocation_ft)

References mCgEmptyToFullVector, mEmptyCgLocation_ft, and mFullCgLocation_ft.

Referenced by FuelTank(), FuelTank(), and ProcessInput().

◆ SetMaxFlowRate_pps()

void wsf::six_dof::FuelTank::SetMaxFlowRate_pps ( double aMaxFlowRate_pps)
inline

References mMaxFlowRate_pps.

◆ SetMaxFuelQuantity()

void wsf::six_dof::FuelTank::SetMaxFuelQuantity ( double aFuelQuantity_lbs)

References mMaxQuantity_lbs.

◆ SetPropulsionSystem()

void wsf::six_dof::FuelTank::SetPropulsionSystem ( PropulsionSystem * aParent)
inline

References mPropulsionSystem, and PropulsionSystem.

◆ Update()

void wsf::six_dof::FuelTank::Update ( int64_t aSimTime_nanosec)

References mCurrentFillRate_pps, mCurrentFuelFlow_pps, mCurrentQuantity_lbs, mCurrentTransferRate_pps, mLastSimTime_nanosec, mMaxQuantity_lbs, mTempCurrentFillRate_pps, mTempCurrentFuelFlow_pps, and mTempCurrentTransferRate_pps.

◆ UpdateFuelBurn()

bool wsf::six_dof::FuelTank::UpdateFuelBurn ( double aDeltaT_sec,
double aFuelBurnRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalculateFuelBurn(), wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, wsf::six_dof::Object::GetParentVehicle(), mCurrentCgLocation_ft, mCurrentQuantity_lbs, and mTempCurrentFuelFlow_pps.

◆ UpdateFuelFill()

bool wsf::six_dof::FuelTank::UpdateFuelFill ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalculateFuelFill(), wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxQuantity_lbs, and mTempCurrentFillRate_pps.

◆ UpdateFuelTransfer()

bool wsf::six_dof::FuelTank::UpdateFuelTransfer ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalculateFuelTransfer(), wsf::six_dof::utils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxQuantity_lbs, and mTempCurrentTransferRate_pps.

Referenced by wsf::six_dof::PropulsionSystem::Update().

◆ PropulsionSystem

friend class PropulsionSystem
friend

References FuelTank(), and PropulsionSystem.

Referenced by FuelFlowPathIntact(), PropulsionSystem, and SetPropulsionSystem().

Member Data Documentation

◆ mCgEmptyToFullVector

UtVec3dX wsf::six_dof::FuelTank::mCgEmptyToFullVector
protected

Referenced by CalcCgLocation_ft(), SetEmptyCgLocation_ft(), and SetFullCgLocation_ft().

◆ mCurrentCgLocation_ft

UtVec3dX wsf::six_dof::FuelTank::mCurrentCgLocation_ft
protected

Referenced by CalculateFuelBurn(), CalculateFuelFill(), CalculateFuelTransfer(), FuelTank(), GetCurrentCgLocation_ft(), ProcessInput(), UpdateFuelBurn(), UpdateFuelFill(), and UpdateFuelTransfer().

◆ mCurrentFillRate_pps

double wsf::six_dof::FuelTank::mCurrentFillRate_pps = 0.0
protected

Referenced by FuelTank(), GetFuelFillRate_pph(), GetFuelFillRate_pps(), and Update().

◆ mCurrentFuelFlow_pps

double wsf::six_dof::FuelTank::mCurrentFuelFlow_pps = 0.0
protected

Referenced by FuelTank(), GetFuelFlow_pph(), GetFuelFlow_pps(), and Update().

◆ mCurrentQuantity_lbs

double wsf::six_dof::FuelTank::mCurrentQuantity_lbs = 0.0
protected

Referenced by CalculateCurrentMassProperties(), CalculateFuelBurn(), CalculateFuelFill(), CalculateFuelTransfer(), FuelTank(), GetCurrentFuelQuantity_lbs(), GetFuelFraction(), GetPercentFull(), ProcessInput(), SetCurrentFuelQuantity(), Update(), UpdateFuelBurn(), UpdateFuelFill(), and UpdateFuelTransfer().

◆ mCurrentTransferRate_pps

double wsf::six_dof::FuelTank::mCurrentTransferRate_pps = 0.0
protected

Referenced by FuelTank(), GetFuelTransferRate_pph(), GetFuelTransferRate_pps(), and Update().

◆ mEmptyCgLocation_ft

UtVec3dX wsf::six_dof::FuelTank::mEmptyCgLocation_ft
protected

Referenced by CalcCgLocation_ft(), FuelTank(), FuelTank(), GetEmptyCgLocation_ft(), ProcessInput(), SetEmptyCgLocation_ft(), and SetFullCgLocation_ft().

◆ mFullCgLocation_ft

UtVec3dX wsf::six_dof::FuelTank::mFullCgLocation_ft
protected

Referenced by FuelTank(), FuelTank(), GetFullCgLocation_ft(), ProcessInput(), SetEmptyCgLocation_ft(), and SetFullCgLocation_ft().

◆ mLastSimTime_nanosec

int64_t wsf::six_dof::FuelTank::mLastSimTime_nanosec = 0
protected

Referenced by FuelTank(), Initialize(), and Update().

◆ mMassProperties

MassProperties wsf::six_dof::FuelTank::mMassProperties
protected

Referenced by CalculateCurrentMassProperties(), FuelTank(), and GetMassProperties().

◆ mMaxFillRate_pps

double wsf::six_dof::FuelTank::mMaxFillRate_pps = 0.0
protected

Referenced by CalculateFuelFill(), FuelTank(), and ProcessInput().

◆ mMaxFlowRate_pps

double wsf::six_dof::FuelTank::mMaxFlowRate_pps = 0.0
protected

Referenced by CalculateFuelBurn(), FuelTank(), ProcessInput(), and SetMaxFlowRate_pps().

◆ mMaxQuantity_lbs

double wsf::six_dof::FuelTank::mMaxQuantity_lbs = 0.0
protected

Referenced by CalcCgLocation_ft(), CalculateFuelFill(), CalculateFuelTransfer(), FuelTank(), GetFuelCapacity_lbs(), GetFuelFraction(), GetPercentFull(), ProcessInput(), SetMaxFuelQuantity(), Update(), UpdateFuelFill(), and UpdateFuelTransfer().

◆ mMaxTransferRate_pps

double wsf::six_dof::FuelTank::mMaxTransferRate_pps = 0.0
protected

Referenced by CalculateFuelTransfer(), FuelTank(), GetMaxFuelTransferRate_pps(), and ProcessInput().

◆ mPropulsionSystem

PropulsionSystem* wsf::six_dof::FuelTank::mPropulsionSystem = nullptr
protected

Referenced by FuelFlowPathIntact(), FuelTank(), and SetPropulsionSystem().

◆ mTempCurrentFillRate_pps

double wsf::six_dof::FuelTank::mTempCurrentFillRate_pps = 0.0
protected

Referenced by FuelTank(), Update(), and UpdateFuelFill().

◆ mTempCurrentFuelFlow_pps

double wsf::six_dof::FuelTank::mTempCurrentFuelFlow_pps = 0.0
protected

Referenced by FuelTank(), Update(), and UpdateFuelBurn().

◆ mTempCurrentTransferRate_pps

double wsf::six_dof::FuelTank::mTempCurrentTransferRate_pps = 0.0
protected

Referenced by FuelTank(), Update(), and UpdateFuelTransfer().

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