Public Member Functions | List of all members
linearSpring Class Reference

sixDoFRigidBodyMotionRestraints model. Linear spring. More...

Inheritance diagram for linearSpring:
Inheritance graph
[legend]
Collaboration diagram for linearSpring:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("linearSpring")
 Runtime type information. More...
 
 linearSpring (const word &name, const dictionary &sDoFRBMRDict)
 Construct from components. More...
 
virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone () const
 Construct and return a clone. More...
 
virtual ~linearSpring ()
 Destructor. More...
 
virtual void restrain (const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const
 Calculate the restraint position, force and moment. More...
 
virtual bool read (const dictionary &sDoFRBMRCoeff)
 Update properties from given dictionary. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from sixDoFRigidBodyMotionRestraint
 TypeName ("sixDoFRigidBodyMotionRestraint")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, sixDoFRigidBodyMotionRestraint, dictionary,(const word &name, const dictionary &sDoFRBMRDict),(name, sDoFRBMRDict))
 
 sixDoFRigidBodyMotionRestraint (const word &name, const dictionary &sDoFRBMRDict)
 Construct from the sDoFRBMRDict dictionary and Time. More...
 
virtual ~sixDoFRigidBodyMotionRestraint ()
 Destructor. More...
 
const word & name () const
 Return the name. More...
 
const dictionary & coeffDict () const
 

Additional Inherited Members

- Static Public Member Functions inherited from sixDoFRigidBodyMotionRestraint
static autoPtr< sixDoFRigidBodyMotionRestraint > New (const word &name, const dictionary &sDoFRBMRDict)
 Select constructed from the sDoFRBMRDict dictionary and Time. More...
 
- Protected Attributes inherited from sixDoFRigidBodyMotionRestraint
word name_
 Name of the restraint. More...
 
dictionary sDoFRBMRCoeffs_
 Restraint model specific coefficient dictionary. More...
 

Detailed Description

sixDoFRigidBodyMotionRestraints model. Linear spring.

Source files

Definition at line 52 of file linearSpring.H.

Constructor & Destructor Documentation

◆ linearSpring()

linearSpring ( const word &  name,
const dictionary &  sDoFRBMRDict 
)

Construct from components.

Definition at line 51 of file linearSpring.C.

References Foam::read().

Referenced by linearSpring::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~linearSpring()

~linearSpring ( )
virtual

Destructor.

Definition at line 69 of file linearSpring.C.

References linearSpring::restrain().

Referenced by linearSpring::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "linearSpring"  )

Runtime type information.

◆ clone()

virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 91 of file linearSpring.H.

References linearSpring::linearSpring(), linearSpring::read(), linearSpring::restrain(), linearSpring::write(), and linearSpring::~linearSpring().

Here is the call graph for this function:

◆ restrain()

void restrain ( const sixDoFRigidBodyMotion &  motion,
vector &  restraintPosition,
vector &  restraintForce,
vector &  restraintMoment 
) const
virtual

Calculate the restraint position, force and moment.

Global reference frame vectors.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 76 of file linearSpring.C.

References Foam::endl(), Foam::Info, Foam::mag(), linearSpring::read(), sixDoFRigidBodyMotion::report(), sixDoFRigidBodyMotion::transform(), sixDoFRigidBodyMotion::velocity(), and Foam::Zero.

Referenced by linearSpring::clone(), and linearSpring::~linearSpring().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  sDoFRBMRCoeff)
virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionRestraint.

Definition at line 107 of file linearSpring.C.

References sixDoFRigidBodyMotionRestraint::read(), and linearSpring::write().

Referenced by linearSpring::clone(), and linearSpring::restrain().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 124 of file linearSpring.C.

References Foam::writeEntry().

Referenced by linearSpring::clone(), and linearSpring::read().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: