WsfTabularRateFuel.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 WSFTABULARRATEFUEL_HPP
#define WSFTABULARRATEFUEL_HPP
 
#include "wsf_export.h"
 
#include <map>
 
#include "UtInput.hpp"
class UtInputBlock;
#include "WsfFuel.hpp"
class WsfFuelFlow;
#include "UtAtmosphere.hpp"

class WSF_EXPORT WsfTabularRateFuel : public WsfFuel
{
public:
   enum VarType
   {
      cNO_VARTYPE = 0, 
      cSPEED,          
      cALTITUDE,       
      cMASS,           
      cRATES           
   };

   enum TableType
   {
      cCONSTANT, 
      cONE_D,    
      cTWO_D,    
      cTHREE_D   
   };
 
   struct Array
   {
      Array()
         : Variable(cNO_VARTYPE)
         , ConvFactor(1.0)
         , Values()
      {
      }
 
      VarType             Variable;
      double              ConvFactor;
      std::vector<double> Values;
      void                Check(UtInput& aInput);
   };
 
   struct InputData
   {
      InputData()
         : Mode()
         , Table(cCONSTANT)
         , FirstIV()
         , SecondIV()
         , ThirdIV()
         , Data()
      {
      }
 
      // This structure is used to capture fuel flow table input
      // before the full type is known (constant, 1D, 2D, 3D table).
      WsfStringId Mode;
      TableType   Table;
      Array       FirstIV;
      Array       SecondIV;
      Array       ThirdIV;
      Array       Data;
   };
 
   WsfTabularRateFuel(WsfScenario& aScenario);
   WsfTabularRateFuel& operator=(const WsfTabularRateFuel&) = delete;
   ~WsfTabularRateFuel() override;
 
   WsfFuel* Clone() const override;


   bool Initialize(double aSimTime) override;
   bool ProcessInput(UtInput& aInput) override;
 
   void SetMode(WsfStringId aMode) override;
 
   using RateTableMap = std::map<WsfStringId, WsfFuelFlow*>;

   virtual const RateTableMap& GetRateTableMap() { return mTables; }
 
protected:
   void ProcessTableBlock(UtInputBlock& aInputBlock);
   void ProcessVarBlock(UtInputBlock& aInputBlock, UtInput::ValueType aType, Array& aArray);
   void ProcessMachBlock(UtInputBlock& aInputBlock, Array& aArray);
   using RateTablePair = std::pair<WsfStringId, WsfFuelFlow*>;
   // typedef std::pair<int, WsfFuelFlow*> RateTablePair;
   using RateTableConstIter = RateTableMap::const_iterator;
   using RateTableIter      = RateTableMap::iterator;

   WsfTabularRateFuel(const WsfTabularRateFuel& aSrc);

   double CalcConsumptionRate() override;
   double CalcConsumptionRateAltitudeSpeed(const double aAltitude, const double aSpeed) override;
 
   WsfFuelFlow* GetCurrentTable();
 
private:
   bool         mSpeedInMach;
   RateTableMap mTables;
   UtAtmosphere mAtmosphere;
};
 
#endif