Loading...
Searching...
No Matches
cylindrical Class Reference

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>

Inheritance diagram for cylindrical:
Collaboration diagram for cylindrical:

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< coordinateRotationclone () 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< coordinateRotationClone (const Derived &crot)
 Clone a coordinate rotation.
static autoPtr< coordinateRotationNew (const word &modelType, const dictionary &dict)
 Select construct the specified coordinate rotation type.
static autoPtr< coordinateRotationNew (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.

Detailed Description

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
Source files

Definition at line 79 of file cylindricalRotation.H.

Constructor & Destructor Documentation

◆ cylindrical() [1/4]

cylindrical ( )
default

Default construct - an identity transform.

References cylindrical(), and dict.

Referenced by cylindrical(), cylindrical(), and cylindrical().

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

◆ cylindrical() [2/4]

cylindrical ( const cylindrical & crot)

Copy construct.

Definition at line 57 of file cylindricalRotation.C.

References axes::axes(), and cylindrical().

Here is the call graph for this function:

◆ cylindrical() [3/4]

cylindrical ( const vector & axis)
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().

Here is the call graph for this function:

◆ cylindrical() [4/4]

cylindrical ( const dictionary & dict)
explicit

Construct from dictionary.

Definition at line 69 of file cylindricalRotation.C.

References cylindrical(), and dict.

Here is the call graph for this function:

◆ ~cylindrical()

virtual ~cylindrical ( )
virtualdefault

Destructor.

References os().

Here is the call graph for this function:

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "cylindrical" )

Runtime type information.

◆ clone()

autoPtr< coordinateRotation > clone ( ) const
inlinevirtual

Return clone.

Reimplemented from axes.

Definition at line 117 of file cylindricalRotation.H.

References coordinateRotation::Clone().

Here is the call graph for this function:

◆ rotation()

Foam::tensor rotation ( const vector & axis)
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.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write information.

Reimplemented from axes.

Definition at line 77 of file cylindricalRotation.C.

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

Here is the call graph for this function:

◆ writeEntry()

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

Write dictionary entry.

Reimplemented from axes.

Definition at line 83 of file cylindricalRotation.C.

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

Here is the call graph for this function:

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