Base class for defining restraints for rigid-body dynamics. More...

Inheritance diagram for restraint:

Collaboration diagram for restraint:

Public Member Functions
	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...

Static Public Member Functions
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
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
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

Base class for defining restraints for rigid-body dynamics.

Source files

Definition at line 68 of file rigidBodyRestraint.H.

Constructor & Destructor Documentation

◆ restraint()

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

Construct from the dict dictionary and Time.

Definition at line 46 of file rigidBodyRestraint.C.

◆ ~restraint()

~restraint ( )

virtual

Destructor.

Definition at line 62 of file rigidBodyRestraint.C.

Member Function Documentation

◆ bodyPoint()

Foam::point bodyPoint ( const point & p ) const

inlineprotected

Transform the given point on the restrained body to the global frame.

Definition at line 33 of file rigidBodyRestraintI.H.

References p, and Foam::Zero.

◆ bodyPointVelocity()

Foam::spatialVector bodyPointVelocity ( const point & p ) const

inlineprotected

Transform the velocity of the given point on the restrained body.

to the global frame

Definition at line 42 of file rigidBodyRestraintI.H.

References p.

◆ TypeName()

TypeName ( "restraint" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		restraint	,
		dictionary	,
		(const word &name, const dictionary &dict, const rigidBodyModel &model)	,
		(name, dict, model)
	)

◆ clone()

virtual autoPtr<restraint> clone ( ) const

pure virtual

Construct and return a clone.

Implemented in prescribedRotation, externalForce, softWall, linearSpring, linearAxialAngularSpring, sphericalAngularDamper, and linearDamper.

◆ New()

Foam::autoPtr< Foam::RBD::restraint > New	(	const word &	name,
		const dictionary &	dict,
		const rigidBodyModel &	model
	)

static

Select constructed from the dict dictionary and Time.

Definition at line 35 of file rigidBodyRestraintNew.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::name().

Here is the call graph for this function:

◆ name()

const word& name ( ) const

inline

Return the name.

Definition at line 152 of file rigidBodyRestraint.H.

References restraint::name_.

◆ bodyID()

label bodyID ( ) const

inline

Definition at line 157 of file rigidBodyRestraint.H.

References restraint::bodyID_.

◆ restrain()

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

pure virtual

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

external forces into the fx field

Implemented in prescribedRotation, externalForce, softWall, linearSpring, linearAxialAngularSpring, sphericalAngularDamper, and linearDamper.

◆ read()

bool read ( const dictionary & dict )

virtual

Update properties from given dictionary.

Reimplemented in prescribedRotation, externalForce, softWall, linearSpring, linearAxialAngularSpring, sphericalAngularDamper, and linearDamper.

Definition at line 74 of file rigidBodyRestraint.C.

References dict.

Referenced by linearDamper::read(), sphericalAngularDamper::read(), linearAxialAngularSpring::read(), linearSpring::read(), externalForce::read(), softWall::read(), and prescribedRotation::read().

Here is the caller graph for this function:

◆ coeffDict()

const Foam::dictionary & coeffDict ( ) const

Return access to coeffs.

Definition at line 68 of file rigidBodyRestraint.C.

◆ write()

void write ( Ostream & os ) const

pure virtual

Write.

Implemented in prescribedRotation, externalForce, softWall, linearSpring, linearAxialAngularSpring, sphericalAngularDamper, and linearDamper.

Definition at line 81 of file rigidBodyRestraint.C.

References os(), and Foam::type().

Referenced by linearDamper::write(), sphericalAngularDamper::write(), linearAxialAngularSpring::write(), linearSpring::write(), externalForce::write(), softWall::write(), and prescribedRotation::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_

protected

Name of the restraint.

Definition at line 76 of file rigidBodyRestraint.H.

Referenced by restraint::name().

◆ bodyID_

label bodyID_

protected

ID of the body the restraint is applied to.

Definition at line 79 of file rigidBodyRestraint.H.

Referenced by restraint::bodyID().

◆ bodyIndex_

label bodyIndex_

protected

Index of the body the force is applied to.

Definition at line 82 of file rigidBodyRestraint.H.

◆ coeffs_

dictionary coeffs_

protected

Restraint model specific coefficient dictionary.

Definition at line 85 of file rigidBodyRestraint.H.

◆ model_

const rigidBodyModel& model_

protected

Reference to the model.

Definition at line 88 of file rigidBodyRestraint.H.

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

src/rigidBodyDynamics/restraints/restraint/rigidBodyRestraint.H
src/rigidBodyDynamics/restraints/restraint/rigidBodyRestraint.C
src/rigidBodyDynamics/restraints/restraint/rigidBodyRestraintI.H
src/rigidBodyDynamics/restraints/restraint/rigidBodyRestraintNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ restraint()

◆ ~restraint()

Member Function Documentation

◆ bodyPoint()

◆ bodyPointVelocity()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ name()

◆ bodyID()

◆ restrain()

◆ read()

◆ coeffDict()

◆ write()

Member Data Documentation

◆ name_

◆ bodyID_

◆ bodyIndex_

◆ coeffs_

◆ model_