FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
Cable.h
1#pragma once
113#include "cable/subroutines/CableElDynStiff.h"
114#include "cable/subroutines/InternalCableWithBottomContact.h"
115
116#include "sfh/timers/Timer.h"
117
118#include <fhsim/simobject/SimObject.h>
119#include <memory>
120#include <mutex>
121#include <string>
122
123// Class definition
124class Cable : public SimObject
125{
126public:
128 Cable(std::string simObjectName, ISimObjectCreator* creator);
129
132
133 // Member functions
134 void OdeFcn(const double dT, const double* const adX, double* const adXDot) const;
136 void PreOdeFcn(double T, const double* X) override;
137 void InitialConditionSetup(const double dT, const double* const adCurrentIC, double* const adUpdatedIC, ISimObjectCreator* const creator);
138 void FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator);
139 void CalcOutput(const double dT, const double* const adX) const;
140
142 bool HasJacobians() const override;
143 void OdeJacobian(double T, const double* X, double* J, int nStates) override;
144 int GetJacobianSparsity(int nStates, int* rowPtr, int* colIdx) override;
145
146 const double* OutForceA(const double dT, const double* const adX);
147 const double* OutForceB(const double dT, const double* const adX);
148 const double* OutPosA(const double dT, const double* const adX);
149 const double* OutPosB(const double dT, const double* const adX);
150
151#ifdef FH_VISUALIZATION
152
154 void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator);
155
157 void RenderUpdate(const double dT, const double* const adX);
158#endif
159protected:
160 void UpdateLength(double newLength, double deltaT);
161
163 void UpdateStiffness(const double* const adForceA, const double* const adForceB);
164
167
168
169 ISignalPort* m_inLength;
170 ISignalPort* m_inVelA;
171 ISignalPort* m_inVelB;
172 ISignalPort* m_inPosA;
173 ISignalPort* m_inPosB;
175 ICommonComputation* m_commonCalc;
178 mutable std::mutex m_cableMutex;
179
180 // Member variables
183
184 double m_inertiaA;
185 double m_inertiaB;
186 mutable double m_forceA[3];
187 mutable double m_forceB[3];
188 double* m_lengths;
189 std::string m_cableName;
190
191 std::unique_ptr<InternalCableWithBottomContact> m_internalCable;
193};
Definition Cable.h:125
double * m_lengths
The lengths of the cable elements.
Definition Cable.h:188
ISignalPort * m_inLength
The cable length input port.
Definition Cable.h:169
ISignalPort * m_inPosB
The position B input port.
Definition Cable.h:173
std::string m_cableName
The identification name of the cable;.
Definition Cable.h:189
void InitialConditionSetup(const double dT, const double *const adCurrentIC, double *const adUpdatedIC, ISimObjectCreator *const creator)
functionality for setting initialconditions based on input port results.
bool HasJacobians() const override
False while an element was in seabed contact at the last OdeFcn (MARE-0391); FhSim then differences t...
double m_inertiaB
The inertia of the end B.
Definition Cable.h:185
int m_IStates
The index to the internal states of the cable.
Definition Cable.h:174
std::mutex m_cableMutex
Definition Cable.h:178
~Cable()
The destructor deletes dynamically allocated memory.
std::unique_ptr< InternalCableWithBottomContact > m_internalCable
The cable calculations; owned (it was never deleted, MARE-0427).
Definition Cable.h:191
void PreOdeFcn(double T, const double *X) override
Applies the Length input and advances the elements' mean tension from the step's start state (MARE-03...
ICommonComputation * m_commonCalc
Definition Cable.h:175
Cable(std::string simObjectName, ISimObjectCreator *creator)
The constructor sets the pointer to the output object and the parser object.
double m_forceB[3]
The force on the end B.
Definition Cable.h:187
int m_numElements
The number of elements to divide the cable into.
Definition Cable.h:181
ISignalPort * m_inVelB
The velocity B input port.
Definition Cable.h:171
void UpdateInertia()
Updates the inertia of the cable according to the changing length.
void UpdateStiffness(const double *const adForceA, const double *const adForceB)
Updates the stiffness of the cable to ensure that this is not too large.
double m_inertiaA
The inertia of the end A.
Definition Cable.h:184
ISignalPort * m_inPosA
The position A input port.
Definition Cable.h:172
int m_numNodes
The number of nodes of the cable.
Definition Cable.h:182
SCableSpec m_CableSpec
The cable specification.
Definition Cable.h:192
double m_forceA[3]
The force on the end A.
Definition Cable.h:186
ISignalPort * m_inVelA
The velocity A input port.
Definition Cable.h:170
Contains some specifications used for simulating cables.
Definition InternalCable.h:63