sixDoFRigidBodyMotionRestraints model. Spherical angular spring. More...

Inheritance diagram for sphericalAngularSpring:

Collaboration diagram for sphericalAngularSpring:

Public Member Functions
	TypeName ("sphericalAngularSpring")
	Runtime type information. More...

	sphericalAngularSpring (const word &name, const dictionary &sDoFRBMRDict)
	Construct from components. More...

virtual autoPtr< sixDoFRigidBodyMotionRestraint >	clone () const
	Construct and return a clone. More...

virtual	~sphericalAngularSpring ()
	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

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. Spherical angular spring.

Source files

Definition at line 53 of file sphericalAngularSpring.H.

Constructor & Destructor Documentation

◆ sphericalAngularSpring()

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

Construct from components.

Definition at line 52 of file sphericalAngularSpring.C.

References Foam::read(), and sphericalAngularSpring::~sphericalAngularSpring().

Referenced by sphericalAngularSpring::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~sphericalAngularSpring()

~sphericalAngularSpring ( )

virtual

Destructor.

Definition at line 69 of file sphericalAngularSpring.C.

References sphericalAngularSpring::restrain().

Referenced by sphericalAngularSpring::clone(), and sphericalAngularSpring::sphericalAngularSpring().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "sphericalAngularSpring" )

Runtime type information.

◆ clone()

virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionRestraint.

Definition at line 85 of file sphericalAngularSpring.H.

References sphericalAngularSpring::read(), sphericalAngularSpring::restrain(), sphericalAngularSpring::sphericalAngularSpring(), sphericalAngularSpring::write(), and sphericalAngularSpring::~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 76 of file sphericalAngularSpring.C.

References sixDoFRigidBodyMotion::centreOfRotation(), Foam::endl(), Foam::Info, VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, sixDoFRigidBodyMotion::omega(), sixDoFRigidBodyMotion::orientation(), sphericalAngularSpring::read(), sixDoFRigidBodyMotion::report(), and Foam::Zero.

Referenced by sphericalAngularSpring::clone(), and sphericalAngularSpring::~sphericalAngularSpring().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & sDoFRBMRCoeff )

virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionRestraint.

Definition at line 119 of file sphericalAngularSpring.C.

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

Referenced by sphericalAngularSpring::clone(), and sphericalAngularSpring::restrain().

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

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

Referenced by sphericalAngularSpring::clone(), and sphericalAngularSpring::read().

Here is the call graph for this function:

Here is the caller 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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sphericalAngularSpring()

◆ ~sphericalAngularSpring()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ restrain()

◆ read()

◆ write()