FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
CableBranched.h
1#pragma once
2
217#include "cable/subroutines/InternalCableWithBottomContact.h"
218
219#include "sfh/timers/StopWatch.h"
220
221#include <fhsim/simobject/SimObject.h>
222#include <fhsim_environment/EnvironmentProvider.h>
223#include <fhsim_environment/SeafloorForcesInterface.h>
224#include <string>
225
226#ifdef FH_VISUALIZATION
227# ifdef USE_BILLBOARD_LABELS
228# include "CMovableText.h"
229# endif
230#endif
231
232// Class definition
233class CableBranched : public SimObject
234{
235public:
237 CableBranched(std::string simObjectName, ISimObjectCreator* creator);
238 CableBranched(std::string simObjectName)
239 : SimObject(simObjectName)
240 { }
241 virtual void aFunction(std::string simObjectName, ISimObjectCreator* creator);
244
245 // Member functions
246 virtual void OdeFcn(const double dT, const double* const adX, double* const adXDot) const;
247 bool HasJacobians() const override;
248 void OdeJacobian(double T, const double* X, double* J, int nStates) override;
249 int GetJacobianSparsity(int nStates, int* rowPtr, int* colIdx) override;
250 void FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator);
251 void InitialConditionSetup(const double dT, const double* const adCurrentIC, double* const adUpdatedIC, ISimObjectCreator* const creator);
252#ifdef FH_VISUALIZATION
254 void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator);
255
257 void RenderUpdate(const double dT, const double* const adX);
258#endif
259
260protected:
261 virtual void CreateStates(ISimObjectCreator* creator);
262 void CalcOutput(const double dT, const double* const adX) const;
264 void UpdateSectionLength(int element, double dT, const double* adX) const;
265 void OutputExternalConnForces(double dT, const double* adX);
266 void GetPosAndVelPointer(
267 int node,
268 double dT,
269 const double* const adX,
270 const double** const padPos,
271 const double** const padVel) const;
272
273 const double* GetPosPointer(
274 int node,
275 double dT,
276 const double* const adX) const;
277
278
280 virtual void AddBottomForces(double dT, const double* const adX) const;
281 virtual void CreateDataStructures();
282 virtual void CreateInputports(ISimObjectCreator* creator);
283 virtual void CreateOutputports(ISimObjectCreator* creator);
284
285
287 void CheckNodeNumber(int nodeNumber, std::string nodeDescription, ISimObjectCreator* creator);
288
289 ISignalPort** m_inVel;
290 ISignalPort** m_inPos;
291 ISignalPort** m_inLength;
292 ICommonComputation* m_commonCalc;
293 const double* ExternalForce(const double dT, const double* const adX, int i);
294 const double* ExternalTension(const double dT, const double* const adX, int i);
295 const double* SectionLength(const double dT, const double* const adX, int i);
299 int m_iStateBase = 0;
300
307 int LocalIndex(int globalStateIndex) const { return globalStateIndex - m_iStateBase; }
315
316 // int* m_numAEndsToExt; ///< The number of elements with the A node connected to each external node.
317 // int* m_numBEndsToExt; ///< The number of elements with the B node connected to each external node.
318 // int** m_aaiAEndsToExt; ///< The elements with the A node connected to each external node.
319 // int** m_aaiBEndsToExt; ///< The elements with the B node connected to each external node.
320
321 // int* m_numElementsPerSection;
325 double m_maxStep;
327 double* m_stiffness;
332 double* m_density;
333 double* m_dE;
334 double* m_diameter;
335 double* m_maxTension;
337 // double* m_inertiaA; ///< The inertia of the connected end A of each eleemnt.
338 // double* m_inertiaB; ///< The inertia of the connected end B of each eleemnt.
339 double* m_nodeForce;
340 // double* m_forceA; ///< The force on the A nodes.
341 // double* m_forceB; ///< The force on the B nodes.
342 double* m_lengths;
343 std::string m_materialName;
344 double m_drawScale;
345 double* m_externalTensions;
347
348 const double* m_padVelWater;
349 environment::EnvironmentProvider* m_environment;
350 environment::SeafloorForcesInterface* m_seafloor;
351 // bool m_outputFcnCalled;
352#ifdef FH_VISUALIZATION
353# ifdef USE_BILLBOARD_LABELS
354 Ogre::SceneNode** m_renderNode;
355 Ogre::CMovableText** m_bBTxt;
356 double m_txtSize;
357# endif
358#endif
359};
Definition CableBranched.h:234
double m_drawScale
The scale for which to draw the cable diameter.
Definition CableBranched.h:344
InternalCable ** m_cableSections
An array holding the cable sections.
Definition CableBranched.h:346
int * m_iStateVel
An array of indices to the node velocity states.
Definition CableBranched.h:297
double * m_relaxedLength
The relaxed length of the cable.
Definition CableBranched.h:328
CableBranched(std::string simObjectName, ISimObjectCreator *creator)
The constructor sets the pointer to the output object and the parser object.
int * m_iStatePos
An array of indices to the node position states.
Definition CableBranched.h:296
int m_cableFaces
The number of faces of the cable visuaization.
Definition CableBranched.h:314
int m_numExternalConn
The number of external connections.
Definition CableBranched.h:312
ISignalPort ** m_inPos
The position input ports.
Definition CableBranched.h:290
int m_iStateBase
Global index of this SimObject's first state, set in CreateStates().
Definition CableBranched.h:299
virtual void AddBottomForces(double dT, const double *const adX) const
Adds the bottom forces to the main nodes.
double * m_dE
The stiffness of the cable material.
Definition CableBranched.h:333
double * m_density
The density of the cable material.
Definition CableBranched.h:332
int m_numNodesCalc
The number of nodes of the cable between the cable elements.
Definition CableBranched.h:309
double * m_stiffness
The linear stiffness of the cable.
Definition CableBranched.h:327
int * m_nodeConnections
The nodes connected to each cable section.
Definition CableBranched.h:313
double m_eAdaptationPeriod
The time constant of the adaptation of the mean tension.
Definition CableBranched.h:323
double * m_diameter
The diameter of the cable.
Definition CableBranched.h:334
double m_maxLengthChangeSpeed
The maximum speed of the cable length change.
Definition CableBranched.h:330
double * m_lengths
The lengths of the cable elements.
Definition CableBranched.h:342
~CableBranched()
The destructor deletes dynamically allocated memory.
int LocalIndex(int globalStateIndex) const
Definition CableBranched.h:307
double m_stepSafetyFactor
The safety factor when calculating the Young modulus of the element.
Definition CableBranched.h:322
void UpdateSectionLength(int element, double dT, const double *adX) const
Reads the Length input of a cable section and applies it to the section (MARE-0037).
double m_maxStep
The maximum steplength of the simulation.
Definition CableBranched.h:325
double * m_maxTension
The maximum tension in the cable.
Definition CableBranched.h:335
int m_numCableSections
The number of cable sections in the branched cable, where each section may be comprised of one or mor...
Definition CableBranched.h:310
double * m_dampingRatio
The damping ratio to specify the internal damping.
Definition CableBranched.h:331
double * m_nodeForce
The force on the calculation nodes belonging to this simObject.
Definition CableBranched.h:339
double m_numericalDamping
The numerical damping of the cable.
Definition CableBranched.h:324
int m_numElements
The number of elements to divide the cable into.
Definition CableBranched.h:308
int * m_iStateCable
An array of indices to the cable sections states.
Definition CableBranched.h:298
double * m_meanTension
The mean tension of the cable.
Definition CableBranched.h:326
ISignalPort ** m_inLength
The cable sections length port.
Definition CableBranched.h:291
int m_numNodesGlobal
The number of nodes of the branched cable used for conecting the internal cable sections.
Definition CableBranched.h:311
double * m_nodeInertia
The inertia of the calculation nodes belonging to this simObject.
Definition CableBranched.h:336
ICommonComputation * m_commonCalc
Calculations necessary for more than one output port.
Definition CableBranched.h:292
std::string m_materialName
The material name of the cable;.
Definition CableBranched.h:343
double * m_relaxedLength_d
The desired relaxed length of the cable.
Definition CableBranched.h:329
ISignalPort ** m_inVel
The velocity input port s.
Definition CableBranched.h:289
void CheckNodeNumber(int nodeNumber, std::string nodeDescription, ISimObjectCreator *creator)
Checks to see if a specified nodenumber is ok.
Definition InternalCable.h:188