linearAxialAngularSpring Class Reference

Linear axial angular spring restraint. 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 &dict, const rigidBodyModel &model)
	Construct from components.
virtual autoPtr< restraint >	clone () const
	Construct and return a clone.
virtual	~linearAxialAngularSpring ()
	Destructor.
virtual void	restrain (scalarField &tau, Field< spatialVector > &fx, const rigidBodyModelState &state) const
	Accumulate the restraint internal joint forces into the tau field and.
virtual bool	read (const dictionary &dict)
	Update properties from given dictionary.
virtual void	write (Ostream &) const
	Write.
Public Member Functions inherited from restraint
	TypeName ("restraint")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, restraint, dictionary,(const word &name, const dictionary &dict, const rigidBodyModel &model),(name, dict, model))
	restraint (const word &name, const dictionary &dict, const rigidBodyModel &model)
	Construct from the dict dictionary and Time.
virtual	~restraint ()
	Destructor.
const word &	name () const
	Return the name.
label	bodyID () const
const dictionary &	coeffDict () const
	Return access to coeffs.

Additional Inherited Members
Static Public Member Functions inherited from restraint
static autoPtr< restraint >	New (const word &name, const dictionary &dict, const rigidBodyModel &model)
	Select constructed from the dict dictionary and Time.
Protected Member Functions inherited from restraint
point	bodyPoint (const point &p) const
	Transform the given point on the restrained body to the global frame.
spatialVector	bodyPointVelocity (const point &p) const
	Transform the velocity of the given point on the restrained body.
Protected Attributes inherited from restraint
word	name_
	Name of the restraint.
label	bodyID_
	ID of the body the restraint is applied to.
label	bodyIndex_
	Index of the body the force is applied to.
dictionary	coeffs_
	Restraint model specific coefficient dictionary.
const rigidBodyModel &	model_
	Reference to the model.

Detailed Description

Linear axial angular spring restraint.

Source files

• linearAxialAngularSpring.H
• linearAxialAngularSpring.C

Definition at line 53 of file linearAxialAngularSpring.H.

Constructor & Destructor Documentation

linearAxialAngularSpring()

linearAxialAngularSpring	(	const word &	name,
		const dictionary &	dict,
		const rigidBodyModel &	model )

Construct from components.

Definition at line 49 of file linearAxialAngularSpring.C.

References dict, restraint::name(), read(), and restraint::restraint().

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

Member Function Documentation

TypeName()

TypeName

(

"linearAxialAngularSpring"

)

Runtime type information.

References dict, and restraint::name().

Here is the call graph for this function:

clone()

virtual autoPtr< restraint > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements restraint.

Definition at line 103 of file linearAxialAngularSpring.H.

References linearAxialAngularSpring().

Here is the call graph for this function:

restrain()

void restrain ( scalarField & tau, Field< spatialVector > & fx, const rigidBodyModelState & state ) const

virtual

Accumulate the restraint internal joint forces into the tau field and.

external forces into the fx field

Implements restraint.

Definition at line 70 of file linearAxialAngularSpring.C.

References Foam::acos(), restraint::bodyID_, restraint::bodyIndex_, Foam::endl(), Foam::Info, Foam::mag(), Foam::min(), restraint::model_, Foam::rotationTensor(), Foam::sign(), and Foam::Zero.

Here is the call graph for this function:

read()

bool read ( const dictionary & dict )

virtual

Update properties from given dictionary.

Reimplemented from restraint.

Definition at line 137 of file linearAxialAngularSpring.C.

References Foam::abort(), restraint::coeffs_, dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::I, Foam::mag(), Foam::nl, restraint::read(), 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 restraint.

Definition at line 177 of file linearAxialAngularSpring.C.

References os(), and restraint::write().

Here is the call graph for this function:

---

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

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