sphericalAngularSpring Class Reference

sixDoFRigidBodyMotionRestraints model. Spherical angular spring. More...

#include <sphericalAngularSpring.H>

Inheritance diagram for sphericalAngularSpring:

Collaboration diagram for sphericalAngularSpring:

Public Member Functions
	TypeName ("sphericalAngularSpring")
	Runtime type information.
	sphericalAngularSpring (const word &name, const dictionary &sDoFRBMRDict)
	Construct from components.
virtual autoPtr< sixDoFRigidBodyMotionRestraint >	clone () const
	Construct and return a clone.
virtual	~sphericalAngularSpring ()
	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. Spherical angular spring.

Source files

• sphericalAngularSpring.H
• sphericalAngularSpring.C

Definition at line 51 of file sphericalAngularSpring.H.

Constructor & Destructor Documentation

sphericalAngularSpring()

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

Construct from components.

Definition at line 46 of file sphericalAngularSpring.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:

~sphericalAngularSpring()

~sphericalAngularSpring ( )

virtual

Destructor.

Definition at line 64 of file sphericalAngularSpring.C.

Member Function Documentation

TypeName()

TypeName

(

"sphericalAngularSpring"

)

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 95 of file sphericalAngularSpring.H.

References sphericalAngularSpring().

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 71 of file sphericalAngularSpring.C.

References sixDoFRigidBodyMotion::centreOfRotation(), Foam::endl(), Foam::Info, VectorSpace< Form, Cmpt, Ncmpts >::nComponents, sixDoFRigidBodyMotion::omega(), sixDoFRigidBodyMotion::orientation(), sixDoFRigidBodyMotion::report(), 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 114 of file sphericalAngularSpring.C.

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

Referenced by sphericalAngularSpring().

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 139 of file sphericalAngularSpring.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/sphericalAngularSpring/sphericalAngularSpring.H
• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/restraints/sphericalAngularSpring/sphericalAngularSpring.C