FreeFOAM The Cross-Platform CFD Toolkit
Public Member Functions
linearSpring Class Reference

sixDoFRigidBodyMotionRestraints model. Linear spring. More...

#include <forces/linearSpring.H>

Detailed Description

sixDoFRigidBodyMotionRestraints model. Linear spring.

Source files

Definition at line 53 of file linearSpring.H.

+ Inheritance diagram for linearSpring:
+ Collaboration diagram for linearSpring:

List of all members.

Public Member Functions

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

Additional Inherited Members

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

Constructor & Destructor Documentation

linearSpring ( const dictionary &  sDoFRBMRDict)

Construct from components.

Definition at line 50 of file linearSpring.C.

Referenced by linearSpring::clone().

~linearSpring ( )
virtual

Definition at line 67 of file linearSpring.C.

Member Function Documentation

TypeName ( "linearSpring"  )

Runtime type information.

virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 91 of file linearSpring.H.

References linearSpring::linearSpring().

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 74 of file linearSpring.C.

References sixDoFRigidBodyMotion::currentPosition(), sixDoFRigidBodyMotion::currentVelocity(), Foam::endl(), Foam::Info, Foam::mag(), sixDoFRigidBodyMotion::report(), and Vector< scalar >::zero.

bool read ( const dictionary &  sDoFRBMRCoeff)
virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionRestraint.

Definition at line 108 of file linearSpring.C.

References sixDoFRigidBodyMotionRestraint::read().

void write ( Ostream &  os) const
virtual

Write.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 129 of file linearSpring.C.

References token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

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