Loading...
Searching...
No Matches
linearSpring Class Reference

Linear spring restraint. More...

#include <linearSpring.H>

Inheritance diagram for linearSpring:
Collaboration diagram for linearSpring:

Public Member Functions

 TypeName ("linearSpring")
 Runtime type information.
 linearSpring (const word &name, const dictionary &dict, const rigidBodyModel &model)
 Construct from components.
virtual autoPtr< restraintclone () const
 Construct and return a clone.
virtual ~linearSpring ()
 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 wordname () const
 Return the name.
label bodyID () const
const dictionarycoeffDict () const
 Return access to coeffs.

Additional Inherited Members

Static Public Member Functions inherited from restraint
static autoPtr< restraintNew (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 rigidBodyModelmodel_
 Reference to the model.

Detailed Description

Linear spring restraint.

Source files

Definition at line 53 of file linearSpring.H.

Constructor & Destructor Documentation

◆ linearSpring()

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

Construct from components.

Definition at line 48 of file linearSpring.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:

◆ ~linearSpring()

~linearSpring ( )
virtual

Destructor.

Definition at line 63 of file linearSpring.C.

Member Function Documentation

◆ TypeName()

TypeName ( "linearSpring" )

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 110 of file linearSpring.H.

References linearSpring().

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 69 of file linearSpring.C.

References restraint::bodyIndex_, restraint::bodyPoint(), restraint::bodyPointVelocity(), Foam::endl(), Foam::Info, Foam::mag(), and restraint::model_.

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 109 of file linearSpring.C.

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

Referenced by linearSpring().

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 126 of file linearSpring.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: