FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
AttractorNetBin Class Reference

A basic attractor for simulating a net bin during deployment. More...

#include <AttractorNetBin.h>

+ Inheritance diagram for AttractorNetBin:
+ Collaboration diagram for AttractorNetBin:

Public Member Functions

void SetParams (const double radius, const double springStiffness, const double damping)
 
void AddForce (const Motion &motion, double *const adForce, const double *const adNodePos, const double *const adNodeVel) override
 
void SetForceIfActive (const Motion &motion, double *const adForce, const double *const adNodePos, const double *const adNodeVel) override
 
void GetForce (const Motion &motion, double *const adForce, const double *const adNodePos, const double *const adNodeVel) override
 
void AddForce (const Motion &motion, double *const adForce, const double nodeMass, const double *const adNodePos, const double *const adNodeVel) override
 
bool IsActive (const Motion &motion, const double *const adNodePos) override
 
- Public Member Functions inherited from AttractorBase
void SetPosAndVelSource (PosAndVelSource source)
 Sets what moves the attractor (Seine/Vessel, when it creates it).
 
void SetStrengthSource (StrengthSource source)
 Sets what scales the attractor's pull (Seine/Operation, in its FinalSetup).
 
Motion MotionAt (double T, const double *X) const
 

Protected Attributes

double m_radius
 
double m_springStiffness
 
double m_damping
 

Additional Inherited Members

- Public Types inherited from AttractorBase
using PosAndVelSource = std::function< void(double T, const double *X, double pos[3], double vel[3])>
 Gives the attractor's position and velocity at (T, X), X the model-global states.
 
using StrengthSource = std::function< double(double T)>
 Gives the attractor's relative strength at time T.
 

Detailed Description

Author
Karl-Johan Reite

Member Function Documentation

◆ AddForce() [1/2]

void AttractorNetBin::AddForce ( const Motion &  motion,
double *const  adForce,
const double *const  adNodePos,
const double *const  adNodeVel 
)
overridevirtual

Implements AttractorBase.

◆ AddForce() [2/2]

void AttractorNetBin::AddForce ( const Motion &  motion,
double *const  adForce,
const double  nodeMass,
const double *const  adNodePos,
const double *const  adNodeVel 
)
overridevirtual

Implements AttractorBase.

◆ GetForce()

void AttractorNetBin::GetForce ( const Motion &  motion,
double *const  adForce,
const double *const  adNodePos,
const double *const  adNodeVel 
)
overridevirtual

Implements AttractorBase.

◆ IsActive()

bool AttractorNetBin::IsActive ( const Motion &  motion,
const double *const  adNodePos 
)
overridevirtual

Implements AttractorBase.

◆ SetForceIfActive()

void AttractorNetBin::SetForceIfActive ( const Motion &  motion,
double *const  adForce,
const double *const  adNodePos,
const double *const  adNodeVel 
)
overridevirtual

Reimplemented from AttractorBase.

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