Loading...
Searching...
No Matches
starcd Class Reference

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

#include <STARCDCoordinateRotation.H>

Inheritance diagram for starcd:
Inheritance graph
[legend]
Collaboration diagram for starcd:
Collaboration graph
[legend]

Public Member Functions

 TypeNameNoDebug ("starcd")
 Runtime type information.
 starcd ()
 Default construct - an identity transform.
 starcd (const starcd &crot)
 Copy construct.
 starcd (const vector &rotZrotXrotY, bool degrees)
 Construct from rotation vector.
 starcd (scalar rotZ, scalar rotX, scalar rotY, bool degrees)
 Construct from components of rotation vector.
 starcd (const dictionary &dict)
 Construct from dictionary.
autoPtr< coordinateRotation > clone () const
 Return clone.
virtual ~starcd ()=default
 Destructor.
virtual void clear ()
 Reset specification.
virtual tensor R () const
 The rotation tensor calculated for the specified STARCD angles.
virtual void write (Ostream &os) const
 Write information.
virtual void writeEntry (const word &keyword, Ostream &os) const
 Write dictionary entry.
Public Member Functions inherited from coordinateRotation
 TypeNameNoDebug ("coordinateRotation")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
virtual ~coordinateRotation ()=default
 Destructor.

Static Public Member Functions

static tensor rotation (const vector &angles, bool degrees)
 Rotation tensor calculated for the specified STARCD angles interpreted as rotate-Z, rotate-X, rotate-Y.
Static Public Member Functions inherited from coordinateRotation
template<class Derived>
static autoPtr< coordinateRotation > Clone (const Derived &crot)
 Clone a coordinate rotation.
static autoPtr< coordinateRotation > New (const word &modelType, const dictionary &dict)
 Select construct the specified coordinate rotation type.
static autoPtr< coordinateRotation > New (const dictionary &dict)
 Select construct from dictionary (requires the "type" entry).

Additional Inherited Members

Static Protected Member Functions inherited from coordinateRotation
static vector findOrthogonal (const vector &axis)
 Determine best-guess for an orthogonal axis.

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:
rotation
{
    type    starcd;
    angles  (0 0 180);
}


Dictionary entries

Property Description Reqd Default
type Type name: starcd yes
angles The z-x-y rotation angles yes
degrees Angles are in degrees no true
Note
Also accepts "STARCDRotation" (OpenFOAM-v1806) for the type.
Source files

Definition at line 94 of file STARCDCoordinateRotation.H.

Constructor & Destructor Documentation

◆ starcd() [1/5]

starcd ( )

Default construct - an identity transform.

Definition at line 73 of file STARCDCoordinateRotation.C.

References Foam::Zero.

Referenced by starcd(), and TypeNameNoDebug().

Here is the caller graph for this function:

◆ starcd() [2/5]

starcd ( const starcd & crot)

Copy construct.

Definition at line 81 of file STARCDCoordinateRotation.C.

References starcd().

Here is the call graph for this function:

◆ starcd() [3/5]

starcd ( const vector & rotZrotXrotY,
bool degrees )

Construct from rotation vector.

Definition at line 89 of file STARCDCoordinateRotation.C.

◆ starcd() [4/5]

starcd ( scalar rotZ,
scalar rotX,
scalar rotY,
bool degrees )

Construct from components of rotation vector.

Definition at line 101 of file STARCDCoordinateRotation.C.

◆ starcd() [5/5]

starcd ( const dictionary & dict)
explicit

Construct from dictionary.

Definition at line 115 of file STARCDCoordinateRotation.C.

References dict.

◆ ~starcd()

virtual ~starcd ( )
virtualdefault

Destructor.

References os().

Here is the call graph for this function:

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "starcd" )

Runtime type information.

References dict, and starcd().

Here is the call graph for this function:

◆ clone()

autoPtr< coordinateRotation > clone ( ) const
inlinevirtual

Return clone.

Implements coordinateRotation.

Definition at line 149 of file STARCDCoordinateRotation.H.

References coordinateRotation::Clone().

Here is the call graph for this function:

◆ rotation()

Foam::tensor rotation ( const vector & angles,
bool degrees )
static

Rotation tensor calculated for the specified STARCD angles interpreted as rotate-Z, rotate-X, rotate-Y.

Definition at line 61 of file STARCDCoordinateRotation.C.

References euler::rotation().

Referenced by R().

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

◆ clear()

void clear ( )
virtual

Reset specification.

Implements coordinateRotation.

Definition at line 125 of file STARCDCoordinateRotation.C.

References Foam::Zero.

◆ R()

Foam::tensor R ( ) const
virtual

The rotation tensor calculated for the specified STARCD angles.

Implements coordinateRotation.

Definition at line 132 of file STARCDCoordinateRotation.C.

References rotation().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write information.

Implements coordinateRotation.

Definition at line 138 of file STARCDCoordinateRotation.C.

References os().

Here is the call graph for this function:

◆ writeEntry()

void writeEntry ( const word & keyword,
Ostream & os ) const
virtual

Write dictionary entry.

Implements coordinateRotation.

Definition at line 144 of file STARCDCoordinateRotation.C.

References os(), and Foam::type().

Here is the call graph for this function:
The documentation for this class was generated from the following files: