A special purpose coordinateRotation that is generally for use in combination with a cylindricalCS when only the orientation of the local Z-axis is relevant. More...
#include <cylindricalRotation.H>


Public Member Functions | |
| TypeNameNoDebug ("cylindrical") | |
| Runtime type information. | |
| cylindrical ()=default | |
| Default construct - an identity transform. | |
| cylindrical (const cylindrical &crot) | |
| Copy construct. | |
| cylindrical (const vector &axis) | |
| Construct from single axis (as e3) using best-guess for the second axis. | |
| cylindrical (const dictionary &dict) | |
| Construct from dictionary. | |
| autoPtr< coordinateRotation > | clone () const |
| Return clone. | |
| virtual | ~cylindrical ()=default |
| Destructor. | |
| 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 axes | |
| TypeNameNoDebug ("axes") | |
| Runtime type information. | |
| axes () | |
| Default construct - an identity transform. | |
| axes (const axes &crot) | |
| Copy construct. | |
| axes (const vector &axis1, const vector &axis2, axisOrder order=E3_E1) | |
| Construct from two axes. | |
| axes (const vector &axis) | |
| Construct from a single axis (as e3) using a best-guess for the second axis. | |
| axes (const dictionary &dict) | |
| Construct from dictionary. | |
| virtual | ~axes ()=default |
| Destructor. | |
| virtual void | clear () |
| Reset specification. | |
| virtual tensor | R () const |
| The rotation tensor calculated from the specified axes and order. | |
| 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 &axis) |
| The rotation tensor calculated from axes and order. | |
| Static Public Member Functions inherited from axes | |
| static tensor | rotation (const vector &axis1, const vector &axis2, axisOrder order=E3_E1) |
| The rotation tensor calculated from two axes and their order. | |
| 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 | |
| Public Types inherited from axes | |
| enum | axisOrder { E1_E2 , E2_E3 , E3_E1 , E3_E1_COMPAT } |
| The order/combination of local axes for the axes-rotation definition. More... | |
| Protected Member Functions inherited from axes | |
| void | read (const dictionary &dict) |
| Read from dictionary. | |
| Static Protected Member Functions inherited from coordinateRotation | |
| static vector | findOrthogonal (const vector &axis) |
| Determine best-guess for an orthogonal axis. | |
| Protected Attributes inherited from axes | |
| vector | axis1_ |
| The primary axis. | |
| vector | axis2_ |
| The secondary axis. | |
| axisOrder | order_ |
| The axis order. | |
A special purpose coordinateRotation that is generally for use in combination with a cylindricalCS when only the orientation of the local Z-axis is relevant.
Dictionary entries
| Property | Description | Reqd | Default |
|---|---|---|---|
type | Type name: cylindrical | yes | |
axis | The z-axis | yes | |
e3 | Alias for 'axis' | no |
Definition at line 79 of file cylindricalRotation.H.
|
default |
Default construct - an identity transform.
References cylindrical(), and dict.
Referenced by cylindrical(), cylindrical(), and cylindrical().


| cylindrical | ( | const cylindrical & | crot | ) |
Copy construct.
Definition at line 57 of file cylindricalRotation.C.
References axes::axes(), and cylindrical().

|
explicit |
Construct from single axis (as e3) using best-guess for the second axis.
Definition at line 63 of file cylindricalRotation.C.
References axes::axes().

|
explicit |
Construct from dictionary.
Definition at line 69 of file cylindricalRotation.C.
References cylindrical(), and dict.

|
virtualdefault |
| TypeNameNoDebug | ( | "cylindrical" | ) |
Runtime type information.
|
inlinevirtual |
Return clone.
Reimplemented from axes.
Definition at line 117 of file cylindricalRotation.H.
References coordinateRotation::Clone().

|
static |
The rotation tensor calculated from axes and order.
The input axes will be normalised.
Definition at line 45 of file cylindricalRotation.C.
References axes::E3_E1, axes::rotation(), and Foam::Zero.

|
virtual |
Write information.
Reimplemented from axes.
Definition at line 77 of file cylindricalRotation.C.
References axes::axis1_, os(), and Foam::type().

Write dictionary entry.
Reimplemented from axes.
Definition at line 83 of file cylindricalRotation.C.
References axes::axis1_, os(), and Foam::type().
