Loading...
Searching...
No Matches
sixDoFRigidBodyMotionRestraint Class Referenceabstract

Base class for defining restraints for sixDoF motions. More...

#include <sixDoFRigidBodyMotionRestraint.H>

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

Public Member Functions

 TypeName ("sixDoFRigidBodyMotionRestraint")
 Runtime type information.
 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.
virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone () const =0
 Construct and return a clone.
virtual ~sixDoFRigidBodyMotionRestraint ()
 Destructor.
const word & name () const
 Return the name.
virtual void restrain (const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const =0
 Calculate the restraint position, force and moment.
virtual bool read (const dictionary &sDoFRBMRDict)
 Update properties from given dictionary.
const dictionary & coeffDict () const
virtual void write (Ostream &) const =0
 Write.

Static Public Member Functions

static autoPtr< sixDoFRigidBodyMotionRestraint > New (const word &name, const dictionary &sDoFRBMRDict)
 Select constructed from the sDoFRBMRDict dictionary and Time.

Protected Attributes

word name_
 Name of the restraint.
dictionary sDoFRBMRCoeffs_
 Restraint model specific coefficient dictionary.

Detailed Description

Base class for defining restraints for sixDoF motions.

Source files

Definition at line 63 of file sixDoFRigidBodyMotionRestraint.H.

Constructor & Destructor Documentation

◆ sixDoFRigidBodyMotionRestraint()

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

Construct from the sDoFRBMRDict dictionary and Time.

Definition at line 34 of file sixDoFRigidBodyMotionRestraint.C.

References name(), name_, and sDoFRBMRCoeffs_.

Referenced by declareRunTimeSelectionTable(), linearAxialAngularSpring::linearAxialAngularSpring(), linearDamper::linearDamper(), linearSpring::linearSpring(), linearSpringDamper::linearSpringDamper(), softWall::softWall(), sphericalAngularDamper::sphericalAngularDamper(), sphericalAngularSpring::sphericalAngularSpring(), and tabulatedAxialAngularSpring::tabulatedAxialAngularSpring().

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

◆ ~sixDoFRigidBodyMotionRestraint()

~sixDoFRigidBodyMotionRestraint ( )
virtual

Destructor.

Definition at line 47 of file sixDoFRigidBodyMotionRestraint.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sixDoFRigidBodyMotionRestraint" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
sixDoFRigidBodyMotionRestraint ,
dictionary ,
(const word &name, const dictionary &sDoFRBMRDict) ,
(name, sDoFRBMRDict)  )

References name(), and sixDoFRigidBodyMotionRestraint().

Here is the call graph for this function:

◆ clone()

virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in linearAxialAngularSpring, linearDamper, linearSpring, linearSpringDamper, softWall, sphericalAngularDamper, sphericalAngularSpring, and tabulatedAxialAngularSpring.

References name().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::sixDoFRigidBodyMotionRestraint > New ( const word & name,
const dictionary & sDoFRBMRDict )
static

Select constructed from the sDoFRBMRDict dictionary and Time.

Definition at line 27 of file sixDoFRigidBodyMotionRestraintNew.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and name().

Referenced by sixDoFRigidBodyMotion::addRestraints().

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

◆ name()

const word & name ( ) const
inline

Return the name.

Definition at line 141 of file sixDoFRigidBodyMotionRestraint.H.

References name_.

Referenced by clone(), declareRunTimeSelectionTable(), linearAxialAngularSpring::linearAxialAngularSpring(), linearDamper::linearDamper(), linearSpring::linearSpring(), linearSpringDamper::linearSpringDamper(), New(), sixDoFRigidBodyMotionRestraint(), softWall::softWall(), sphericalAngularDamper::sphericalAngularDamper(), sphericalAngularSpring::sphericalAngularSpring(), tabulatedAxialAngularSpring::tabulatedAxialAngularSpring(), linearAxialAngularSpring::TypeName(), linearDamper::TypeName(), linearSpring::TypeName(), linearSpringDamper::TypeName(), softWall::TypeName(), sphericalAngularDamper::TypeName(), sphericalAngularSpring::TypeName(), and tabulatedAxialAngularSpring::TypeName().

Here is the caller graph for this function:

◆ restrain()

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

Calculate the restraint position, force and moment.

Global reference frame vectors.

Implemented in linearAxialAngularSpring, linearDamper, linearSpring, linearSpringDamper, softWall, sphericalAngularDamper, sphericalAngularSpring, and tabulatedAxialAngularSpring.

◆ read()

bool read ( const dictionary & sDoFRBMRDict)
virtual

Update properties from given dictionary.

Reimplemented in linearAxialAngularSpring, linearDamper, linearSpring, linearSpringDamper, softWall, sphericalAngularDamper, sphericalAngularSpring, and tabulatedAxialAngularSpring.

Definition at line 53 of file sixDoFRigidBodyMotionRestraint.C.

References sDoFRBMRCoeffs_.

Referenced by linearAxialAngularSpring::read(), linearDamper::read(), linearSpring::read(), linearSpringDamper::read(), softWall::read(), sphericalAngularDamper::read(), sphericalAngularSpring::read(), and tabulatedAxialAngularSpring::read().

Here is the caller graph for this function:

◆ coeffDict()

const dictionary & coeffDict ( ) const
inline

Definition at line 167 of file sixDoFRigidBodyMotionRestraint.H.

References sDoFRBMRCoeffs_.

Referenced by linearSpringDamper::restrain().

Here is the caller graph for this function:

◆ write()

virtual void write ( Ostream & ) const
pure virtual

Write.

Implemented in linearAxialAngularSpring, linearDamper, linearSpring, linearSpringDamper, softWall, sphericalAngularDamper, sphericalAngularSpring, and tabulatedAxialAngularSpring.

Member Data Documentation

◆ name_

word name_
protected

Name of the restraint.

Definition at line 73 of file sixDoFRigidBodyMotionRestraint.H.

Referenced by name(), and sixDoFRigidBodyMotionRestraint().

◆ sDoFRBMRCoeffs_

dictionary sDoFRBMRCoeffs_
protected

Restraint model specific coefficient dictionary.

Definition at line 78 of file sixDoFRigidBodyMotionRestraint.H.

Referenced by coeffDict(), read(), linearAxialAngularSpring::read(), linearDamper::read(), linearSpring::read(), linearSpringDamper::read(), softWall::read(), sphericalAngularDamper::read(), sphericalAngularSpring::read(), tabulatedAxialAngularSpring::read(), and sixDoFRigidBodyMotionRestraint().

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