WsfVariableRateFuel.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
// ****************************************************************************
// Updated by Infoscitex, a DCS Company.
// ****************************************************************************
 
#ifndef WSFVARIABLERATEFUEL_HPP
#define WSFVARIABLERATEFUEL_HPP
 
#include "wsf_export.h"
 
#include <map>
 
#include "TblLookup.hpp"
#include "WsfFuel.hpp"

class WSF_EXPORT WsfVariableRateFuel : public WsfFuel
{
public:
   WsfVariableRateFuel(WsfScenario& aScenario);
   WsfVariableRateFuel& operator=(const WsfVariableRateFuel&) = delete;
   ~WsfVariableRateFuel() override;
 
   WsfFuel* Clone() const override;


   bool Initialize(double aSimTime) override;
   bool ProcessInput(UtInput& aInput) override;
 
   void SetMode(WsfStringId aMode) override;

   enum IndependentVariable
   {
      cSPEED,    
      cALTITUDE, 
      cWEIGHT    
   };

   enum TableType
   {
      cCONSTANT, 
      cONE_D,    
      cTWO_D,    
      cTHREE_D   
   };
 
   struct AltitudeEntry
   {
      double              mAltitude; //<! Altitude independent value
      TblIndVarU<double>  mSpeeds;   //<! Speed independent values
      TblDepVar1<double>  mRates;    //<! the rate table f(altitude, speed)
      TblLookupLU<double> mSpeedLookup;
   };

   typedef std::vector<AltitudeEntry> Altitudes;
 
   class Table
   {
   public:
      Table()
         : mAltitudes()
         , mConstantRateUsed(false)
         , mRateTableUsed(false)
      {
      }
 
      Altitudes mAltitudes;
      bool      mConstantRateUsed; 
      bool      mRateTableUsed;    
   };
 
protected:
   typedef std::map<WsfStringId, Table>  RateTables;
   typedef RateTables::iterator          RateTableIter;
   typedef RateTables::const_iterator    RateTableConstIter;
   typedef std::pair<WsfStringId, Table> RateTablePair;
 
   bool ProcessTablePairInput(UtInput& aInput, RateTablePair& aPair);

   WsfVariableRateFuel(const WsfVariableRateFuel& aSrc);

   double CalcConsumptionRate() override;
   double CalcConsumptionRateAltitudeSpeed(const double aAltitude, const double aSpeed) override;
 
private:
   Table* GetCurrentTable();

   void CreateConstantTable(double aValue, Table& aTable);

   void AddAltitudeEntry(double aAltitude, std::vector<double>& aSpeeds, std::vector<double>& aRates, Table& aTable);
 
   RateTables  mTables;
   WsfStringId mInputMode;
};
 
#endif