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...

#include <forces/sixDoFRigidBodyMotionState.H>

---

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

• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionState.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionStateI.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionState.C
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionStateIO.C

Definition at line 67 of file sixDoFRigidBodyMotionState.H.

Collaboration diagram for sixDoFRigidBodyMotionState:

List of all members.

Public Member Functions
	sixDoFRigidBodyMotionState ()
	Construct null.
	sixDoFRigidBodyMotionState (const point &centreOfMass, const tensor &Q, const vector &v, const vector &a, const vector &pi, const vector &tau)
	Construct from components.
	sixDoFRigidBodyMotionState (const dictionary &dict)
	Construct from dictionary.
	sixDoFRigidBodyMotionState (const sixDoFRigidBodyMotionState &)
	Construct as copy.
	~sixDoFRigidBodyMotionState ()
	Destructor.
const point &	centreOfMass () const
	Return access to the centre of mass.
const tensor &	Q () const
	Return access to the orientation.
const vector &	v () const
	Return access to velocity.
const vector &	a () const
	Return access to acceleration.
const vector &	pi () const
	Return access to angular momentum.
const vector &	tau () const
	Return access to torque.
point &	centreOfMass ()
	Return non-const access to the centre of mass.
tensor &	Q ()
	Return non-const access to the orientation.
vector &	v ()
	Return non-const access to vector.
vector &	a ()
	Return non-const access to acceleration.
vector &	pi ()
	Return non-const access to angular momentum.
vector &	tau ()
	Return non-const access to torque.
void	write (Ostream &) const
	Write.
Friends
Istream &	operator>> (Istream &, sixDoFRigidBodyMotionState &)
Ostream &	operator<< (Ostream &, const sixDoFRigidBodyMotionState &)

---

Constructor & Destructor Documentation

sixDoFRigidBodyMotionState

(

)

Construct null.

Definition at line 30 of file sixDoFRigidBodyMotionState.C.

sixDoFRigidBodyMotionState	(	const point &	centreOfMass,
		const tensor &	Q,
		const vector &	v,
		const vector &	a,
		const vector &	pi,
		const vector &	tau
	)

Construct from components.

Definition at line 42 of file sixDoFRigidBodyMotionState.C.

sixDoFRigidBodyMotionState

(

const dictionary &

dict  )

Construct from dictionary.

Definition at line 61 of file sixDoFRigidBodyMotionState.C.

sixDoFRigidBodyMotionState

(

const sixDoFRigidBodyMotionState &

sDoFRBMS  )

Construct as copy.

Definition at line 75 of file sixDoFRigidBodyMotionState.C.

~sixDoFRigidBodyMotionState

(

)

Destructor.

Definition at line 90 of file sixDoFRigidBodyMotionState.C.

---

Member Function Documentation

const Foam::point & centreOfMass

(

)

const [inline]

Return access to the centre of mass.

Definition at line 29 of file sixDoFRigidBodyMotionStateI.H.

const Foam::tensor & Q

(

)

const [inline]

Return access to the orientation.

Definition at line 35 of file sixDoFRigidBodyMotionStateI.H.

const Foam::vector & v

(

)

const [inline]

Return access to velocity.

Definition at line 41 of file sixDoFRigidBodyMotionStateI.H.

const Foam::vector & a

(

)

const [inline]

Return access to acceleration.

Definition at line 47 of file sixDoFRigidBodyMotionStateI.H.

const Foam::vector & pi

(

)

const [inline]

Return access to angular momentum.

Definition at line 53 of file sixDoFRigidBodyMotionStateI.H.

const Foam::vector & tau

(

)

const [inline]

Return access to torque.

Definition at line 59 of file sixDoFRigidBodyMotionStateI.H.

Foam::point & centreOfMass

(

)

[inline]

Return non-const access to the centre of mass.

Definition at line 65 of file sixDoFRigidBodyMotionStateI.H.

Foam::tensor & Q

(

)

[inline]

Return non-const access to the orientation.

Definition at line 71 of file sixDoFRigidBodyMotionStateI.H.

Foam::vector & v

(

)

[inline]

Return non-const access to vector.

Definition at line 77 of file sixDoFRigidBodyMotionStateI.H.

Foam::vector & a

(

)

[inline]

Return non-const access to acceleration.

Definition at line 83 of file sixDoFRigidBodyMotionStateI.H.

Foam::vector & pi

(

)

[inline]

Return non-const access to angular momentum.

Definition at line 89 of file sixDoFRigidBodyMotionStateI.H.

Foam::vector & tau

(

)

[inline]

Return non-const access to torque.

Definition at line 95 of file sixDoFRigidBodyMotionStateI.H.

void write

(

Ostream &

os  )

const

Write.

Definition at line 31 of file sixDoFRigidBodyMotionStateIO.C.

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

Referenced by sixDoFRigidBodyMotion::write().

---

Friends And Related Function Documentation

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

Ostream& operator<<	(	Ostream &	,
		const sixDoFRigidBodyMotionState &
	)		[friend]

---

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

• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionState.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionState.C
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionStateI.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionStateIO.C