linearAxialAngularSpring Class Reference

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

Inheritance diagram for linearAxialAngularSpring:

Collaboration diagram for linearAxialAngularSpring:

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

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. 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. Linear axial angular spring.

Source files

• linearAxialAngularSpring.H
• linearAxialAngularSpring.C

Definition at line 55 of file linearAxialAngularSpring.H.

Constructor & Destructor Documentation

linearAxialAngularSpring()

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

Construct from components.

Definition at line 54 of file linearAxialAngularSpring.C.

References Foam::name(), and linearAxialAngularSpring::read().

Here is the call graph for this function:

~linearAxialAngularSpring()

~linearAxialAngularSpring ( )

virtual

Destructor.

Definition at line 73 of file linearAxialAngularSpring.C.

Member Function Documentation

TypeName()

TypeName

(

"linearAxialAngularSpring"

)

Runtime type information.

clone()

virtual autoPtr< sixDoFRigidBodyMotionRestraint > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 90 of file linearAxialAngularSpring.H.

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

References Foam::abort(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::I, Foam::mag(), Foam::nl, kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), and Foam::sqrt().

Referenced by linearAxialAngularSpring::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 187 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