WSF
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
P6DofFuelTank Class Reference

#include <P6DofFuelTank.hpp>

Inheritance diagram for P6DofFuelTank:
Inheritance graph
[legend]
Collaboration diagram for P6DofFuelTank:
Collaboration graph
[legend]

Public Member Functions

 P6DofFuelTank (P6DofScenario *aScenario)
 ~P6DofFuelTank () override
P6DofFuelTank & operator= (const P6DofFuelTank &other)=delete
P6DofFuelTank * Clone () const
bool ProcessInput (UtInput &aInput)
bool Initialize (int64_t aSimTime_nanosec)
void Update (int64_t aSimTime_nanosec)
void SetPropulsionSystem (P6DofPropulsionSystem *aParent)
bool FuelFlowPathIntact (P6DofPropulsionSystem *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 (UtVec3dX &aCgLocation_ft)
void SetEmptyCgLocation_ft (UtVec3dX &aCgLocation_ft)
UtVec3dX GetCurrentCgLocation_ft () const
UtVec3dX GetFullCgLocation_ft () const
UtVec3dX GetEmptyCgLocation_ft () const
void SetMaxFlowRate_pps (double aMaxFlowRate_pps)
const P6DofMassProperties & GetMassProperties () const
void CalculateCurrentMassProperties ()
Public Member Functions inherited from P6DofObject
 P6DofObject (P6DofScenario *aScenario)
virtual ~P6DofObject ()=default
P6DofObject * Clone () const
P6DofScenario * GetScenario () const
std::string GetName () const
void SetName (const std::string &aName)
P6DofVehicle * GetParentVehicle () const
virtual void SetParentVehicle (P6DofVehicle *aParentVehicle)

Protected Member Functions

 P6DofFuelTank (const P6DofFuelTank &aSrc)
UtVec3dX CalcCgLocation_ft (double aFuelQuantity_lbs)
Protected Member Functions inherited from P6DofObject
 P6DofObject (const P6DofObject &aSrc)=default
P6DofObject & operator= (const P6DofObject &other)=default

Protected Attributes

P6DofPropulsionSystem * mPropulsionSystem
double mMaxFlowRate_pps
double mMaxFillRate_pps
double mMaxTransferRate_pps
double mMaxQuantity_lbs
double mCurrentQuantity_lbs
double mCurrentFuelFlow_pps
double mCurrentFillRate_pps
double mCurrentTransferRate_pps
double mTempCurrentFuelFlow_pps
double mTempCurrentFillRate_pps
double mTempCurrentTransferRate_pps
UtVec3dX mCurrentCgLocation_ft
UtVec3dX mFullCgLocation_ft
UtVec3dX mEmptyCgLocation_ft
UtVec3dX mCgEmptyToFullVector
int64_t mLastSimTime_nanosec
P6DofMassProperties mMassProperties
Protected Attributes inherited from P6DofObject
P6DofScenario * mScenario
P6DofVehicle * mParentVehicle
std::string mObjName

Friends

class P6DofPropulsionSystem

Constructor & Destructor Documentation

◆ P6DofFuelTank() [1/2]

P6DofFuelTank::P6DofFuelTank ( P6DofScenario * aScenario)
explicit

References 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, P6DofObject::P6DofObject(), SetEmptyCgLocation_ft(), and SetFullCgLocation_ft().

Referenced by Clone(), operator=(), P6DofFuelTank(), and P6DofPropulsionSystem.

◆ ~P6DofFuelTank()

P6DofFuelTank::~P6DofFuelTank ( )
override

◆ P6DofFuelTank() [2/2]

P6DofFuelTank::P6DofFuelTank ( const P6DofFuelTank & aSrc)
protected

References 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, P6DofFuelTank(), P6DofObject::P6DofObject(), SetEmptyCgLocation_ft(), and SetFullCgLocation_ft().

Member Function Documentation

◆ CalcCgLocation_ft()

UtVec3dX P6DofFuelTank::CalcCgLocation_ft ( double aFuelQuantity_lbs)
protected

References mCgEmptyToFullVector, mEmptyCgLocation_ft, and mMaxQuantity_lbs.

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

◆ CalculateCurrentMassProperties()

void P6DofFuelTank::CalculateCurrentMassProperties ( )

References CalcCgLocation_ft(), mCurrentQuantity_lbs, and mMassProperties.

Referenced by P6DofPropulsionSystem::CalculateCurrentMassProperties(), and Initialize().

◆ CalculateFuelBurn()

bool P6DofFuelTank::CalculateFuelBurn ( double aDeltaT_sec,
double aFuelBurnRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalcCgLocation_ft(), P6DofUtils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, and mMaxFlowRate_pps.

Referenced by UpdateFuelBurn().

◆ CalculateFuelFill()

bool P6DofFuelTank::CalculateFuelFill ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalcCgLocation_ft(), P6DofUtils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxFillRate_pps, and mMaxQuantity_lbs.

Referenced by UpdateFuelFill().

◆ CalculateFuelTransfer()

bool P6DofFuelTank::CalculateFuelTransfer ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalcCgLocation_ft(), P6DofUtils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxQuantity_lbs, and mMaxTransferRate_pps.

Referenced by P6DofPropulsionSystem::Update(), and UpdateFuelTransfer().

◆ Clone()

P6DofFuelTank * P6DofFuelTank::Clone ( ) const

References P6DofFuelTank().

◆ FuelFlowPathIntact()

bool P6DofFuelTank::FuelFlowPathIntact ( P6DofPropulsionSystem * aSystemDrawingFuel)

References P6DofObject::GetName(), P6DofObject::GetParentVehicle(), P6DofVehicle::GetSubobjectByName(), P6DofObject::mParentVehicle, mPropulsionSystem, and P6DofPropulsionSystem.

Referenced by P6DofPropulsionSystem::RemoveInvalidFuelTransfers().

◆ GetCurrentCgLocation_ft()

UtVec3dX P6DofFuelTank::GetCurrentCgLocation_ft ( ) const

References mCurrentCgLocation_ft.

◆ GetCurrentFuelQuantity_lbs()

double P6DofFuelTank::GetCurrentFuelQuantity_lbs ( ) const

References mCurrentQuantity_lbs.

Referenced by WsfP6DOF_Mover::GetFuelInTank(), and P6DofPropulsionSystem::Update().

◆ GetEmptyCgLocation_ft()

UtVec3dX P6DofFuelTank::GetEmptyCgLocation_ft ( ) const

References mEmptyCgLocation_ft.

◆ GetFuelCapacity_lbs()

double P6DofFuelTank::GetFuelCapacity_lbs ( ) const

References mMaxQuantity_lbs.

Referenced by WsfP6DOF_Mover::GetFuelTankCapacity(), P6DofVehicle::SetFuelInTank_lbs(), and P6DofPropulsionSystem::Update().

◆ GetFuelFillRate_pph()

double P6DofFuelTank::GetFuelFillRate_pph ( ) const

References mCurrentFillRate_pps.

◆ GetFuelFillRate_pps()

double P6DofFuelTank::GetFuelFillRate_pps ( ) const

References mCurrentFillRate_pps.

◆ GetFuelFlow_pph()

double P6DofFuelTank::GetFuelFlow_pph ( ) const

References mCurrentFuelFlow_pps.

◆ GetFuelFlow_pps()

double P6DofFuelTank::GetFuelFlow_pps ( ) const

References mCurrentFuelFlow_pps.

◆ GetFuelFraction()

double P6DofFuelTank::GetFuelFraction ( ) const

References mCurrentQuantity_lbs, and mMaxQuantity_lbs.

◆ GetFuelTransferRate_pph()

double P6DofFuelTank::GetFuelTransferRate_pph ( ) const

References mCurrentTransferRate_pps.

◆ GetFuelTransferRate_pps()

double P6DofFuelTank::GetFuelTransferRate_pps ( ) const

References mCurrentTransferRate_pps.

◆ GetFullCgLocation_ft()

UtVec3dX P6DofFuelTank::GetFullCgLocation_ft ( ) const

References mFullCgLocation_ft.

◆ GetMassProperties()

const P6DofMassProperties & P6DofFuelTank::GetMassProperties ( ) const
inline

References mMassProperties.

Referenced by P6DofPropulsionSystem::CalculateCurrentMassProperties().

◆ GetMaxFuelTransferRate_pps()

double P6DofFuelTank::GetMaxFuelTransferRate_pps ( ) const

References mMaxTransferRate_pps.

Referenced by P6DofPropulsionSystem::Update().

◆ GetPercentFull()

double P6DofFuelTank::GetPercentFull ( ) const

References mCurrentQuantity_lbs, and mMaxQuantity_lbs.

◆ Initialize()

bool P6DofFuelTank::Initialize ( int64_t aSimTime_nanosec)

References CalculateCurrentMassProperties(), and mLastSimTime_nanosec.

Referenced by operator=().

◆ operator=()

P6DofFuelTank & P6DofFuelTank::operator= ( const P6DofFuelTank & other)
delete

References Initialize(), P6DofFuelTank(), and ProcessInput().

◆ ProcessInput()

bool P6DofFuelTank::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 P6DofObject::SetName().

Referenced by operator=(), and P6DofPropulsionSystem::ProcessInput().

◆ SetCurrentFuelQuantity()

void P6DofFuelTank::SetCurrentFuelQuantity ( double aFuelQuantity_lbs)

References mCurrentQuantity_lbs.

Referenced by P6DofPropulsionSystem::ModifyFuelQuantity(), and P6DofVehicle::SetFuelInTank_lbs().

◆ SetEmptyCgLocation_ft()

void P6DofFuelTank::SetEmptyCgLocation_ft ( UtVec3dX & aCgLocation_ft)

References mCgEmptyToFullVector, mEmptyCgLocation_ft, and mFullCgLocation_ft.

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

◆ SetFullCgLocation_ft()

void P6DofFuelTank::SetFullCgLocation_ft ( UtVec3dX & aCgLocation_ft)

References mCgEmptyToFullVector, mEmptyCgLocation_ft, and mFullCgLocation_ft.

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

◆ SetMaxFlowRate_pps()

void P6DofFuelTank::SetMaxFlowRate_pps ( double aMaxFlowRate_pps)
inline

References mMaxFlowRate_pps.

◆ SetMaxFuelQuantity()

void P6DofFuelTank::SetMaxFuelQuantity ( double aFuelQuantity_lbs)

References mMaxQuantity_lbs.

◆ SetPropulsionSystem()

void P6DofFuelTank::SetPropulsionSystem ( P6DofPropulsionSystem * aParent)
inline

References mPropulsionSystem, and P6DofPropulsionSystem.

Referenced by P6DofPropulsionSystem::ProcessInput().

◆ Update()

void P6DofFuelTank::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 P6DofFuelTank::UpdateFuelBurn ( double aDeltaT_sec,
double aFuelBurnRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalculateFuelBurn(), P6DofUtils::cEPSILON_SIMTIME_SEC, P6DofObject::GetScenario(), mCurrentCgLocation_ft, mCurrentQuantity_lbs, and mTempCurrentFuelFlow_pps.

◆ UpdateFuelFill()

bool P6DofFuelTank::UpdateFuelFill ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalculateFuelFill(), P6DofUtils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxQuantity_lbs, and mTempCurrentFillRate_pps.

◆ UpdateFuelTransfer()

bool P6DofFuelTank::UpdateFuelTransfer ( double aDeltaT_sec,
double aFuelAddRequest_lbs,
double & aFuelActuallyProvided_lbs,
double & aNewFuelMass_lbs,
UtVec3dX & aCgLocation_ft )

References CalculateFuelTransfer(), P6DofUtils::cEPSILON_SIMTIME_SEC, mCurrentCgLocation_ft, mCurrentQuantity_lbs, mMaxQuantity_lbs, and mTempCurrentTransferRate_pps.

Referenced by P6DofPropulsionSystem::Update().

◆ P6DofPropulsionSystem

friend class P6DofPropulsionSystem
friend

References P6DofFuelTank(), and P6DofPropulsionSystem.

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

Member Data Documentation

◆ mCgEmptyToFullVector

UtVec3dX P6DofFuelTank::mCgEmptyToFullVector
protected

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

◆ mCurrentCgLocation_ft

UtVec3dX P6DofFuelTank::mCurrentCgLocation_ft
protected

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

◆ mCurrentFillRate_pps

double P6DofFuelTank::mCurrentFillRate_pps
protected

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

◆ mCurrentFuelFlow_pps

double P6DofFuelTank::mCurrentFuelFlow_pps
protected

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

◆ mCurrentQuantity_lbs

double P6DofFuelTank::mCurrentQuantity_lbs
protected

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

◆ mCurrentTransferRate_pps

double P6DofFuelTank::mCurrentTransferRate_pps
protected

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

◆ mEmptyCgLocation_ft

UtVec3dX P6DofFuelTank::mEmptyCgLocation_ft
protected

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

◆ mFullCgLocation_ft

UtVec3dX P6DofFuelTank::mFullCgLocation_ft
protected

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

◆ mLastSimTime_nanosec

int64_t P6DofFuelTank::mLastSimTime_nanosec
protected

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

◆ mMassProperties

P6DofMassProperties P6DofFuelTank::mMassProperties
protected

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

◆ mMaxFillRate_pps

double P6DofFuelTank::mMaxFillRate_pps
protected

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

◆ mMaxFlowRate_pps

double P6DofFuelTank::mMaxFlowRate_pps
protected

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

◆ mMaxQuantity_lbs

double P6DofFuelTank::mMaxQuantity_lbs
protected

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

◆ mMaxTransferRate_pps

double P6DofFuelTank::mMaxTransferRate_pps
protected

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

◆ mPropulsionSystem

P6DofPropulsionSystem* P6DofFuelTank::mPropulsionSystem
protected

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

◆ mTempCurrentFillRate_pps

double P6DofFuelTank::mTempCurrentFillRate_pps
protected

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

◆ mTempCurrentFuelFlow_pps

double P6DofFuelTank::mTempCurrentFuelFlow_pps
protected

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

◆ mTempCurrentTransferRate_pps

double P6DofFuelTank::mTempCurrentTransferRate_pps
protected

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

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