null Class Reference

Null joint for the root-body. More...

#include <nullJoint.H>

Inheritance diagram for null:

Collaboration diagram for null:

Public Member Functions
	TypeName ("null")
	Runtime type information.
	null ()
	Construct for given model.
	null (const dictionary &dict)
	Construct for given model from dictionary.
virtual autoPtr< joint >	clone () const
	Clone this joint.
virtual	~null ()
	Destructor.
virtual void	jcalc (joint::XSvc &J, const scalarField &q, const scalarField &qDot) const
	Update the model state for this joint.
Public Member Functions inherited from joint
	TypeName ("joint")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, joint, dictionary,(const dictionary &dict),(dict))
	joint (const label nDoF)
	Construct joint setting the size of the motion sub-space.
virtual	~joint ()
	Destructor.
label	nDoF () const
	Return the number of degrees of freedom in this joint.
virtual bool	unitQuaternion () const
	Return true if this joint describes rotation using a quaternion.
label	index () const
	Return the index of this joint in the model.
label	qIndex () const
	Return start index for the state variables for this joint.
const List< spatialVector > &	S () const
	Return the joint motion sub-space.
virtual void	write (Ostream &) const
	Write.
quaternion	unitQuaternion (const scalarField &q) const
	Return the unit quaternion for this joint.
void	unitQuaternion (const quaternion &quat, scalarField &q) const
	Set the unit quaternion for this joint.

Additional Inherited Members
Static Public Member Functions inherited from joint
static autoPtr< joint >	New (joint *jointPtr)
	Simple selector to return an autoPtr<joint> of the given joint*.
static autoPtr< joint >	New (const dictionary &dict)
	Select from dictionary.
Protected Attributes inherited from joint
List< spatialVector >	S_
	Joint motion sub-space.
label	index_
	Index of this joint in the rigidBodyModel.
label	qIndex_
	Index of this joints data in the rigidBodyModel state.

Detailed Description

Null joint for the root-body.

Reference:

    Featherstone, R. (2008).
    Rigid body dynamics algorithms.
    Springer.
    Chapter 4.

Source files

• nullJoint.H
• nullJoint.C

Definition at line 61 of file nullJoint.H.

Constructor & Destructor Documentation

null() [1/2]

null

(

)

Construct for given model.

Definition at line 48 of file nullJoint.C.

References joint::joint().

Referenced by clone().

Here is the call graph for this function:

Here is the caller graph for this function:

null() [2/2]

null

(

const dictionary &

dict

)

Construct for given model from dictionary.

Definition at line 54 of file nullJoint.C.

References dict, and joint::joint().

Here is the call graph for this function:

~null()

~null ( )

virtual

Destructor.

Definition at line 68 of file nullJoint.C.

Member Function Documentation

TypeName()

TypeName

(

"null"

)

Runtime type information.

References dict.

clone()

Foam::autoPtr< Foam::RBD::joint > clone ( ) const

virtual

Clone this joint.

Implements joint.

Definition at line 60 of file nullJoint.C.

References null().

Here is the call graph for this function:

jcalc()

void jcalc ( joint::XSvc & J, const scalarField & q, const scalarField & qDot ) const

virtual

Update the model state for this joint.

Implements joint.

Definition at line 74 of file nullJoint.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

---

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

• src/rigidBodyDynamics/joints/null/nullJoint.H
• src/rigidBodyDynamics/joints/null/nullJoint.C