STARCDCoordinateRotation Class Reference

A coordinateRotation defined by the STAR-CD convention. More...

Inheritance diagram for STARCDCoordinateRotation:
Collaboration diagram for STARCDCoordinateRotation:

Public Member Functions

 TypeName ("STARCDRotation")
 Runtime type information. More...
 
 STARCDCoordinateRotation (const dictionary &)
 Construct from dictionary. More...
 
 STARCDCoordinateRotation (const dictionary &, const UList< vector > &points)
 Construct from dictionary and list of points. More...
 
virtual autoPtr< coordinateRotationclone () const
 Construct and return a clone. More...
 
virtual void updatePoints (const UList< vector > &points)
 Update the rotation for a list of points. More...
 
virtual const tensorR () const
 Return local-to-global transformation tensor. More...
 
virtual const vector e1 () const
 Return local Cartesian x-axis in global coordinates. More...
 
virtual const vector e2 () const
 Return local Cartesian y-axis in global coordinates. More...
 
virtual const vector e3 () const
 Return local Cartesian z-axis in global coordinates. More...
 
virtual tmp< vectorFieldtransform (const vectorField &vf) const
 Transform vectorField using transformation tensor field. More...
 
virtual vector transform (const vector &v) const
 Transform vector using transformation tensor. More...
 
virtual tmp< vectorFieldinvTransform (const vectorField &vf) const
 Inverse transform vectorField using transformation tensor field. More...
 
virtual vector invTransform (const vector &v) const
 Inverse transform vector using transformation tensor. More...
 
virtual tmp< tensorFieldtransform (const tensorField &tf) const
 Transform tensor field using transformation tensorField. More...
 
virtual tensor transform (const vector &p, const tensor &t) const
 Transform tensor using transformation tensorField. More...
 
virtual symmTensor transformDiagTensor (const vector &p, const vector &v) const
 Transform diagTensor masquerading as a vector using transformation. More...
 
virtual tmp< symmTensorFieldtransformDiagTensor (const vectorField &vf) const
 Transform diagTensorField masquerading as a vectorField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from coordinateRotation
 TypeName ("coordinateRotation")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
 
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, points,(const dictionary &dict, const UList< vector > &points),(dict, points))
 
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< coordinateRotationNew (const dictionary &dict, const UList< vector > &points)
 Select constructed from dictionary and list of points. More...
 
static autoPtr< coordinateRotationNew (const dictionary &dict)
 Select constructed from dictionary. More...
 
- Protected Member Functions inherited from coordinateRotation
symmTensor transformVectorDiagTensor (const tensor &, const vector &) const
 Transform the vector as if it is a diagonal tensor. More...
 

Detailed Description

A coordinateRotation defined by the STAR-CD convention.

The 3 rotations are defined in the STAR-CD convention (around Z, around X' and around Y''). The order of the parameter arguments matches this rotation order.

  • the rotation angles are in degrees, unless otherwise explicitly specified:
coordinateRotation
{
    type        STARCDRotation;
    degrees     false;
    rotation    (0 0 3.141592654);
}
Source files

Definition at line 63 of file STARCDCoordinateRotation.H.

Constructor & Destructor Documentation

◆ STARCDCoordinateRotation() [1/2]

Construct from dictionary.

Definition at line 83 of file STARCDCoordinateRotation.C.

References VectorSpace< Form, Cmpt, Ncmpts >::component(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::unitDegrees, Vector< scalar >::X, Vector< scalar >::Y, and Vector< scalar >::Z.

Referenced by STARCDCoordinateRotation::clone().

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

◆ STARCDCoordinateRotation() [2/2]

STARCDCoordinateRotation ( const dictionary dict,
const UList< vector > &  points 
)

Construct from dictionary and list of points.

Definition at line 111 of file STARCDCoordinateRotation.C.

Member Function Documentation

◆ TypeName()

TypeName ( "STARCDRotation"  )

Runtime type information.

◆ clone()

virtual autoPtr<coordinateRotation> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements coordinateRotation.

Definition at line 107 of file STARCDCoordinateRotation.H.

References STARCDCoordinateRotation::STARCDCoordinateRotation().

Here is the call graph for this function:

◆ updatePoints()

virtual void updatePoints ( const UList< vector > &  points)
inlinevirtual

Update the rotation for a list of points.

Implements coordinateRotation.

Definition at line 119 of file STARCDCoordinateRotation.H.

◆ R()

virtual const tensor& R ( ) const
inlinevirtual

Return local-to-global transformation tensor.

Implements coordinateRotation.

Definition at line 123 of file STARCDCoordinateRotation.H.

◆ e1()

virtual const vector e1 ( ) const
inlinevirtual

Return local Cartesian x-axis in global coordinates.

Implements coordinateRotation.

Definition at line 129 of file STARCDCoordinateRotation.H.

References Tensor< Cmpt >::x().

Here is the call graph for this function:

◆ e2()

virtual const vector e2 ( ) const
inlinevirtual

Return local Cartesian y-axis in global coordinates.

Implements coordinateRotation.

Definition at line 135 of file STARCDCoordinateRotation.H.

References Tensor< Cmpt >::y().

Here is the call graph for this function:

◆ e3()

virtual const vector e3 ( ) const
inlinevirtual

Return local Cartesian z-axis in global coordinates.

Implements coordinateRotation.

Definition at line 141 of file STARCDCoordinateRotation.H.

References Tensor< Cmpt >::z().

Here is the call graph for this function:

◆ transform() [1/4]

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

Transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 135 of file STARCDCoordinateRotation.C.

References NotImplemented.

◆ transform() [2/4]

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

Transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 123 of file STARCDCoordinateRotation.C.

◆ invTransform() [1/2]

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

Inverse transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 145 of file STARCDCoordinateRotation.C.

References NotImplemented.

◆ invTransform() [2/2]

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

Inverse transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 129 of file STARCDCoordinateRotation.C.

◆ transform() [3/4]

Foam::tmp< Foam::tensorField > transform ( const tensorField tf) const
virtual

Transform tensor field using transformation tensorField.

Implements coordinateRotation.

Definition at line 155 of file STARCDCoordinateRotation.C.

References NotImplemented.

◆ transform() [4/4]

Foam::tensor transform ( const vector p,
const tensor t 
) const
virtual

Transform tensor using transformation tensorField.

Implements coordinateRotation.

Definition at line 165 of file STARCDCoordinateRotation.C.

◆ transformDiagTensor() [1/2]

Foam::symmTensor transformDiagTensor ( const vector p,
const vector v 
) const
virtual

Transform diagTensor masquerading as a vector using transformation.

tensor and return symmTensor

Implements coordinateRotation.

Definition at line 192 of file STARCDCoordinateRotation.C.

◆ transformDiagTensor() [2/2]

Foam::tmp< Foam::symmTensorField > transformDiagTensor ( const vectorField vf) const
virtual

Transform diagTensorField masquerading as a vectorField.

using transformation tensorField and return symmTensorField

Implements coordinateRotation.

Definition at line 175 of file STARCDCoordinateRotation.C.

References fld(), forAll, tmp< T >::ref(), and List< T >::size().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Implements coordinateRotation.

Definition at line 202 of file STARCDCoordinateRotation.C.

References Foam::writeEntry().

Here is the call graph for this function:

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