NetStructureWakeEffect.h

#pragma once
 
#include <limits>
#include "CommonTypes.h"
 
// #define CNetStructureWakeEffect_DO_PROFILE
 
// Includes
#include "NetBottomContactFilter.h"
#include "NetCableElement.h"
#include "NetCableElementSpec.h"
#include "NetElement3NWakeEffect.h"
#include "NetElementDef.h"
#include "NetStructureSpec.h"
 
#include "sfh/timers/ProfilerWallclock.h"
 
#include <fhsim/simobject/SimObject.h>
#include <fhsim_environment/EnvironmentProvider.h>
#include <fhsim_environment/SeafloorForcesInterface.h>
#include <string>
 
 
#ifdef FH_VISUALIZATION
#   include "sfh/ogre/C3DLine.h"
#   include "sfh/ogre/NMeshGenerators.h"
#endif
 
// Class definition
class NetStructureWakeEffect : public SimObject
{
public:
   NetStructureWakeEffect(std::string simObjectName, ISimObjectCreator* creator);
   virtual ~NetStructureWakeEffect();
   virtual void  OdeFcn(const double dT, const double* const adX, double* const adXDot) const;
   virtual void  InitialConditionSetup(const double dT, const double* const adCurrentIC, double* const adUpdatedIC, ISimObjectCreator* const creator);
   virtual void  FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator);
 
   void PreOdeFcn(double T, const double* X, IStateUpdater* updater) override;
   const double* outExternalNodeForce(const double dT, const double* const adX, int extNode);
 
#ifdef FH_VISUALIZATION
   virtual void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator);
   virtual void RenderUpdate(const double dT, const double* const adX);
 
   void     CreateCapsule(Ogre::ManualObject* capsule_manual);
   C3DLine* myline;
#endif
   virtual const double* NodePos(const double dT, const double* const adX, int extNode);
   virtual const double* NodeVel(const double dT, const double* const adX, int extNode);
   virtual const double* BottomContact(const double dT, const double* const adX);
   void                  SetAddedDragPerMPS(double AddedDragPerMPS);
   const double*         GetNetTotalForceForCheck(const double dT, const double* const adX); 
protected:
   virtual void   CalcStateDerivatives(const double* const adX, double* const adXDot) const;
   virtual void   AddExternalForces(const double dT, const double* const adX) const;
   virtual void   AddNetForces(const double dT, const double* const adX) const;
   virtual void   AddCableForces(const double dT, const double* const adX) const;
   virtual double AddNodeBottomForce(const double* const adX, int node, double diam, double adForceInOut[3]) const;
   virtual void   AddBottomForces(const double* const adX) const;
   virtual void   AddInputPorts(ISimObjectCreator* creator);
   virtual void   CreateNetPanels(std::vector<const NetElementDef*> VNetElementDefs, ISimObjectCreator* creator);
   virtual void   CreateNetCables(std::vector<const NetCableElementSpec*> VCableElements, ISimObjectCreator* creator);
   virtual void   CreateDataStructures();
   virtual void   CreateOutputPorts(ISimObjectCreator* creator);
   VSPairStrInt   CreateExternalNodeMap(std::string tag, int* piUsed, NetStructureSpec& NetSpec, ISimObjectCreator* creator);
   void           PRINTALLNODEFORCES(std::string spec, double dT);
 
 
   ISignalPort** m_inExternalForces;
   int*          m_iStatePos;
   int*          m_iStateVel;
   double* m_NodeExternalForces;
 
   int m_numNodesInputForce;
   int m_numNodesOutputPosAndVel;
   int m_numPanelsCalc;
   int m_numCablesCalc;
   int m_numNodesOriginal;
   int m_numNodesCalc;
   int m_numNodeOutputs;
 
 
   NetBottomContactFilter m_BottomContactFilter;
   double                 m_bottomContact[6];
 
   environment::EnvironmentProvider*     m_environment;
   environment::SeafloorForcesInterface* m_seafloor;
 
 
   std::vector<NetCableElement*>        m_VpCableElements;
   std::vector<NetElement3NWakeEffect*> m_VpNetElements;
   float*                               m_inertia;
   int*                                 m_netConn;
   int**                                m_aaiCableConn;
   SAdaptationSpec_t                    m_SAdaptations;
   bool                                 m_foldingPointRefinementUsed;
 
 
 
   VSPairStrInt m_VsNodesOutputPosAndVel;
   VSPairStrInt m_VsNodesInputForce;
   bool         m_useTagForExternalNodes;
 
   double*                        m_nodeForce;
   double m_meanTensionTime = std::numeric_limits<double>::quiet_NaN();
 
   // Screen model
   bool   m_UseScreenModel;
   bool   m_UseMoeFore2021; // Use drag and lift coefficients from model tests published in Moe-F�re et al. 2021.
   double m_SnImg;          // Use solidity derived from image analysis. Only to be used with drag formulation from Moe-F�re et al. 2021.
   double m_RhoWater;
   double m_NetForcesTotalForOutputCheck[3] = {0.0, 0.0, 0.0}; 
 
   // Wake effect inclusion
   bool m_ExternalElementWakeEffectsActive; 
   bool m_InternalElementWakeEffectsActive; 
   bool m_UseActualElementSizeInWakeEffect; 
   int  m_NElementBarsInWakeEffectCalc;     
   bool m_useReynoldsDependentDragCoefficients;
 
#ifdef CNetStructureWakeEffect_DO_PROFILE
   sfh::timers::ProfilerWallclock m_Profiler;
#endif
};