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

Inheritance diagram for prescribedRotation:

Collaboration diagram for prescribedRotation:

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

	prescribedRotation (const word &name, const dictionary &dict, const rigidBodyModel &model)
	Construct from components. More...

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

virtual	~prescribedRotation ()
	Destructor. More...

virtual void	restrain (scalarField &tau, Field< spatialVector > &fx, const rigidBodyModelState &state) const
	Accumulate the retraint internal joint forces into the tau field and. More...

virtual bool	read (const dictionary &dict)
	Update properties from given dictionary. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from restraint
	TypeName ("restraint")
	Runtime type information. More...

	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. More...

virtual autoPtr< restraint >	clone () const =0
	Construct and return a clone. More...

virtual	~restraint ()
	Destructor. More...

const word &	name () const
	Return the name. More...

label	bodyID () const

virtual void	restrain (scalarField &tau, Field< spatialVector > &fx, const rigidBodyModelState &state) const =0
	Accumulate the restraint internal joint forces into the tau field and. More...

virtual bool	read (const dictionary &dict)
	Update properties from given dictionary. More...

const dictionary &	coeffDict () const
	Return access to coeffs. More...

virtual void	write (Ostream &) const =0
	Write. More...

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. More...

Protected Member Functions inherited from restraint
point	bodyPoint (const point &p) const
	Transform the given point on the restrained body to the global frame. More...

spatialVector	bodyPointVelocity (const point &p) const
	Transform the velocity of the given point on the restrained body. More...

Protected Attributes inherited from restraint
word	name_
	Name of the restraint. More...

label	bodyID_
	ID of the body the restraint is applied to. More...

label	bodyIndex_
	Index of the body the force is applied to. More...

dictionary	coeffs_
	Restraint model specific coefficient dictionary. More...

const rigidBodyModel &	model_
	Reference to the model. More...

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

Definition at line 112 of file prescribedRotation.H.

Constructor & Destructor Documentation

◆ prescribedRotation()

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

Construct from components.

Definition at line 56 of file prescribedRotation.C.

References dict, Foam::name(), and prescribedRotation::read().

Here is the call graph for this function:

◆ ~prescribedRotation()

~prescribedRotation ( )

virtual

Destructor.

Definition at line 76 of file prescribedRotation.C.

Member Function Documentation

◆ TypeName()

TypeName ( "prescribedRotation" )

Runtime type information.

◆ clone()

virtual autoPtr< restraint > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements restraint.

Definition at line 165 of file prescribedRotation.H.

◆ 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 82 of file prescribedRotation.C.

References Foam::acos(), Foam::endl(), Foam::Info, Foam::mag(), Foam::min(), Foam::rotationTensor(), Foam::sign(), Field< Type >::T(), 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 170 of file prescribedRotation.C.

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

Referenced by prescribedRotation::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 216 of file prescribedRotation.C.

References os(), and ObukhovLength::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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ prescribedRotation()

◆ ~prescribedRotation()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ restrain()

◆ read()

◆ write()