axesRotation Class Reference

A coordinate rotation specified using global axis. More...

Inheritance diagram for axesRotation:
Collaboration diagram for axesRotation:

Public Member Functions

 TypeName ("axesRotation")
 Runtime type information. More...
 
 axesRotation ()
 Construct null. More...
 
 axesRotation (const vector &axis, const vector &dir)
 Construct from 2 axes. More...
 
 axesRotation (const dictionary &)
 Construct from dictionary. More...
 
 axesRotation (const tensor &R)
 Construct from components. More...
 
 axesRotation (const dictionary &, const objectRegistry &)
 Construct from dictionary and mesh. More...
 
autoPtr< axesRotationclone () const
 Return clone. More...
 
virtual ~axesRotation ()
 Destructor. More...
 
virtual void clear ()
 Reset rotation to an identity rotation. More...
 
virtual const tensorR () const
 Return local-to-global transformation tensor. More...
 
virtual const tensorRtr () const
 Return global-to-local transformation tensor. More...
 
virtual const vector e1 () const
 Return local Cartesian x-axis. More...
 
virtual const vector e2 () const
 Return local Cartesian y-axis. More...
 
virtual const vector e3 () const
 Return local Cartesian z-axis. More...
 
virtual const tensorFieldTr () const
 Return transformation tensor field. More...
 
virtual tmp< vectorFieldtransform (const vectorField &st) const
 Transform vectorField using transformation tensor field. More...
 
virtual vector transform (const vector &st) const
 Transform vector using transformation tensor. More...
 
virtual tmp< vectorFieldinvTransform (const vectorField &st) const
 Inverse transform vectorField using transformation tensor field. More...
 
virtual vector invTransform (const vector &st) const
 Inverse transform vector using transformation tensor. More...
 
virtual tmp< tensorFieldtransformTensor (const tensorField &st) const
 Transform tensor field using transformation tensorField. More...
 
virtual tensor transformTensor (const tensor &st) const
 Transform tensor using transformation tensorField. More...
 
virtual tmp< tensorFieldtransformTensor (const tensorField &st, const labelList &cellMap) const
 Transform tensor sub-field using transformation tensorField. More...
 
virtual tmp< symmTensorFieldtransformVector (const vectorField &st) const
 Transform vectorField using transformation tensorField and return. More...
 
virtual symmTensor transformVector (const vector &st) const
 Transform vector using transformation tensor and return. More...
 
void operator= (const dictionary &)
 assign from dictionary More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from coordinateRotation
 TypeName ("coordinateRotation")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, objectRegistry,(const dictionary &dict, const objectRegistry &obr),(dict, obr))
 
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
 
virtual ~coordinateRotation ()
 Destructor. More...
 
virtual bool uniform () const
 Return true if the rotation tensor is uniform. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from coordinateRotation
static autoPtr
< coordinateRotation
New (const dictionary &dict, const objectRegistry &obr)
 Select constructed from dictionary and objectRegistry. More...
 
static autoPtr
< coordinateRotation
New (const dictionary &dict)
 Select constructed from dictionary. More...
 
- Protected Member Functions inherited from coordinateRotation
symmTensor transformPrincipal (const tensor &, const vector &) const
 Transform principal. More...
 

Detailed Description

A coordinate rotation specified using global axis.

The rotation is defined by a combination of vectors (e1/e2), (e2/e3) or (e3/e1). Any nonorthogonality will be absorbed into the second vector.

    axesRotation
    {
        type        axesRotation;
        e1          (1 0 0);
        e2          (0 1 0);
    }

Definition at line 61 of file axesRotation.H.

Constructor & Destructor Documentation

Construct null.

Definition at line 103 of file axesRotation.C.

References axesRotation::axesRotation().

Referenced by axesRotation::axesRotation().

Here is the call graph for this function:

Here is the caller graph for this function:

axesRotation ( const vector axis,
const vector dir 
)

Construct from 2 axes.

Definition at line 111 of file axesRotation.C.

axesRotation ( const dictionary dict)

Construct from dictionary.

Definition at line 124 of file axesRotation.C.

axesRotation ( const tensor R)

Construct from components.

Definition at line 148 of file axesRotation.C.

References axesRotation::axesRotation().

Here is the call graph for this function:

axesRotation ( const dictionary dict,
const objectRegistry obr 
)

Construct from dictionary and mesh.

Definition at line 136 of file axesRotation.C.

virtual ~axesRotation ( )
inlinevirtual

Destructor.

Definition at line 125 of file axesRotation.H.

Member Function Documentation

TypeName ( "axesRotation"  )

Runtime type information.

autoPtr<axesRotation> clone ( ) const
inline

Return clone.

Definition at line 118 of file axesRotation.H.

References axesRotation::clone().

Referenced by axesRotation::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void clear ( )
inlinevirtual

Reset rotation to an identity rotation.

Implements coordinateRotation.

Definition at line 132 of file axesRotation.H.

References SphericalTensor< Cmpt >::I.

virtual const tensor& R ( ) const
inlinevirtual

Return local-to-global transformation tensor.

Implements coordinateRotation.

Definition at line 139 of file axesRotation.H.

virtual const tensor& Rtr ( ) const
inlinevirtual

Return global-to-local transformation tensor.

Implements coordinateRotation.

Definition at line 145 of file axesRotation.H.

References axesRotation::Rtr().

Referenced by axesRotation::Rtr().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const vector e1 ( ) const
inlinevirtual

Return local Cartesian x-axis.

Implements coordinateRotation.

Definition at line 151 of file axesRotation.H.

References axesRotation::e1().

Referenced by axesRotation::e1().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const vector e2 ( ) const
inlinevirtual

Return local Cartesian y-axis.

Implements coordinateRotation.

Definition at line 157 of file axesRotation.H.

References axesRotation::e2().

Referenced by axesRotation::e2().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const vector e3 ( ) const
inlinevirtual

Return local Cartesian z-axis.

Implements coordinateRotation.

Definition at line 163 of file axesRotation.H.

References axesRotation::e3().

Referenced by axesRotation::e3().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::tensorField & Tr ( ) const
virtual

Return transformation tensor field.

Implements coordinateRotation.

Definition at line 187 of file axesRotation.C.

References notImplemented, and axesRotation::Tr().

Referenced by axesRotation::Tr().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::tmp< Foam::vectorField > transform ( const vectorField st) const
virtual

Transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 170 of file axesRotation.C.

Foam::vector transform ( const vector st) const
virtual

Transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 157 of file axesRotation.C.

Foam::tmp< Foam::vectorField > invTransform ( const vectorField st) const
virtual

Inverse transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 179 of file axesRotation.C.

Referenced by axesRotation::invTransform().

Here is the caller graph for this function:

Foam::vector invTransform ( const vector st) const
virtual

Inverse transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 163 of file axesRotation.C.

References axesRotation::invTransform().

Here is the call graph for this function:

Foam::tmp< Foam::tensorField > transformTensor ( const tensorField st) const
virtual

Transform tensor field using transformation tensorField.

Implements coordinateRotation.

Definition at line 198 of file axesRotation.C.

References notImplemented.

Foam::tensor transformTensor ( const tensor st) const
virtual

Transform tensor using transformation tensorField.

Implements coordinateRotation.

Definition at line 211 of file axesRotation.C.

Foam::tmp< Foam::tensorField > transformTensor ( const tensorField st,
const labelList cellMap 
) const
virtual

Transform tensor sub-field using transformation tensorField.

Implements coordinateRotation.

Definition at line 220 of file axesRotation.C.

References notImplemented.

Foam::tmp< Foam::symmTensorField > transformVector ( const vectorField st) const
virtual

Transform vectorField using transformation tensorField and return.

symmetrical tensorField

Implements coordinateRotation.

Definition at line 236 of file axesRotation.C.

References fld(), and forAll.

Here is the call graph for this function:

Foam::symmTensor transformVector ( const vector st) const
virtual

Transform vector using transformation tensor and return.

symmetrical tensor

Implements coordinateRotation.

Definition at line 252 of file axesRotation.C.

void operator= ( const dictionary dict)

assign from dictionary

Definition at line 262 of file axesRotation.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::found(), dictionary::lookup(), axesRotation::operator=(), Foam::Pout, and dictionary::readIfPresent().

Referenced by axesRotation::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
virtual

Write.

Implements coordinateRotation.

Definition at line 306 of file axesRotation.C.

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

Here is the call graph for this function:


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