prescribedRotation Class Reference

Restraint setting angular velocity of the rigid body. Developed from the linear axial angular spring restraint. More...

#include <prescribedRotation.H>

Inheritance diagram for prescribedRotation:

Collaboration diagram for prescribedRotation:

Public Member Functions
	TypeName ("prescribedRotation")
	Runtime type information.
	prescribedRotation (const word &name, const dictionary &dict, const rigidBodyModel &model)
	Construct from components.
virtual autoPtr< restraint >	clone () const
	Construct and return a clone.
virtual	~prescribedRotation ()
	Destructor.
virtual void	restrain (scalarField &tau, Field< spatialVector > &fx, const rigidBodyModelState &state) const
	Accumulate the retraint 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

Restraint setting angular velocity of the rigid body. Developed from the linear axial angular spring restraint.

Adds a rotation along given axis to the body. Used for a combination of 6DOF bodies where one is driven by 6DOF and the other attached to it using specified rotation in the local reference frame.

Usage

Property	Description	Required	Default value
referenceOrientation	Orientation	no	I
axis	Rotation axis (in reference)	yes
omega	Angular velocity (rad/s)	yes
relax	Relax moment with previous iter	yes
p	Propoptional corrector for PDI	yes
d	Differential corrector for PDI	yes
i	Integral corrector for PDI	yes

Source files

• prescribedRotation.H
• prescribedRotation.C

Definition at line 108 of file prescribedRotation.H.

Constructor & Destructor Documentation

prescribedRotation()

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

Construct from components.

Definition at line 49 of file prescribedRotation.C.

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

Referenced by clone().

Here is the call graph for this function:

Here is the caller graph for this function:

~prescribedRotation()

~prescribedRotation ( )

virtual

Destructor.

Definition at line 69 of file prescribedRotation.C.

Member Function Documentation

TypeName()

TypeName

(

"prescribedRotation"

)

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 181 of file prescribedRotation.H.

References prescribedRotation().

Here is the call graph for this function:

restrain()

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

virtual

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

external forces into the fx field

Implements restraint.

Definition at line 75 of file prescribedRotation.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 163 of file prescribedRotation.C.

References Foam::abort(), restraint::coeffs_, dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::I, Foam::mag(), restraint::model_, Foam::nl, restraint::read(), and Foam::sqrt().

Referenced by prescribedRotation().

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 209 of file prescribedRotation.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/prescribedRotation/prescribedRotation.H
• src/rigidBodyDynamics/restraints/prescribedRotation/prescribedRotation.C