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 scalarFieldq () const
 Return access to the joint position and orientation. More...
 
const scalarFieldqDot () const
 Return access to the joint velocity. More...
 
const scalarFieldqDdot () 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...
 
scalarFieldq ()
 Return access to the joint position and orientation. More...
 
scalarFieldqDot ()
 Return access to the joint velocity. More...
 
scalarFieldqDdot ()
 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

Istreamoperator>> (Istream &, rigidBodyModelState &)
 
Ostreamoperator<< (Ostream &, const rigidBodyModelState &)
 

Detailed Description

Holds the motion state of rigid-body model.

Source files

Definition at line 65 of file rigidBodyModelState.H.

Constructor & Destructor Documentation

◆ rigidBodyModelState() [1/2]

rigidBodyModelState ( const rigidBodyModel model)

Construct for the given rigidBodyModel.

Definition at line 31 of file rigidBodyModelState.C.

◆ rigidBodyModelState() [2/2]

rigidBodyModelState ( const rigidBodyModel model,
const dictionary dict 
)

Construct from dictionary for the given rigidBodyModel.

Definition at line 44 of file rigidBodyModelState.C.

Member Function Documentation

◆ q() [1/2]

const Foam::scalarField & q ( ) const
inline

Return access to the joint position and orientation.

Definition at line 28 of file rigidBodyModelStateI.H.

Referenced by rigidBodyModel::forwardDynamics(), Pxyz::jcalc(), Rx::jcalc(), Ra::jcalc(), Py::jcalc(), Rz::jcalc(), Ry::jcalc(), Pa::jcalc(), Pz::jcalc(), Px::jcalc(), Ryxz::jcalc(), Rzyx::jcalc(), Rxyz::jcalc(), Rs::jcalc(), function::jcalc(), rigidBodySolver::q(), and rigidBodySolver::q0().

Here is the caller graph for this function:

◆ qDot() [1/2]

const Foam::scalarField & qDot ( ) const
inline

◆ qDdot() [1/2]

const Foam::scalarField & qDdot ( ) const
inline

Return access to the joint acceleration.

Definition at line 40 of file rigidBodyModelStateI.H.

Referenced by rigidBodyMotion::forwardDynamics(), rigidBodyModel::forwardDynamics(), rigidBodyModel::forwardDynamicsCorrection(), functionDot::jcalc(), function::jcalc(), rigidBodySolver::qDdot(), and rigidBodySolver::qDdot0().

Here is the caller graph for this function:

◆ t() [1/2]

Foam::scalar t ( ) const
inline

Return access to the time.

Definition at line 46 of file rigidBodyModelStateI.H.

Referenced by rigidBodyMotion::solve().

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 52 of file rigidBodyModelStateI.H.

Referenced by rigidBodySolver::deltaT(), rigidBodySolver::deltaT0(), and rigidBodyMotion::solve().

Here is the caller graph for this function:

◆ q() [2/2]

Foam::scalarField & q ( )
inline

Return access to the joint position and orientation.

Definition at line 58 of file rigidBodyModelStateI.H.

◆ qDot() [2/2]

Foam::scalarField & qDot ( )
inline

Return access to the joint velocity.

Definition at line 64 of file rigidBodyModelStateI.H.

◆ qDdot() [2/2]

Foam::scalarField & qDdot ( )
inline

Return access to the joint acceleration.

Definition at line 70 of file rigidBodyModelStateI.H.

◆ t() [2/2]

Foam::scalar & t ( )
inline

Return access to the time.

Definition at line 82 of file rigidBodyModelStateI.H.

◆ deltaT() [2/2]

Foam::scalar & deltaT ( )
inline

Return access to the time-step.

Definition at line 76 of file rigidBodyModelStateI.H.

◆ write() [1/2]

void write ( dictionary dict) const

Write to dictionary.

Definition at line 31 of file rigidBodyModelStateIO.C.

References dictionary::add().

Referenced by rigidBodyMeshMotionSolver::writeObject().

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

◆ write() [2/2]

void write ( Ostream os) const

Write to stream.

Definition at line 41 of file rigidBodyModelStateIO.C.

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

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: