FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
CableBranched.h
1#pragma once
2
227#include "cable/subroutines/InternalCableWithBottomContact.h"
228
229#include "sfh/timers/StopWatch.h"
230
231#include <fhsim/simobject/SimObject.h>
232#include <fhsim_environment/EnvironmentProvider.h>
233#include <fhsim_environment/SeafloorForcesInterface.h>
234#include <functional>
235#include <memory>
236#include <mutex>
237#include <string>
238
239#ifdef FH_VISUALIZATION
240# ifdef USE_BILLBOARD_LABELS
241# include "CMovableText.h"
242# endif
243#endif
244
245// Class definition
246class CableBranched : public SimObject
247{
248public:
252 using SectionFactory = std::function<std::unique_ptr<InternalCable>(ISimObjectCreator* creator, const SCableSpec& spec)>;
253
255 CableBranched(std::string simObjectName, ISimObjectCreator* creator);
258
259 // Member functions
260 virtual void OdeFcn(const double dT, const double* const adX, double* const adXDot) const;
262 void PreOdeFcn(double T, const double* X) override;
263 bool HasJacobians() const override;
265 void OdeJacobian(double T, const double* X, double* J, int nStates) override;
266 int GetJacobianSparsity(int nStates, int* rowPtr, int* colIdx) override;
267 void FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator);
268 void InitialConditionSetup(const double dT, const double* const adCurrentIC, double* const adUpdatedIC, ISimObjectCreator* const creator);
269#ifdef FH_VISUALIZATION
271 void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator);
272
274 void RenderUpdate(const double dT, const double* const adX);
275#endif
276
277protected:
279 CableBranched(std::string simObjectName, ISimObjectCreator* creator, const SectionFactory& makeSection);
280
287 virtual void AddJunctionNodeForce(const double /*pos*/[3], const double /*vel*/[3], double /*force*/[3]) const { }
288
292
293 void CreateStates(ISimObjectCreator* creator);
294 void CalcOutput(const double dT, const double* const adX) const;
296 void UpdateSectionLength(int element, double dT, const double* adX) const;
301 virtual void PrepareSections(double /*dT*/, const double* /*adX*/) const { }
302 void OutputExternalConnForces(double dT, const double* adX);
303 void GetPosAndVelPointer(
304 int node,
305 double dT,
306 const double* const adX,
307 const double** const padPos,
308 const double** const padVel) const;
309
310 const double* GetPosPointer(
311 int node,
312 double dT,
313 const double* const adX) const;
314
315
317 virtual void AddBottomForces(double dT, const double* const adX) const;
318 virtual void CreateDataStructures();
319 virtual void CreateInputports(ISimObjectCreator* creator);
320 virtual void CreateOutputports(ISimObjectCreator* creator);
321
322
324 void CheckNodeNumber(int nodeNumber, std::string nodeDescription, ISimObjectCreator* creator);
325
326 ISignalPort** m_inVel;
327 ISignalPort** m_inPos;
328 ISignalPort** m_inLength;
329 ICommonComputation* m_commonCalc;
330 const double* ExternalForce(const double dT, const double* const adX, int i);
331 const double* ExternalTension(const double dT, const double* const adX, int i);
332 const double* SectionLength(const double dT, const double* const adX, int i);
336 int m_iStateBase = 0;
337 mutable bool m_forceOutsideJacobian = false;
338
346
347 // int* m_numAEndsToExt; ///< The number of elements with the A node connected to each external node.
348 // int* m_numBEndsToExt; ///< The number of elements with the B node connected to each external node.
349 // int** m_aaiAEndsToExt; ///< The elements with the A node connected to each external node.
350 // int** m_aaiBEndsToExt; ///< The elements with the B node connected to each external node.
351
352 // int* m_numElementsPerSection;
356 double m_maxStep;
358 double* m_stiffness;
364 double* m_density;
365 double* m_dE;
366 double* m_diameter;
367 double* m_maxTension;
369 // double* m_inertiaA; ///< The inertia of the connected end A of each eleemnt.
370 // double* m_inertiaB; ///< The inertia of the connected end B of each eleemnt.
371 double* m_nodeForce;
372 double* m_outNodeForce = nullptr;
373 double* m_outNodeInertia = nullptr;
374
378 mutable std::mutex m_sectionMutex;
379 // double* m_forceA; ///< The force on the A nodes.
380 // double* m_forceB; ///< The force on the B nodes.
381 double* m_lengths;
382 double* m_outLengths = nullptr;
383 std::string m_materialName;
384 double m_drawScale;
385 double* m_externalTensions;
387
388 const double* m_padVelWater;
389 environment::EnvironmentProvider* m_environment;
390 environment::SeafloorForcesInterface* m_seafloor;
391 // bool m_outputFcnCalled;
392#ifdef FH_VISUALIZATION
393# ifdef USE_BILLBOARD_LABELS
394 Ogre::SceneNode** m_renderNode;
395 Ogre::CMovableText** m_bBTxt;
396 double m_txtSize;
397# endif
398#endif
399private:
402 void ReadFile(ISimObjectCreator* creator, const SectionFactory& makeSection);
403};
Definition CableBranched.h:247
virtual void PrepareSections(double, const double *) const
Definition CableBranched.h:301
double m_drawScale
The scale for which to draw the cable diameter.
Definition CableBranched.h:384
InternalCable ** m_cableSections
An array holding the cable sections.
Definition CableBranched.h:386
int * m_iStateVel
An array of indices to the node velocity states.
Definition CableBranched.h:334
CableBranched(std::string simObjectName, ISimObjectCreator *creator, const SectionFactory &makeSection)
A subclass's sections: reads the file as Cable/Branched does and makes each section with makeSection.
double * m_relaxedLength
The relaxed length of the cable.
Definition CableBranched.h:359
CableBranched(std::string simObjectName, ISimObjectCreator *creator)
Cable/Branched: reads the file and makes every section an InternalCableWithBottomContact.
int * m_iStatePos
An array of indices to the node position states.
Definition CableBranched.h:333
int m_cableFaces
The number of faces of the cable visuaization.
Definition CableBranched.h:345
double m_bottomContactDiameter
BottomContactDiameter of the General section: the sphere of each main node in the seabed contact [m].
Definition CableBranched.h:362
void PreOdeFcn(double T, const double *X) override
Applies the Length inputs and advances the sections' mean tension from the step's start state (MARE-0...
int m_numExternalConn
The number of external connections.
Definition CableBranched.h:343
void OdeJacobian(double T, const double *X, double *J, int nStates) override
Writes nothing while HasJacobians() is false (FhSim's Jacobian checker, E12-Q3).
ISignalPort ** m_inPos
The position input ports.
Definition CableBranched.h:327
int m_iStateBase
Global index of this SimObject's first state, set in CreateStates().
Definition CableBranched.h:336
virtual void AddBottomForces(double dT, const double *const adX) const
Adds the bottom forces to the main nodes, and marks the state (MarkForceOutsideJacobian) if any of th...
double * m_dE
The stiffness of the cable material.
Definition CableBranched.h:365
double * m_density
The density of the cable material.
Definition CableBranched.h:364
int m_numNodesCalc
The number of nodes of the cable between the cable elements.
Definition CableBranched.h:340
double * m_stiffness
The linear stiffness of the cable.
Definition CableBranched.h:358
int * m_nodeConnections
The nodes connected to each cable section.
Definition CableBranched.h:344
double m_eAdaptationPeriod
The time constant of the adaptation of the mean tension.
Definition CableBranched.h:354
double * m_diameter
The diameter of the cable.
Definition CableBranched.h:366
double m_maxLengthChangeSpeed
The maximum speed of the cable length change.
Definition CableBranched.h:361
std::function< std::unique_ptr< InternalCable >(ISimObjectCreator *creator, const SCableSpec &spec)> SectionFactory
Definition CableBranched.h:252
double * m_lengths
The lengths of the cable elements.
Definition CableBranched.h:381
double * m_outLengths
As m_lengths, as CalcOutput found it for the Length ports.
Definition CableBranched.h:382
~CableBranched()
The destructor deletes dynamically allocated memory.
double m_stepSafetyFactor
The safety factor when calculating the Young modulus of the element.
Definition CableBranched.h:353
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).
std::mutex m_sectionMutex
Definition CableBranched.h:378
double m_maxStep
The maximum steplength of the simulation.
Definition CableBranched.h:356
double * m_maxTension
The maximum tension in the cable.
Definition CableBranched.h:367
bool m_forceOutsideJacobian
Whether the last OdeFcn state had a force OdeJacobian does not model: bottom contact (FISH-0086) or a...
Definition CableBranched.h:337
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:341
double * m_dampingRatio
The damping ratio to specify the internal damping.
Definition CableBranched.h:363
virtual void AddJunctionNodeForce(const double[3], const double[3], double[3]) const
Definition CableBranched.h:287
double * m_nodeForce
The force on the calculation nodes belonging to this simObject, as OdeFcn found it.
Definition CableBranched.h:371
double m_numericalDamping
The numerical damping of the cable.
Definition CableBranched.h:355
double * m_outNodeForce
As m_nodeForce, as CalcOutput found it for the Force and Tension ports.
Definition CableBranched.h:372
int m_numElements
The number of elements to divide the cable into.
Definition CableBranched.h:339
int * m_iStateCable
An array of indices to the cable sections states.
Definition CableBranched.h:335
double * m_meanTension
The mean tension of the cable.
Definition CableBranched.h:357
ISignalPort ** m_inLength
The cable sections length port.
Definition CableBranched.h:328
double * m_outNodeInertia
As m_nodeInertia, as CalcOutput found it.
Definition CableBranched.h:373
int m_numNodesGlobal
The number of nodes of the branched cable used for conecting the internal cable sections.
Definition CableBranched.h:342
double * m_nodeInertia
The inertia of the calculation nodes belonging to this simObject.
Definition CableBranched.h:368
ICommonComputation * m_commonCalc
Calculations necessary for more than one output port.
Definition CableBranched.h:329
std::string m_materialName
The material name of the cable;.
Definition CableBranched.h:383
double * m_relaxedLength_d
The desired relaxed length of the cable.
Definition CableBranched.h:360
ISignalPort ** m_inVel
The velocity input port s.
Definition CableBranched.h:326
void MarkForceOutsideJacobian() const
Definition CableBranched.h:291
void CheckNodeNumber(int nodeNumber, std::string nodeDescription, ISimObjectCreator *creator)
Checks to see if a specified nodenumber is ok.
Definition InternalCable.h:218
Contains some specifications used for simulating cables.
Definition InternalCable.h:63