Public Member Functions | Friends | List of all members
rigidBodyModelState Class Reference

Holds the motion state of rigid-body model. More...

Public Member Functions

 rigidBodyModelState (const rigidBodyModel &model)
 Construct for the given rigidBodyModel. More...
 
 rigidBodyModelState (const rigidBodyModel &model, const dictionary &dict)
 Construct from dictionary for the given rigidBodyModel. More...
 
const scalarField & q () const
 Return access to the joint position and orientation. More...
 
const scalarField & qDot () const
 Return access to the joint velocity. More...
 
const scalarField & qDdot () const
 Return access to the joint acceleration. More...
 
scalar t () const
 Return access to the time. More...
 
scalar deltaT () const
 Return access to the time-step. More...
 
scalarField & q ()
 Return access to the joint position and orientation. More...
 
scalarField & qDot ()
 Return access to the joint velocity. More...
 
scalarField & qDdot ()
 Return access to the joint acceleration. More...
 
scalar & t ()
 Return access to the time. More...
 
scalar & deltaT ()
 Return access to the time-step. More...
 
void write (dictionary &dict) const
 Write to dictionary. More...
 
void write (Ostream &) const
 Write to stream. More...
 

Friends

Istream & operator>> (Istream &, rigidBodyModelState &)
 
Ostream & operator<< (Ostream &, const rigidBodyModelState &)
 

Detailed Description

Holds the motion state of rigid-body model.

Source files

Definition at line 67 of file rigidBodyModelState.H.

Constructor & Destructor Documentation

◆ rigidBodyModelState() [1/2]

rigidBodyModelState ( const rigidBodyModel &  model)

Construct for the given rigidBodyModel.

Definition at line 34 of file rigidBodyModelState.C.

◆ rigidBodyModelState() [2/2]

rigidBodyModelState ( const rigidBodyModel &  model,
const dictionary &  dict 
)

Construct from dictionary for the given rigidBodyModel.

Definition at line 47 of file rigidBodyModelState.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and rigidBodyModel::nDoF().

Here is the call graph for this function:

Member Function Documentation

◆ q() [1/2]

const Foam::scalarField & q ( ) const
inline

Return access to the joint position and orientation.

Definition at line 30 of file rigidBodyModelStateI.H.

Referenced by rigidBodyModel::forwardDynamics(), and rigidBodyModel::forwardDynamicsCorrection().

Here is the caller graph for this function:

◆ qDot() [1/2]

const Foam::scalarField & qDot ( ) const
inline

Return access to the joint velocity.

Definition at line 36 of file rigidBodyModelStateI.H.

Referenced by rigidBodyModel::forwardDynamics(), and rigidBodyModel::forwardDynamicsCorrection().

Here is the caller graph for this function:

◆ qDdot() [1/2]

const Foam::scalarField & qDdot ( ) const
inline

Return access to the joint acceleration.

Definition at line 42 of file rigidBodyModelStateI.H.

Referenced by rigidBodyMotion::forwardDynamics(), rigidBodyModel::forwardDynamics(), and rigidBodyModel::forwardDynamicsCorrection().

Here is the caller graph for this function:

◆ t() [1/2]

Foam::scalar t ( ) const
inline

Return access to the time.

Definition at line 48 of file rigidBodyModelStateI.H.

Referenced by externalForce::restrain().

Here is the caller graph for this function:

◆ deltaT() [1/2]

Foam::scalar deltaT ( ) const
inline

Return access to the time-step.

Definition at line 54 of file rigidBodyModelStateI.H.

◆ q() [2/2]

Foam::scalarField & q ( )
inline

Return access to the joint position and orientation.

Definition at line 60 of file rigidBodyModelStateI.H.

◆ qDot() [2/2]

Foam::scalarField & qDot ( )
inline

Return access to the joint velocity.

Definition at line 66 of file rigidBodyModelStateI.H.

◆ qDdot() [2/2]

Foam::scalarField & qDdot ( )
inline

Return access to the joint acceleration.

Definition at line 72 of file rigidBodyModelStateI.H.

◆ t() [2/2]

Foam::scalar & t ( )
inline

Return access to the time.

Definition at line 84 of file rigidBodyModelStateI.H.

◆ deltaT() [2/2]

Foam::scalar & deltaT ( )
inline

Return access to the time-step.

Definition at line 78 of file rigidBodyModelStateI.H.

◆ write() [1/2]

void write ( dictionary &  dict) const

Write to dictionary.

Definition at line 33 of file rigidBodyModelStateIO.C.

References dict.

◆ write() [2/2]

void write ( Ostream &  os) const

Write to stream.

Definition at line 43 of file rigidBodyModelStateIO.C.

References Ostream::writeEntry().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  ,
rigidBodyModelState &   
)
friend

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const rigidBodyModelState &   
)
friend
The documentation for this class was generated from the following files: