WsfAtmosphericDragTerm.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2020 Infoscitex, a DCS 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.
// ****************************************************************************
 
#ifndef WSFATMOSPHERICDRAGTERM_HPP
#define WSFATMOSPHERICDRAGTERM_HPP
 
#include "WsfOrbitalDynamicsTerm.hpp"
 
class UtCalendar;
class UtInput;
#include "wsf_space_export.h"
 
#include "UtVec3.hpp"
#include "WsfAtmosphere.hpp"

class WSF_SPACE_EXPORT WsfAtmosphericDragTerm : public WsfOrbitalDynamicsTerm
{
public:
   WsfAtmosphericDragTerm()                                     = default;
   WsfAtmosphericDragTerm(const WsfAtmosphericDragTerm& aOther) = default;
   ~WsfAtmosphericDragTerm() override                           = default;
 
   bool ProcessInput(UtInput& aInput) override;
 
   WsfAtmosphericDragTerm* Clone() const override { return new WsfAtmosphericDragTerm{*this}; }
 
   const char* GetScriptClassName() const override { return "WsfAtmosphericDragTerm"; }
 
   UtVec3d ComputeAcceleration(double            aMass,
                               const UtCalendar& aTime,
                               const UtVec3d&    aPosition,
                               const UtVec3d&    aVelocity) const override;
 
   bool Initialize(const WsfOrbitalDynamics& aDynamics) override;

   double GetDragCoefficient() const { return mDragCoefficient; }

   void SetDragCoefficient(double aDragCoefficient) { mDragCoefficient = aDragCoefficient; }

   double GetCrossSectionalArea() const { return mCrossSectionalArea; }
 
   // Set the cross sectional area in m^2 used by this term.
   void SetCrossSectionalArea(double aCrossSectionalArea) { mCrossSectionalArea = aCrossSectionalArea; }

   const std::string& GetAtmosphereModelName() const { return mModelName; }

   void SetAtmosphereModelName(const std::string& aModelName) { mModelName = aModelName; }
 
   std::string GetTermType() const override { return cTYPE; }
 
   constexpr static const char* cTYPE{"atmospheric_drag"};
 
private:
   double                        mDragCoefficient{0.0};
   double                        mCrossSectionalArea{0.0};
   std::string                   mModelName{};
   const wsf::space::Atmosphere* mAtmospherePtr{nullptr};
};
 
#endif // WSFATMOSPHERICDRAGTERM_HPP