FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
Cable.h
1#pragma once
112#include "cable/subroutines/CableElDynStiff.h"
113#include "cable/subroutines/InternalCableWithBottomContact.h"
114
115#include "sfh/timers/Timer.h"
116
117#include <fhsim/simobject/SimObject.h>
118#include <string>
119
120// Class definition
121class Cable : public SimObject
122{
123public:
125 Cable(std::string simObjectName, ISimObjectCreator* creator);
126
129
130 // Member functions
131 void OdeFcn(const double dT, const double* const adX, double* const adXDot) const;
132 void InitialConditionSetup(const double dT, const double* const adCurrentIC, double* const adUpdatedIC, ISimObjectCreator* const creator);
133 void FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator);
134 void CalcOutput(const double dT, const double* const adX) const;
135
136 bool HasJacobians() const override;
137 void OdeJacobian(double T, const double* X, double* J, int nStates) override;
138 int GetJacobianSparsity(int nStates, int* rowPtr, int* colIdx) override;
139
140 const double* OutForceA(const double dT, const double* const adX);
141 const double* OutForceB(const double dT, const double* const adX);
142 const double* OutPosA(const double dT, const double* const adX);
143 const double* OutPosB(const double dT, const double* const adX);
144
145#ifdef FH_VISUALIZATION
146
148 void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator);
149
151 void RenderUpdate(const double dT, const double* const adX);
152#endif
153protected:
154 void UpdateLength(double newLength, double deltaT);
155
157 void UpdateStiffness(const double* const adForceA, const double* const adForceB);
158
161
162
163 ISignalPort* m_inLength;
164 ISignalPort* m_inVelA;
165 ISignalPort* m_inVelB;
166 ISignalPort* m_inPosA;
167 ISignalPort* m_inPosB;
169 ICommonComputation* m_commonCalc;
170
171 // Member variables
174
175 double m_inertiaA;
176 double m_inertiaB;
177 mutable double m_forceA[3];
178 mutable double m_forceB[3];
179 double* m_lengths;
180 std::string m_cableName;
181
182 InternalCableWithBottomContact* m_internalCable; //< The cable calculations.
184};
Definition Cable.h:122
double * m_lengths
The lengths of the cable elements.
Definition Cable.h:179
ISignalPort * m_inLength
The cable length input port.
Definition Cable.h:163
ISignalPort * m_inPosB
The position B input port.
Definition Cable.h:167
std::string m_cableName
The identification name of the cable;.
Definition Cable.h:180
void InitialConditionSetup(const double dT, const double *const adCurrentIC, double *const adUpdatedIC, ISimObjectCreator *const creator)
functionality for setting initialconditions based on input port results.
double m_inertiaB
The inertia of the end B.
Definition Cable.h:176
int m_IStates
The index to the internal states of the cable.
Definition Cable.h:168
~Cable()
The destructor deletes dynamically allocated memory.
ICommonComputation * m_commonCalc
Calculations necessary for more than one output port.
Definition Cable.h:169
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:178
int m_numElements
The number of elements to divide the cable into.
Definition Cable.h:172
ISignalPort * m_inVelB
The velocity B input port.
Definition Cable.h:165
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:175
ISignalPort * m_inPosA
The position A input port.
Definition Cable.h:166
int m_numNodes
The number of nodes of the cable.
Definition Cable.h:173
SCableSpec m_CableSpec
The cable specification.
Definition Cable.h:183
double m_forceA[3]
The force on the end A.
Definition Cable.h:177
ISignalPort * m_inVelA
The velocity A input port.
Definition Cable.h:164
Class containing a cable object to be part of other structures.
Definition InternalCableWithBottomContact.h:21
Contains some specifications used for simulating cables.
Definition InternalCable.h:33