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 quaternion. More...
const scalarField &	qDdot () const
	Return access to the joint acceleration. 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 quaternion. More...
scalarField &	qDdot ()
	Return access to the joint acceleration. 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

• rigidBodyModelState.H
• rigidBodyModelStateI.H
• rigidBodyModelState.C
• rigidBodyModelStateIO.C

Definition at line 65 of file rigidBodyModelState.H.

Constructor & Destructor Documentation

rigidBodyModelState

(

const rigidBodyModel &

model

)

Construct for the given rigidBodyModel.

Definition at line 31 of file rigidBodyModelState.C.

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

Construct from dictionary for the given rigidBodyModel.

Definition at line 43 of file rigidBodyModelState.C.

Member Function Documentation

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(), rigidBodyModel::forwardDynamicsCorrection(), rigidBodySolver::q(), and rigidBodySolver::q0().

Here is the caller graph for this function:

const Foam::scalarField & qDot ( ) const

inline

Return access to the joint quaternion.

Return access to the joint velocity

Definition at line 34 of file rigidBodyModelStateI.H.

Referenced by rigidBodyModel::forwardDynamics(), rigidBodyModel::forwardDynamicsCorrection(), rigidBodySolver::qDot(), and rigidBodySolver::qDot0().

Here is the caller graph for this function:

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(), rigidBodySolver::qDdot(), and rigidBodySolver::qDdot0().

Here is the caller graph for this function:

Foam::scalar deltaT ( ) const

inline

Return access to the time-step.

Definition at line 46 of file rigidBodyModelStateI.H.

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

Here is the caller graph for this function:

Foam::scalarField & q ( )

inline

Return access to the joint position and orientation.

Definition at line 52 of file rigidBodyModelStateI.H.

Foam::scalarField & qDot ( )

inline

Return access to the joint quaternion.

Return access to the joint velocity

Definition at line 58 of file rigidBodyModelStateI.H.

Foam::scalarField & qDdot ( )

inline

Return access to the joint acceleration.

Definition at line 64 of file rigidBodyModelStateI.H.

Foam::scalar & deltaT ( )

inline

Return access to the time-step.

Definition at line 70 of file rigidBodyModelStateI.H.

void write

(

dictionary &

dict

)

const

Write to dictionary.

Definition at line 31 of file rigidBodyModelStateIO.C.

References dictionary::add().

Here is the call graph for this function:

void write

(

Ostream &

os

)

const

Write to stream.

Definition at line 40 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

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

friend

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

friend

---

The documentation for this class was generated from the following files:

• src/rigidBodyDynamics/rigidBodyModelState/rigidBodyModelState.H
• src/rigidBodyDynamics/rigidBodyModelState/rigidBodyModelState.C
• src/rigidBodyDynamics/rigidBodyModelState/rigidBodyModelStateI.H
• src/rigidBodyDynamics/rigidBodyModelState/rigidBodyModelStateIO.C