A coordinateRotation defined by the STAR-CD convention. More...
Public Member Functions | |
TypeNameNoDebug ("starcd") | |
Runtime type information. More... | |
starcd () | |
Default construct - an identity transform. More... | |
starcd (const starcd &crot) | |
Copy construct. More... | |
starcd (const vector &rotZrotXrotY, bool degrees) | |
Construct from rotation vector. More... | |
starcd (scalar rotZ, scalar rotX, scalar rotY, bool degrees) | |
Construct from components of rotation vector. More... | |
starcd (const dictionary &dict) | |
Construct from dictionary. More... | |
autoPtr< coordinateRotation > | clone () const |
Return clone. More... | |
virtual | ~starcd ()=default |
Destructor. More... | |
virtual void | clear () |
Reset specification. More... | |
virtual tensor | R () const |
The rotation tensor calculated for the specified STARCD angles. More... | |
virtual void | write (Ostream &os) const |
Write information. More... | |
virtual void | writeEntry (const word &keyword, Ostream &os) const |
Write dictionary entry. More... | |
Public Member Functions inherited from coordinateRotation | |
TypeNameNoDebug ("coordinateRotation") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict)) | |
virtual autoPtr< coordinateRotation > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~coordinateRotation ()=default |
Destructor. More... | |
virtual void | clear ()=0 |
Reset specification. More... | |
virtual tensor | R () const =0 |
Calculate and return the rotation tensor. More... | |
virtual void | write (Ostream &os) const =0 |
Write information. More... | |
virtual void | writeEntry (const word &keyword, Ostream &os) const =0 |
Write dictionary entry. More... | |
Static Public Member Functions | |
static tensor | rotation (const vector &angles, bool degrees) |
Static Public Member Functions inherited from coordinateRotation | |
static autoPtr< coordinateRotation > | New (word modelType, const dictionary &dict) |
Select construct the specified coordinate rotation type. More... | |
static autoPtr< coordinateRotation > | New (const dictionary &dict) |
Select construct from dictionary (requires the "type" entry) More... | |
Additional Inherited Members | |
Static Protected Member Functions inherited from coordinateRotation | |
static vector | findOrthogonal (const vector &axis) |
Determine best-guess for an orthogonal axis. More... | |
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.
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 |
Definition at line 98 of file STARCDCoordinateRotation.H.
starcd | ( | ) |
Default construct - an identity transform.
Definition at line 80 of file STARCDCoordinateRotation.C.
Copy construct.
Definition at line 88 of file STARCDCoordinateRotation.C.
Construct from rotation vector.
Definition at line 96 of file STARCDCoordinateRotation.C.
Construct from components of rotation vector.
Definition at line 108 of file STARCDCoordinateRotation.C.
|
explicit |
Construct from dictionary.
Definition at line 122 of file STARCDCoordinateRotation.C.
|
virtualdefault |
Destructor.
TypeNameNoDebug | ( | "starcd" | ) |
Runtime type information.
|
inlinevirtual |
Return clone.
Implements coordinateRotation.
Definition at line 135 of file STARCDCoordinateRotation.H.
|
static |
Rotation tensor calculated for the specified STARCD angles interpreted as rotate-Z, rotate-X, rotate-Y
Definition at line 68 of file STARCDCoordinateRotation.C.
References coordinateSystem::rotation().
|
virtual |
Reset specification.
Implements coordinateRotation.
Definition at line 132 of file STARCDCoordinateRotation.C.
References Foam::Zero.
|
virtual |
The rotation tensor calculated for the specified STARCD angles.
Implements coordinateRotation.
Definition at line 139 of file STARCDCoordinateRotation.C.
References coordinateSystem::rotation().
|
virtual |
Write information.
Implements coordinateRotation.
Definition at line 145 of file STARCDCoordinateRotation.C.
References os().
Write dictionary entry.
Implements coordinateRotation.
Definition at line 151 of file STARCDCoordinateRotation.C.
References os(), and Foam::type().