Loading...
Searching...
No Matches
Pxyz Class Reference

Prismatic joint for translation in the x/y/z directions. More...

#include <Pxyz.H>

Inheritance diagram for Pxyz:
Collaboration diagram for Pxyz:

Public Member Functions

 TypeName ("Pxyz")
 Runtime type information.
 Pxyz ()
 Construct for given model.
 Pxyz (const dictionary &dict)
 Construct for given model from dictionary.
virtual autoPtr< jointclone () const
 Clone this joint.
virtual ~Pxyz ()
 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< jointNew (joint *jointPtr)
 Simple selector to return an autoPtr<joint> of the given joint*.
static autoPtr< jointNew (const dictionary &dict)
 Select from dictionary.
Protected Attributes inherited from joint
List< spatialVectorS_
 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

Prismatic joint for translation in the x/y/z directions.

Reference:

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

Definition at line 61 of file Pxyz.H.

Constructor & Destructor Documentation

◆ Pxyz() [1/2]

Pxyz ( )

Construct for given model.

Definition at line 48 of file Pxyz.C.

References joint::joint(), and joint::S_.

Referenced by clone().

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

◆ Pxyz() [2/2]

Pxyz ( const dictionary & dict)

Construct for given model from dictionary.

Definition at line 58 of file Pxyz.C.

References dict, joint::joint(), and joint::S_.

Here is the call graph for this function:

◆ ~Pxyz()

~Pxyz ( )
virtual

Destructor.

Definition at line 76 of file Pxyz.C.

Member Function Documentation

◆ TypeName()

TypeName ( "Pxyz" )

Runtime type information.

References dict.

◆ clone()

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

Clone this joint.

Implements joint.

Definition at line 68 of file Pxyz.C.

References Pxyz().

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 82 of file Pxyz.C.

References Field< Type >::block(), joint::XSvc::c, spatialTransform::E(), Tensor< scalar >::I, joint::qIndex_, spatialTransform::r(), joint::XSvc::S, joint::XSvc::v, joint::XSvc::X, and Foam::Zero.

Here is the call graph for this function:

The documentation for this class was generated from the following files:
  • src/rigidBodyDynamics/joints/Pxyz/Pxyz.H
  • src/rigidBodyDynamics/joints/Pxyz/Pxyz.C