WsfSatelliteBreakupModel.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2019 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 WSFSATELLITEBREAKUPMODEL_HPP
#define WSFSATELLITEBREAKUPMODEL_HPP
 
#include <memory>
#include <string>
 
class UtCalendar;
#include "UtVec3.hpp"
#include "WsfScenario.hpp"
#include "WsfSimulation.hpp"
 
class WsfSatelliteBreakupModel
{
public:
   explicit WsfSatelliteBreakupModel(WsfSimulation& aSimulation)
      : mScenario(aSimulation.GetScenario())
      , mSimulation(aSimulation)
   {
   }
   virtual ~WsfSatelliteBreakupModel() = default;
 
   // Look at the other constructors and assignment operators.
 
   bool HasGenerated() const { return mHasGenerated; }

   virtual size_t GetFragmentCount() const = 0;

   struct Fragment
   {
      double      mLength{0.0};   
      double      mAoverM{0.0};   
      double      mMass{-1.0};    
      double      mArea{0.0};     
      UtVec3d     mLocationECI{}; 
      UtVec3d     mVelocityECI{}; 
      UtVec3d     mDeltaV_ECI{};  
      std::string mName{};        
 
      bool IsInitialized() const { return mMass > 0.0; }
   };

   virtual Fragment GetFragment(size_t aIndex) const = 0;
 
   bool ExplosiveBreakup(double aSimTime, const std::string& aPlatformName, const std::vector<double>& aParams);
 
   bool CollisionalBreakup(double                     aSimTime,
                           const std::string&         aTargetPlatform,
                           const std::vector<double>& aTargetParams,
                           const std::string&         aImpactorPlatform,
                           const std::vector<double>& aImpactorParams);

   const std::string& GetFragmentPlatformType() const { return mFragmentPlatformType; }

   void SetFragmentPlatformType(const std::string& aPlatformType);
 
protected:
   virtual bool ModelExplosion(WsfPlatform& aPlatform, const std::vector<double>& aParams) = 0;

   virtual bool ModelCollision(WsfPlatform&               aTargetPlatform,
                               const std::vector<double>& aTargetParams,
                               WsfPlatform&               aImpactorPlatform,
                               const std::vector<double>& aImpactorParams) = 0;
 
   WsfSimulation& GetSimulation() const { return mSimulation; }
 
private:
   std::unique_ptr<WsfPlatform> GetDefaultFragmentPlatformTemplate() const;
   std::unique_ptr<WsfPlatform> GetFragmentPlatformTemplate() const;
   bool                         AddFragment(std::unique_ptr<WsfPlatform> aPlatformPtr,
                                            const Fragment&              aFragment,
                                            const UtCalendar&            aEpoch,
                                            double                       aSimTime);
   bool                         AddFragmentsToSimulation(double aSimTime);
   void                         RemoveProgenitor(std::string aPlatformName, double aSimTime);
 
   const WsfScenario& mScenario;
   WsfSimulation&     mSimulation;
   std::string        mFragmentPlatformType{};
   bool               mHasGenerated{false};
};
 
#endif // WSFSATELLITEBREAKUPMODEL_HPP