CInternalCableWithAttractor Class Reference

Class containing a cable object to be part of larger cable structures. More...

#include <CInternalCableWithAttractor.h>

Inheritance diagram for CInternalCableWithAttractor:

Collaboration diagram for CInternalCableWithAttractor:

Public Member Functions
	CInternalCableWithAttractor (ISimObjectCreator *pCreator, const SCableSpec &CableSpec, std::string attractorName)
	The constructor sets the pointer to the output object and the parser object.
virtual void	FinalSetup (const double dT, const double *const adX, ISimObjectCreator *const pCreator)
void	SetAttractor (CAttractorBase *pAttractor)
	Sets the attractor to use.
virtual void	OdeFcn (const double *const adPosA, const double *const adVelA, const double *const adPosB, const double *const adVelB, const double *const adX, double *const adXDot, double dT)
	Calculates the state derivatives and the end forces. More...
Public Member Functions inherited from CInternalCableWithBottomContact
	CInternalCableWithBottomContact (ISimObjectCreator *pCreator, const SCableSpec &CableSpec)
	The constructor sets the pointer to the output object and the parser object.
virtual void	FinalSetup (const double dT, const double *const adX, ISimObjectCreator *const pCreator)
Public Member Functions inherited from CInternalCable
	CInternalCable (ISimObjectCreator *pCreator, const SCableSpec &CableSpec)
	The constructor sets the pointer to the output object and the parser object.
	~CInternalCable ()
	The destructor deletes dynamically allocated memory.
virtual void	FinalSetup (const double dT, const double *const adX, ISimObjectCreator *const pCreator)
virtual void	OdeFcn (const double *const adPosA, const double *const adVelA, const double *const adPosB, const double *const adVelB, const double *const adX, double *const adXDot, double dT)
	Calculates the state derivatives and the end forces. More...
virtual bool	InitializeStates (const double *const adPosA, const double *const adVelA, const double *const adPosB, const double *const adVelB, double *const adX)
	Method for setting initial conditions when the input is known, which may be implemented in the individual simObjects.
void	UpdateCable (double dNewLength, double dT)
	Updates the cable for the next step.
void	AddEndForcesAndInertia (double *const adEndForceA, double *const adEndForceB, double *const pdEndInertiaA, double *const pdEndInertiaB, const double *const adPosA, const double *const adVelA, const double *const adPosB, const double *const adVelB, const double *const adX, double dT)
	Adds the end forces and inertia to the supplied data structures.
double	GetLength ()
	Calculates the length of the cable.

Protected Member Functions
void	AddAttractorForces (const double *const adX)
	Adds the attractor forces to each cable node.
void	AddElementForce (int iCableElement, const double adPosA[3], const double adVelA[3], const double adPosB[3], const double adVelB[3], double adForceA[3], double adForceB[3], double dT)
	Adds the forces from each cable element. More...
virtual void	AddElementForce (int iCableElement, const double adPosA[3], const double adVelA[3], const double adPosB[3], const double adVelB[3], double adForceA[3], double adForceB[3], double dT)
Protected Member Functions inherited from CInternalCable
void	ResetAllNodeForces ()
void	AddAllElementForces (const double *const adPosA, const double *const adVelA, const double *const adPosB, const double *const adVelB, const double *const adX, double dT)
void	CalcDerivatives (const double *const adX, double *const adXDot)
virtual void	AddElementForce (int iCableElement, const double adPosA[3], const double adVelA[3], const double adPosB[3], const double adVelB[3], double adForceA[3], double adForceB[3], double dT)
void	UpdateInertia ()
	Updates the inertia of the cable according to the changing length.

Protected Attributes
std::string	m_attractorName
CAttractorBase *	m_pAttractor
	A pointer to the attractor to use.
Protected Attributes inherited from CInternalCableWithBottomContact
IBasicBottom **	m_ppBottom
Protected Attributes inherited from CInternalCable
unsigned long *	m_aIStatePos
	An array of indices to the node position states.
unsigned long *	m_aIStateVel
	An array of indices to the node velocity states.
SCableSpec	m_CableSpec
	The cable specification.
double	m_dEA
	The stiffness of the cable.
sfh::timers::StopWatch	m_StopWatch
CCableElDynStiff **	m_apCableElements
	An array holding the cable elements.
double *	m_adInertiaA
	The inertia of the A nodes.
double *	m_adInertiaB
	The inertia of the B nodes.
double **	m_aadForceA
	The force on the A nodes.
double **	m_aadForceB
	The force on the B nodes.
ICurrentVel **	m_ppCurrentVel
double	m_adElVelWater [3]
double	m_adElMeanPos [3]
double	m_adElMeanVel [3]

Additional Inherited Members
Public Attributes inherited from CInternalCable
unsigned long	m_iNumElements
	The number of elements to divide the cable into.
unsigned long	m_iNumNodes
	The number of nodes of the cable.

Detailed Description

Author

Karl-Johan Reite

Member Function Documentation

AddElementForce()

void CInternalCableWithAttractor::AddElementForce ( int  iCableElement, const double  adPosA[3], const double  adVelA[3], const double  adPosB[3], const double  adVelB[3], double  adForceA[3], double  adForceB[3], double  dT  )

protectedvirtual

Reimplemented from CInternalCableWithBottomContact.

FinalSetup()

virtual void CInternalCableWithAttractor::FinalSetup ( const double  dT, const double *const  adX, ISimObjectCreator *const  pCreator  )

virtual

Reimplemented from CInternalCableWithBottomContact.

OdeFcn()

virtual void CInternalCableWithAttractor::OdeFcn ( const double *const  adPosA, const double *const  adVelA, const double *const  adPosB, const double *const  adVelB, const double *const  adX, double *const  adXDot, double  dT  )

virtual

Reimplemented from CInternalCable.

---

The documentation for this class was generated from the following file:

• reloadrepos/fhsim_aquaculture/src/seine/CInternalCableWithAttractor.h