externalForce Class Reference

Time-dependent external force restraint using Function1. More...

Inheritance diagram for externalForce:
Collaboration diagram for externalForce:

Public Member Functions

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

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. 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 rigidBodyModelmodel_
 Reference to the model. More...
 

Detailed Description

Time-dependent external force restraint using Function1.

Usage
Example applying a constant force to the floatingObject:
restraints
{
    force
    {
        type        externalForce;
        body        floatingObject;
        location    (0 0 0);
        force       (100 0 0);
    }
}
Source files

Definition at line 68 of file externalForce.H.

Constructor & Destructor Documentation

◆ externalForce()

externalForce ( const word name,
const dictionary dict,
const rigidBodyModel model 
)

Construct from components.

Definition at line 56 of file externalForce.C.

References Foam::read().

Referenced by externalForce::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~externalForce()

~externalForce ( )
virtual

Destructor.

Definition at line 71 of file externalForce.C.

References externalForce::restrain().

Referenced by externalForce::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "externalForce"  )

Runtime type information.

◆ clone()

virtual autoPtr<restraint> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements restraint.

Definition at line 98 of file externalForce.H.

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

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 78 of file externalForce.C.

References Foam::endl(), Foam::Info, externalForce::read(), and rigidBodyModelState::t().

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

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 101 of file externalForce.C.

References Function1< Type >::New(), restraint::read(), and externalForce::write().

Referenced by externalForce::clone(), and externalForce::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 116 of file externalForce.C.

References restraint::write(), and Foam::writeEntry().

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