Linear axial angular spring restraint. More...

Inheritance diagram for linearAxialAngularSpring:

Collaboration diagram for linearAxialAngularSpring:

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

	linearAxialAngularSpring (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	~linearAxialAngularSpring ()
	Destructor. More...

virtual void	restrain (scalarField &tau, Field< spatialVector > &fx) 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	~restraint ()
	Destructor. More...

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

label	bodyID () const

const dictionary &	coeffDict () const
	Return access to coeffs. 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

Linear axial angular spring restraint.

Source files

Definition at line 52 of file linearAxialAngularSpring.H.

Constructor & Destructor Documentation

◆ linearAxialAngularSpring()

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

Construct from components.

Definition at line 54 of file linearAxialAngularSpring.C.

References Foam::read().

Referenced by linearAxialAngularSpring::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~linearAxialAngularSpring()

~linearAxialAngularSpring ( )

virtual

Destructor.

Definition at line 68 of file linearAxialAngularSpring.C.

References linearAxialAngularSpring::restrain().

Referenced by linearAxialAngularSpring::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "linearAxialAngularSpring" )

Runtime type information.

◆ clone()

virtual autoPtr<restraint> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements restraint.

Definition at line 88 of file linearAxialAngularSpring.H.

References linearAxialAngularSpring::linearAxialAngularSpring(), linearAxialAngularSpring::read(), linearAxialAngularSpring::restrain(), linearAxialAngularSpring::write(), and linearAxialAngularSpring::~linearAxialAngularSpring().

Here is the call graph for this function:

◆ restrain()

void restrain	(	scalarField &	tau,
		Field< spatialVector > &	fx
	)		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 linearAxialAngularSpring.C.

References Foam::acos(), Foam::endl(), Foam::Info, Foam::mag(), Foam::min(), linearAxialAngularSpring::read(), Foam::rotationTensor(), Foam::sign(), Field< Type >::T(), and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Update properties from given dictionary.

Reimplemented from restraint.

Definition at line 141 of file linearAxialAngularSpring.C.

References Foam::abort(), Foam::e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::I, Foam::mag(), Foam::nl, restraint::read(), Foam::sqrt(), and linearAxialAngularSpring::write().

Referenced by linearAxialAngularSpring::clone(), and linearAxialAngularSpring::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 restraint.

Definition at line 181 of file linearAxialAngularSpring.C.

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

Referenced by linearAxialAngularSpring::clone(), and linearAxialAngularSpring::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/rigidBodyDynamics/restraints/linearAxialAngularSpring/linearAxialAngularSpring.H
src/rigidBodyDynamics/restraints/linearAxialAngularSpring/linearAxialAngularSpring.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ linearAxialAngularSpring()

◆ ~linearAxialAngularSpring()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ restrain()

◆ read()

◆ write()