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

Holds the motion state of sixDoF object. Wrapped up together to allow rapid scatter to other processors. The processors must all maintain exactly the same state data to avoid any drift or inconsistency. More...

Public Member Functions

 sixDoFRigidBodyMotionState ()
 Default construct, zero-initialized with identity transformation. More...
 
 sixDoFRigidBodyMotionState (const dictionary &dict)
 Construct from dictionary. More...
 
const point & centreOfRotation () const
 Return access to the centre of mass. More...
 
const tensor & Q () const
 Return access to the orientation. More...
 
const vector & v () const
 Return access to velocity. More...
 
const vector & a () const
 Return access to acceleration. More...
 
const vector & pi () const
 Return access to angular momentum. More...
 
const vector & tau () const
 Return access to torque. More...
 
point & centreOfRotation ()
 Return non-const access to the centre of mass. More...
 
tensor & Q ()
 Return non-const access to the orientation. More...
 
vector & v ()
 Return non-const access to vector. More...
 
vector & a ()
 Return non-const access to acceleration. More...
 
vector & pi ()
 Return non-const access to angular momentum. More...
 
vector & tau ()
 Return non-const access to torque. More...
 
void write (dictionary &dict) const
 Write to dictionary. More...
 
void write (Ostream &os) const
 Write to stream. More...
 

Friends

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

Detailed Description

Holds the motion state of sixDoF object. Wrapped up together to allow rapid scatter to other processors. The processors must all maintain exactly the same state data to avoid any drift or inconsistency.

Source files

Definition at line 67 of file sixDoFRigidBodyMotionState.H.

Constructor & Destructor Documentation

◆ sixDoFRigidBodyMotionState() [1/2]

sixDoFRigidBodyMotionState ( )

Default construct, zero-initialized with identity transformation.

Definition at line 33 of file sixDoFRigidBodyMotionState.C.

◆ sixDoFRigidBodyMotionState() [2/2]

sixDoFRigidBodyMotionState ( const dictionary &  dict)

Construct from dictionary.

Definition at line 44 of file sixDoFRigidBodyMotionState.C.

Member Function Documentation

◆ centreOfRotation() [1/2]

const Foam::point & centreOfRotation ( ) const
inline

Return access to the centre of mass.

Definition at line 31 of file sixDoFRigidBodyMotionStateI.H.

Referenced by sixDoFSolver::centreOfRotation(), and sixDoFRigidBodyMotion::sixDoFRigidBodyMotion().

Here is the caller graph for this function:

◆ Q() [1/2]

const Foam::tensor & Q ( ) const
inline

Return access to the orientation.

Definition at line 37 of file sixDoFRigidBodyMotionStateI.H.

◆ v() [1/2]

const Foam::vector & v ( ) const
inline

Return access to velocity.

Definition at line 43 of file sixDoFRigidBodyMotionStateI.H.

◆ a() [1/2]

const Foam::vector & a ( ) const
inline

Return access to acceleration.

Definition at line 49 of file sixDoFRigidBodyMotionStateI.H.

◆ pi() [1/2]

const Foam::vector & pi ( ) const
inline

Return access to angular momentum.

Definition at line 55 of file sixDoFRigidBodyMotionStateI.H.

◆ tau() [1/2]

const Foam::vector & tau ( ) const
inline

Return access to torque.

Definition at line 61 of file sixDoFRigidBodyMotionStateI.H.

◆ centreOfRotation() [2/2]

Foam::point & centreOfRotation ( )
inline

Return non-const access to the centre of mass.

Definition at line 67 of file sixDoFRigidBodyMotionStateI.H.

◆ Q() [2/2]

Foam::tensor & Q ( )
inline

Return non-const access to the orientation.

Definition at line 73 of file sixDoFRigidBodyMotionStateI.H.

◆ v() [2/2]

Foam::vector & v ( )
inline

Return non-const access to vector.

Definition at line 79 of file sixDoFRigidBodyMotionStateI.H.

◆ a() [2/2]

Foam::vector & a ( )
inline

Return non-const access to acceleration.

Definition at line 85 of file sixDoFRigidBodyMotionStateI.H.

◆ pi() [2/2]

Foam::vector & pi ( )
inline

Return non-const access to angular momentum.

Definition at line 91 of file sixDoFRigidBodyMotionStateI.H.

◆ tau() [2/2]

Foam::vector & tau ( )
inline

Return non-const access to torque.

Definition at line 97 of file sixDoFRigidBodyMotionStateI.H.

◆ write() [1/2]

void write ( dictionary &  dict) const

Write to dictionary.

Definition at line 33 of file sixDoFRigidBodyMotionStateIO.C.

References dictionary::add(), and dict.

Here is the call graph for this function:

◆ write() [2/2]

void write ( Ostream &  os) const

Write to stream.

Definition at line 44 of file sixDoFRigidBodyMotionStateIO.C.

References os(), and Ostream::writeEntry().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator>>

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

◆ operator<<

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