Public Member Functions | Private Attributes
tabulatedAxialAngularSpring Class Reference

sixDoFRigidBodyMotionRestraints model. Axial angular spring with moment values drawn from an interpolation table. Linear damping. More...

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

Public Member Functions

 TypeName ("tabulatedAxialAngularSpring")
 Runtime type information. More...
 
 tabulatedAxialAngularSpring (const word &name, const dictionary &sDoFRBMRDict)
 Construct from components. More...
 
virtual autoPtr< sixDoFRigidBodyMotionRestraintclone () const
 Construct and return a clone. More...
 
virtual ~tabulatedAxialAngularSpring ()
 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 wordname () const
 Return the name. More...
 
const dictionarycoeffDict () const
 

Private Attributes

tensor refQ_
 Reference orientation where there is no moment. More...
 
vector axis_
 Global unit axis around which the motion is sprung. More...
 
interpolationTable< scalar > moment_
 Spring moment interpolation table, depending on angleFormat. More...
 
bool convertToDegrees_
 Boolean stating whether the angle around the axis needs to. More...
 
scalar damping_
 Damping coefficient (Nms/rad) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from sixDoFRigidBodyMotionRestraint
static autoPtr< sixDoFRigidBodyMotionRestraintNew (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. Axial angular spring with moment values drawn from an interpolation table. Linear damping.

Source files

Definition at line 55 of file tabulatedAxialAngularSpring.H.

Constructor & Destructor Documentation

◆ tabulatedAxialAngularSpring()

tabulatedAxialAngularSpring ( const word name,
const dictionary sDoFRBMRDict 
)

Construct from components.

Definition at line 54 of file tabulatedAxialAngularSpring.C.

References Foam::read().

Referenced by tabulatedAxialAngularSpring::clone().

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

◆ ~tabulatedAxialAngularSpring()

Destructor.

Definition at line 73 of file tabulatedAxialAngularSpring.C.

Member Function Documentation

◆ TypeName()

TypeName ( "tabulatedAxialAngularSpring"  )

Runtime type information.

◆ clone()

virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 95 of file tabulatedAxialAngularSpring.H.

References tabulatedAxialAngularSpring::tabulatedAxialAngularSpring().

Here is the call graph for this function:

◆ restrain()

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

◆ read()

bool read ( const dictionary sDoFRBMRCoeff)
virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionRestraint.

Definition at line 146 of file tabulatedAxialAngularSpring.C.

References Foam::abort(), Foam::e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::I, Foam::mag(), Foam::nl, sixDoFRigidBodyMotionRestraint::read(), and Foam::sqrt().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 204 of file tabulatedAxialAngularSpring.C.

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

Here is the call graph for this function:

Field Documentation

◆ refQ_

tensor refQ_
private

Reference orientation where there is no moment.

Definition at line 62 of file tabulatedAxialAngularSpring.H.

◆ axis_

vector axis_
private

Global unit axis around which the motion is sprung.

Definition at line 65 of file tabulatedAxialAngularSpring.H.

◆ moment_

interpolationTable<scalar> moment_
private

Spring moment interpolation table, depending on angleFormat.

Definition at line 68 of file tabulatedAxialAngularSpring.H.

◆ convertToDegrees_

bool convertToDegrees_
private

Boolean stating whether the angle around the axis needs to.

be converted to degrees before asking the interpolationTable for a moment value

Definition at line 73 of file tabulatedAxialAngularSpring.H.

◆ damping_

scalar damping_
private

Damping coefficient (Nms/rad)

Definition at line 76 of file tabulatedAxialAngularSpring.H.


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