linearAxialAngularSpring Class Reference

sixDoFRigidBodyMotionRestraints model. Linear axial angular spring. More...

#include <linearAxialAngularSpring.H>

Inheritance diagram for linearAxialAngularSpring:

Collaboration diagram for linearAxialAngularSpring:

Public Member Functions
	TypeName ("linearAxialAngularSpring")
	Runtime type information.
	linearAxialAngularSpring (const word &name, const dictionary &sDoFRBMRDict)
	Construct from components.
virtual autoPtr< sixDoFRigidBodyMotionRestraint >	clone () const
	Construct and return a clone.
virtual	~linearAxialAngularSpring ()
	Destructor.
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 word &name, const dictionary &sDoFRBMRDict),(name, sDoFRBMRDict))
	sixDoFRigidBodyMotionRestraint (const word &name, const dictionary &sDoFRBMRDict)
	Construct from the sDoFRBMRDict dictionary and Time.
virtual	~sixDoFRigidBodyMotionRestraint ()
	Destructor.
const word &	name () const
	Return the name.
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.
Protected Attributes inherited from sixDoFRigidBodyMotionRestraint
word	name_
	Name of the restraint.
dictionary	sDoFRBMRCoeffs_
	Restraint model specific coefficient dictionary.

Detailed Description

sixDoFRigidBodyMotionRestraints model. Linear axial angular spring.

Source files

• linearAxialAngularSpring.H
• linearAxialAngularSpring.C

Definition at line 51 of file linearAxialAngularSpring.H.

Constructor & Destructor Documentation

linearAxialAngularSpring()

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

Construct from components.

Definition at line 47 of file linearAxialAngularSpring.C.

References sixDoFRigidBodyMotionRestraint::name(), read(), and sixDoFRigidBodyMotionRestraint::sixDoFRigidBodyMotionRestraint().

Referenced by clone().

Here is the call graph for this function:

Here is the caller graph for this function:

~linearAxialAngularSpring()

~linearAxialAngularSpring ( )

virtual

Destructor.

Definition at line 66 of file linearAxialAngularSpring.C.

Member Function Documentation

TypeName()

TypeName

(

"linearAxialAngularSpring"

)

Runtime type information.

References sixDoFRigidBodyMotionRestraint::name().

Here is the call graph for this function:

clone()

virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 100 of file linearAxialAngularSpring.H.

References linearAxialAngularSpring().

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

References Foam::acos(), sixDoFRigidBodyMotion::centreOfRotation(), Foam::endl(), Foam::Info, Foam::mag(), Foam::min(), sixDoFRigidBodyMotion::omega(), sixDoFRigidBodyMotion::orientation(), sixDoFRigidBodyMotion::report(), Foam::rotationTensor(), Foam::sign(), and Foam::Zero.

Here is the call graph for this function:

read()

bool read ( const dictionary & sDoFRBMRCoeff )

virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionRestraint.

Definition at line 140 of file linearAxialAngularSpring.C.

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

Referenced by linearAxialAngularSpring().

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 180 of file linearAxialAngularSpring.C.

References os().

Here is the call graph for this function:

---

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

• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/restraints/linearAxialAngularSpring/linearAxialAngularSpring.H
• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/restraints/linearAxialAngularSpring/linearAxialAngularSpring.C