FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
NetStructureSpec.h
1
9
10#ifndef CNetStructureSpec_H
11#define CNetStructureSpec_H
12
13// Includes
14#include <memory>
15#include <string>
16#include <vector>
17#include "CommonTypes.h"
18#include "NetCableElementSpec.h"
19#include "NetElementDef.h"
20#include <fhsim/InputReader.h>
21#include <fhsim/ISimObjectLogger.h>
22
25{
26 double maxCableTension;
27 double maxStepLength;
28 double meanCableTension;
29 double minCableLength;
30 double stepSafetyFactor;
31 double adaptationPeriod;
32 double massFactor;
33 double maxVelocity;
34};
35
36
37//Class definition
39{
40public:
42 NetStructureSpec(ISimObjectLogger *logger);
46 NetStructureSpec& operator=(const NetStructureSpec&) = delete;
47
48 virtual void FromFile(std::string fileName, std::string filePath);
49 void FromBinaryFile(std::string fileName, std::string filePath);
55 bool FromNetSpec(const std::string& specPath);
60 std::vector<std::string> DefaultNodes(const std::string& parameter) const;
61
62 // The finished mesh, read only: each reader above refines the net before it returns.
63 int CreateExternalNodeMap(std::vector<std::string> VsInputNodes, VSPairStrInt& VsNodes) const;
64 int GetNumNodesCalc() const {return m_numNodesCalc;}
65 int GetNumNodesOriginal() const {return m_numNodesOriginal;}
67 std::vector<const NetElementDef*> GetNetPanels() const;
69 std::vector<const NetCableElementSpec*> GetCableElements() const;
70 SAdaptationSpec_t GetAdaptationSpec() const {return m_SAdaptationSpec;}
71
72 bool GetCatsRefinementMode() const;
73 void PrintInfo() const;
74
75protected:
77 virtual void ReadInput(InputReader& FileReader, ISimObjectLogger* logger);
80 virtual void ReadBinaryInputFile(std::string fileName, std::string filePath, ISimObjectLogger* logger);
81 void FindNodesToDivide(int nodesToDivide[2], double *length, double *lengthFactor);
82 void RefineMesh();
83 void RefineMesh2();
84
85 void CheckNodeNumber(int nodeNumber, ISimObjectLogger *const logger, std::string nodeDescription = "");
86 void CheckNodes(ISimObjectLogger *logger);
87 unsigned short AddCalcNode(int aiNodes[2]);
88 unsigned short DivideCableElement(int CableNum );
89
90 // Calculation variables
95
96 std::vector<std::unique_ptr<NetElementDef>> m_VSPanelData;
97 std::vector<std::unique_ptr<NetCableElementSpec>> m_VCableElements;
98
99 // Variables for controlling the calculation mesh refinement.
106 double m_scale;
107
108 std::string m_netName;
109 VSPairStrInt m_VsNodesAvailable;
110
112
113 std::vector<std::string> m_defaultNodesInputForce;
114 std::vector<std::string> m_defaultNodesOutputPosAndVel;
115
116 static int s_iID;
117 int m_iD;
118 ISimObjectLogger* m_logger;
119};
120
121
122#endif
123
Definition NetStructureSpec.h:39
int m_numNodesCalc
The number of nodes of the net after refinement.
Definition NetStructureSpec.h:94
NetStructureSpec(const NetStructureSpec &)=delete
Owns its panel and cable specifications.
double m_maxSideLengthFactor
The maximum element side length factor.
Definition NetStructureSpec.h:101
int m_numNodesOriginal
The number of original nodes of the net.
Definition NetStructureSpec.h:93
void CheckAndRefine()
Checks the node numbers and refines the mesh of the net just read.
int m_numCablesCalc
The number of elements the cable is divided into.
Definition NetStructureSpec.h:92
VSPairStrInt m_VsNodesAvailable
The tag names and indices of the available external nodes.
Definition NetStructureSpec.h:109
int m_maxNumPanels
The maximum number of net panels used for the calculations.
Definition NetStructureSpec.h:104
virtual void ReadInput(InputReader &FileReader, ISimObjectLogger *logger)
Reads a <Net> document, from a file or from text.
SAdaptationSpec_t m_SAdaptationSpec
A struct containing adaptations for faster integration of the net structure.
Definition NetStructureSpec.h:111
int m_foldingPointRefinement
refinement by folding points on each cable (Cats mode)
Definition NetStructureSpec.h:100
virtual ~NetStructureSpec()
The elements are owned through std::unique_ptr.
int m_maxNumCables
The maximum number of cable elements used for the calculations.
Definition NetStructureSpec.h:105
int m_numPanelsCalc
The number of elements the net is divided into.
Definition NetStructureSpec.h:91
double m_minSideLength
The side length limit for the elements to be further subdivided.
Definition NetStructureSpec.h:102
std::vector< std::string > m_defaultNodesOutputPosAndVel
DefaultNodes("NodesOutputPosAndVel").
Definition NetStructureSpec.h:114
std::vector< const NetCableElementSpec * > GetCableElements() const
The cable elements of the refined mesh, as GetNetPanels.
NetStructureSpec(ISimObjectLogger *logger)
The constructor sets the pointer to the output object and the parser object.
std::vector< std::unique_ptr< NetCableElementSpec > > m_VCableElements
The cable elements read from the input file, then refined.
Definition NetStructureSpec.h:97
std::vector< const NetElementDef * > GetNetPanels() const
The panels of the refined mesh: read-only pointers to the elements the spec owns, valid while it live...
std::vector< std::string > m_defaultNodesInputForce
DefaultNodes("NodesInputForce").
Definition NetStructureSpec.h:113
double m_scale
The scale of the trawl net in relation to the specifications.
Definition NetStructureSpec.h:106
std::vector< std::unique_ptr< NetElementDef > > m_VSPanelData
The panels read from the input file, then refined.
Definition NetStructureSpec.h:96
std::vector< std::string > DefaultNodes(const std::string &parameter) const
bool FromNetSpec(const std::string &specPath)
int m_maxNumNodes
The maximum number of nodes used for net calculations.
Definition NetStructureSpec.h:103
std::string m_netName
The identification name of the net.
Definition NetStructureSpec.h:108
Class containing the specification for a net object.
Definition NetStructureSpec.h:25