FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
NetStructure.h
1#pragma once
2
3#include <limits>
4#include <vector>
5#include "CommonTypes.h"
6
278// #define CNetStructure_DO_PROFILE
279
280// Includes
281#include "NetCableElement.h"
282#include "NetCableElementSpec.h"
283#include "NetCore.h"
284#include "NetElement3N.h"
285#include "NetElementDef.h"
286#include "NetNodeStates.h"
287#include "NetStructureSpec.h"
288
289#include "sfh/math/math.h"
290#include "sfh/timers/ProfilerWallclock.h"
291
292#include <fhsim/simobject/SimObject.h>
293#include <fhsim_environment/EnvironmentProvider.h>
294#include <fhsim_environment/SeafloorForcesInterface.h>
295#include <memory>
296#include <string>
297
298
299#ifdef FH_VISUALIZATION
300# include "sfh/ogre/C3DLine.h"
301# include "sfh/ogre/NMeshGenerators.h"
302#endif
303
304
305// Class definition
306class NetStructure : public SimObject, private NetNodeStates
307{
308public:
310 NetStructure(std::string simObjectName, ISimObjectCreator* creator);
312 virtual ~NetStructure();
313 virtual void OdeFcn(const double dT, const double* const adX, double* const adXDot) const;
314 virtual void InitialConditionSetup(const double dT, const double* const adCurrentIC, double* const adUpdatedIC, ISimObjectCreator* const creator);
315 virtual void FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator);
317 void PreOdeFcn(double T, const double* X) override;
318 void AcceptedStep(const double T, const double* const X) override;
320 void BottomContactCommon(const double T, const double* const X) const;
321 const double* outExternalNodeForce(const double dT, const double* const adX, int extNode);
322
324
350 bool HasJacobians() const override;
351 void OdeJacobian(double T, const double* X, double* J, int nStates) override;
352 int GetJacobianSparsity(int nStates, int* rowPtr, int* colIdx) override;
353
354 bool HasPortJacobians() const override;
355 void InputPortJacobian(const std::string& portName, double T, const double* X,
356 double* dF_dInput, int portSize, int nStates) override;
362 void OutputPortJacobian(const std::string& portName, double T, const double* X,
363 double* dPort_dX, int portSize, int nStates, int index) override;
365
366#ifdef FH_VISUALIZATION
368 virtual void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator);
370 virtual void RenderUpdate(const double dT, const double* const adX);
371#endif
372 const virtual double* NodePos(const double dT, const double* const adX, int extNode);
373 const virtual double* NodeVel(const double dT, const double* const adX, int extNode);
374 const virtual double* BottomContact(const double dT, const double* const adX);
375
376 const virtual double* StrainEnergy(const double dT, const double* const adX);
377 const virtual double* VelNorm(const double dT, const double* const adX);
378 double m_velNorm;
379
380protected:
382
384 NetNodeLayout Layout() const override;
386 void AddExternalForces(double T, const double* X, double* nodeForce) const override;
388 void TakeNodeForces(double T, const double* X, const double* nodeForce, double* XDot) const override;
390
393 virtual void AddInputPorts(ISimObjectCreator* creator);
394 virtual void CreateOutputPorts(ISimObjectCreator* creator);
395 std::string PosPortName(int extNode) const;
396 std::string VelPortName(int extNode) const;
397 void VelNormJacobian(const double* X, double* dPort_dX) const;
398 void StrainEnergyJacobian(const double* X, double* dPort_dX) const;
399 VSPairStrInt CreateExternalNodeMap(std::string tag, int* piUsed, const NetStructureSpec& NetSpec, ISimObjectCreator* creator);
400
406 const NetCableElement* cable,
407 const double pA[3], const double pB[3],
408 const double vA[3], const double vB[3],
409 double dFA_dpA[9], double dFA_dpB[9],
410 double dFA_dvA[9], double dFA_dvB[9]) const;
411
412 double m_StrainEnergy;
413
415 std::unique_ptr<NetCore> m_core;
416
418
419 std::vector<ISignalPort*> m_inExternalForces;
420 std::vector<int> m_iStatePos;
421 std::vector<int> m_iStateVel;
422 int m_iStateBase = 0;
423
425 // double* m_NodeExternalForces;
427
429 int m_numNodesOutputPosAndVel;
431
432
434
436 VSPairStrInt m_VsNodesInputForce;
437 bool m_useTagForExternalNodes;
439
440
441#ifdef CNetStructure_DO_PROFILE
442 sfh::timers::ProfilerWallclock m_Profiler;
443#endif
444
445#ifdef FH_VISUALIZATION
446 bool m_lineVisualization;
447 C3DLine* m_LineVisualizationPressure;
448 C3DLine* m_LineVisualizationStrain;
449#endif
450
451private:
455 void FillAnalyticalJacobian(double T, const double* X, double* J, int nStates);
456 friend class NetStructureTestAccess;
457};
Definition NetCableElement.h:49
Definition NetNodeStates.h:39
Definition NetStructureSpec.h:39
Definition NetStructure.h:307
void BottomContactCommon(const double T, const double *const X) const
The common computation of the seabed contact at (T, X) (NetCore::ComputeBottomContact).
std::vector< ISignalPort * > m_inExternalForces
Interface member variables.
Definition NetStructure.h:419
virtual ~NetStructure()
The destructor deletes dynamically allocated memory.
void OutputPortJacobian(const std::string &portName, double T, const double *X, double *dPort_dX, int portSize, int nStates, int index) override
void AddExternalForces(double T, const double *X, double *nodeForce) const override
The forces of the input force ports, on their nodes.
NetNodeLayout Layout() const override
NetStructure(std::string simObjectName, ISimObjectCreator *creator)
The constructor sets the pointer to the output object and the parser object.
int m_iStateBase
Global index of this SimObject's first state, set in the constructor.
Definition NetStructure.h:422
void ComputeCableStructuralJacobian(const NetCableElement *cable, const double pA[3], const double pB[3], const double vA[3], const double vB[3], double dFA_dpA[9], double dFA_dpB[9], double dFA_dvA[9], double dFA_dvB[9]) const
bool HasJacobians() const override
void TakeNodeForces(double T, const double *X, const double *nodeForce, double *XDot) const override
The state derivatives: velocity, force over inertia (and MassFactor), bounded by MaxVelocity.
std::unique_ptr< NetCore > m_core
The net core: the panels, cable elements, their loads, the wakes and the seabed contact (NetCore....
Definition NetStructure.h:415
int m_numNodesInputForce
Node counts.
Definition NetStructure.h:428
VSPairStrInt m_VsNodesOutputPosAndVel
Nodes reachable directly through input or output ports.
Definition NetStructure.h:435
bool HasJacobianConfiguration() const
void PreOdeFcn(double T, const double *X) override
Rebuilds the cast wake when due (with CastWake) and takes the wakes at the panel centroids and cable ...
Definition NetNodeStates.h:19