FreeFOAM The Cross-Platform CFD Toolkit
STARCDCoordinateRotation Class Reference

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

#include <meshTools/STARCDCoordinateRotation.H>


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 explictly specified:
coordinateRotation
{
typeSTARCDRotation;
degrees false;
rotation(0 0 3.141592654);
}

Definition at line 61 of file STARCDCoordinateRotation.H.

+ Inheritance diagram for STARCDCoordinateRotation:
+ Collaboration diagram for STARCDCoordinateRotation:

List of all members.

Public Member Functions

 TypeName ("STARCDRotation")
 Runtime type information.
 STARCDCoordinateRotation ()
 Construct null.
 STARCDCoordinateRotation (const vector &rotZrotXrotY, const bool inDegrees=true)
 Construct from rotation vector.
 STARCDCoordinateRotation (const scalar rotZ, const scalar rotX, const scalar rotY, const bool inDegrees=true)
 Construct from components of rotation vector.
 STARCDCoordinateRotation (const dictionary &)
 Construct from dictionary.
- Public Member Functions inherited from coordinateRotation
 TypeName ("coordinateRotation")
 Runtime type information.
 coordinateRotation ()
 Construct null.
 coordinateRotation (const vector &axis, const vector &dir)
 Construct from 2 axes.
 coordinateRotation (const dictionary &)
 Construct from dictionary.
autoPtr< coordinateRotationclone () const
 Return clone.
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
virtual ~coordinateRotation ()
const tensorR () const
 Return local-to-global transformation tensor.
const vector e1 () const
 Return local Cartesian x-axis.
const vector e2 () const
 Return local Cartesian y-axis.
const vector e3 () const
 Return local Cartesian z-axis.
void operator= (const dictionary &)
 assign from dictionary
- Public Member Functions inherited from Tensor< Cmpt >
 Tensor ()
 Construct null.
 Tensor (const VectorSpace< Tensor< Cmpt >, Cmpt, 9 > &)
 Construct given VectorSpace.
 Tensor (const SphericalTensor< Cmpt > &)
 Construct given SphericalTensor.
 Tensor (const SymmTensor< Cmpt > &)
 Construct given SymmTensor.
 Tensor (const Vector< Cmpt > &x, const Vector< Cmpt > &y, const Vector< Cmpt > &z)
 Construct given the three vectors.
 Tensor (const Cmpt txx, const Cmpt txy, const Cmpt txz, const Cmpt tyx, const Cmpt tyy, const Cmpt tyz, const Cmpt tzx, const Cmpt tzy, const Cmpt tzz)
 Construct given the nine components.
 Tensor (Istream &)
 Construct from Istream.
const Cmpt & xx () const
const Cmpt & xy () const
const Cmpt & xz () const
const Cmpt & yx () const
const Cmpt & yy () const
const Cmpt & yz () const
const Cmpt & zx () const
const Cmpt & zy () const
const Cmpt & zz () const
Cmpt & xx ()
Cmpt & xy ()
Cmpt & xz ()
Cmpt & yx ()
Cmpt & yy ()
Cmpt & yz ()
Cmpt & zx ()
Cmpt & zy ()
Cmpt & zz ()
const Vector< Cmpt > x () const
const Vector< Cmpt > y () const
const Vector< Cmpt > z () const
Tensor< Cmpt > T () const
 Transpose.
void operator= (const SphericalTensor< Cmpt > &)
 Assign to a SphericalTensor.
void operator= (const SymmTensor< Cmpt > &)
 Assign to a SymmTensor.
- Public Member Functions inherited from VectorSpace< Tensor< Cmpt >, Cmpt, 9 >
 VectorSpace ()
 Construct null.
 VectorSpace (Istream &)
 Construct from Istream.
 VectorSpace (const VectorSpace< Tensor< Cmpt >, Cmpt, nCmpt > &)
 Construct as copy.
label size () const
 Return the number of elements in the VectorSpace = nCmpt.
const Cmpt & component (const direction) const
Cmpt & component (const direction)
void component (Cmpt &, const direction) const
void replace (const direction, const Cmpt &)
const Cmpt & operator[] (const direction) const
Cmpt & operator[] (const direction)
void operator= (const VectorSpace< Tensor< Cmpt >, Cmpt, nCmpt > &)
void operator+= (const VectorSpace< Tensor< Cmpt >, Cmpt, nCmpt > &)
void operator-= (const VectorSpace< Tensor< Cmpt >, Cmpt, nCmpt > &)
void operator*= (const scalar)
void operator/= (const scalar)

Additional Inherited Members

- Static Public Member Functions inherited from coordinateRotation
static autoPtr
< coordinateRotation
New (const dictionary &dict)
 Select constructed from Istream.

Constructor & Destructor Documentation

Construct null.

Definition at line 89 of file STARCDCoordinateRotation.C.

STARCDCoordinateRotation ( const vector rotZrotXrotY,
const bool  inDegrees = true 
)
STARCDCoordinateRotation ( const scalar  rotZ,
const scalar  rotX,
const scalar  rotY,
const bool  inDegrees = true 
)

Construct from components of rotation vector.

Definition at line 114 of file STARCDCoordinateRotation.C.


Member Function Documentation

TypeName ( "STARCDRotation"  )

Runtime type information.


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