Classes | Public Member Functions | Friends | List of all members
spatialTransform Class Reference

Compact representation of the Plücker spatial transformation tensor in terms of the rotation tensor E and translation vector r . More...

Classes

class  dual
 Wrapper-class to provide dual functions and operators. More...
 
class  transpose
 Wrapper-class to provide transpose functions and operators. More...
 

Public Member Functions

 spatialTransform ()
 Construct null. More...
 
 spatialTransform (const tensor &E, const vector &r)
 Construct from components. More...
 
 spatialTransform (Istream &)
 Construct from Istream. More...
 
const tensor & E () const
 Return the rotation tensor. More...
 
tensor & E ()
 Return non-const access to the rotation tensor. More...
 
const vector & r () const
 Return the translation vector. More...
 
vector & r ()
 Return non-const access to the translation vector. More...
 
transpose T () const
 Return the transpose transformation tensor ^A{X^*}_B. More...
 
spatialTransform inv () const
 Return the inverse transformation tensor: X^-1. More...
 
dual operator* () const
 Return the dual transformation tensor ^B{X^*}_A. More...
 
 operator spatialTensor () const
 Return transformation tensor ^BX_A. More...
 
void operator&= (const spatialTransform &X)
 Inner-product multiply with a transformation tensor. More...
 
spatialTransform operator& (const spatialTransform &X) const
 Return the inner-product of two transformation tensors. More...
 
spatialVector operator& (const spatialVector &v) const
 Transform v: ^BX_A . v. More...
 
vector transformPoint (const vector &p) const
 Transform position p. More...
 
spatialVector operator&& (const spatialVector &v) const
 Transform position p. More...
 

Friends

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

Detailed Description

Compact representation of the Plücker spatial transformation tensor in terms of the rotation tensor E and translation vector r .

See Chapter 2 and Appendix A in reference: 

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

Definition at line 68 of file spatialTransform.H.

Constructor & Destructor Documentation

◆ spatialTransform() [1/3]

spatialTransform ( )
inline

Construct null.

Definition at line 38 of file spatialTransformI.H.

Referenced by spatialTransform::inv(), spatialTransform::operator&(), and Foam::Xt().

Here is the caller graph for this function:

◆ spatialTransform() [2/3]

spatialTransform ( const tensor &  E,
const vector &  r 
)
inline

Construct from components.

Definition at line 45 of file spatialTransformI.H.

◆ spatialTransform() [3/3]

spatialTransform ( Istream &  is)
inline

Construct from Istream.

Definition at line 56 of file spatialTransformI.H.

Member Function Documentation

◆ E() [1/2]

const Foam::tensor & E ( ) const
inline

Return the rotation tensor.

Definition at line 77 of file spatialTransformI.H.

Referenced by Pxyz::jcalc(), Rs::jcalc(), Rxyz::jcalc(), Ryxz::jcalc(), Rzyx::jcalc(), Foam::operator>>(), rigidBodyMotion::status(), Foam::RBD::transform(), and rigidBodyState::write().

Here is the caller graph for this function:

◆ E() [2/2]

Foam::tensor & E ( )
inline

Return non-const access to the rotation tensor.

Definition at line 82 of file spatialTransformI.H.

◆ r() [1/2]

const Foam::vector & r ( ) const
inline

Return the translation vector.

Definition at line 87 of file spatialTransformI.H.

Referenced by rigidBodyForces::CofR(), Pxyz::jcalc(), Rs::jcalc(), Rxyz::jcalc(), Ryxz::jcalc(), Rzyx::jcalc(), Foam::operator>>(), rigidBodyMotion::status(), Foam::RBD::transform(), rigidBodyState::write(), and Foam::Xt().

Here is the caller graph for this function:

◆ r() [2/2]

Foam::vector & r ( )
inline

Return non-const access to the translation vector.

Definition at line 92 of file spatialTransformI.H.

◆ T()

Foam::spatialTransform::transpose T ( ) const
inline

Return the transpose transformation tensor ^A{X^*}_B.

X^T

Definition at line 98 of file spatialTransformI.H.

◆ inv()

Foam::spatialTransform inv ( ) const
inline

Return the inverse transformation tensor: X^-1.

X^-1 = (E^T, −E.r)

Definition at line 104 of file spatialTransformI.H.

References spatialTransform::spatialTransform(), and Tensor< Cmpt >::T().

Here is the call graph for this function:

◆ operator*()

Foam::spatialTransform::dual operator* ( ) const
inline

Return the dual transformation tensor ^B{X^*}_A.

Definition at line 112 of file spatialTransformI.H.

◆ operator spatialTensor()

operator spatialTensor ( ) const
inline

Return transformation tensor ^BX_A.

X

Definition at line 118 of file spatialTransformI.H.

References Foam::Zero.

◆ operator&=()

void operator&= ( const spatialTransform &  X)
inline

Inner-product multiply with a transformation tensor.

Definition at line 128 of file spatialTransformI.H.

◆ operator&() [1/2]

Foam::spatialTransform operator& ( const spatialTransform &  X) const
inline

Return the inner-product of two transformation tensors.

Definition at line 135 of file spatialTransformI.H.

References spatialTransform::spatialTransform().

Here is the call graph for this function:

◆ operator&() [2/2]

Foam::spatialVector operator& ( const spatialVector &  v) const
inline

Transform v: ^BX_A . v.

X.v = (E . vw, E . (vl - r^vw))

Definition at line 144 of file spatialTransformI.H.

◆ transformPoint()

Foam::vector transformPoint ( const vector &  p) const
inline

Transform position p.

X:p = E . (pl - r)

Definition at line 170 of file spatialTransformI.H.

References p.

◆ operator&&()

Foam::spatialVector operator&& ( const spatialVector &  v) const
inline

Transform position p.

X:p = (E . pw, E . (vl - r))

Definition at line 157 of file spatialTransformI.H.

Friends And Related Function Documentation

◆ operator>>

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

◆ operator<<

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