linearSpring Class Reference

sixDoFRigidBodyMotionRestraints model. Linear spring. More...

Inheritance diagram for linearSpring:

Collaboration diagram for linearSpring:

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

Private Attributes
point	anchor_
	Anchor point, where the spring is attached to an immovable. More...
point	refAttachmentPt_
	Reference point of attachment to the solid body. More...
scalar	stiffness_
	Spring stiffness coefficient (N/m) More...
scalar	damping_
	Damping coefficient (Ns/m) More...
scalar	restLength_
	Rest length - length of spring when no forces are applied to it. 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 spring.

Source files

• linearSpring.H
• linearSpring.C

Definition at line 52 of file linearSpring.H.

Constructor & Destructor Documentation

linearSpring()

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

Construct from components.

Definition at line 51 of file linearSpring.C.

References Foam::read().

Referenced by linearSpring::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

~linearSpring()

~linearSpring ( )

virtual

Destructor.

Definition at line 69 of file linearSpring.C.

Member Function Documentation

TypeName()

TypeName

(

"linearSpring"

)

Runtime type information.

clone()

virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 91 of file linearSpring.H.

References linearSpring::linearSpring().

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 76 of file linearSpring.C.

References Foam::endl(), Foam::Info, Foam::mag(), sixDoFRigidBodyMotion::report(), sixDoFRigidBodyMotion::transform(), sixDoFRigidBodyMotion::velocity(), and Vector< scalar >::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 107 of file linearSpring.C.

References sixDoFRigidBodyMotionRestraint::read().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 124 of file linearSpring.C.

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

Here is the call graph for this function:

Field Documentation

anchor_

point anchor_

private

Anchor point, where the spring is attached to an immovable.

object

Definition at line 60 of file linearSpring.H.

refAttachmentPt_

point refAttachmentPt_

private

Reference point of attachment to the solid body.

Definition at line 63 of file linearSpring.H.

stiffness_

scalar stiffness_

private

Spring stiffness coefficient (N/m)

Definition at line 66 of file linearSpring.H.

damping_

scalar damping_

private

Damping coefficient (Ns/m)

Definition at line 69 of file linearSpring.H.

restLength_

scalar restLength_

private

Rest length - length of spring when no forces are applied to it.

Definition at line 72 of file linearSpring.H.

---

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

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