Public Member Functions | Static Public Member Functions | List of all members
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...

Inheritance diagram for cylindrical:
[legend]
Collaboration diagram for cylindrical:
[legend]

Public Member Functions

 TypeNameNoDebug ("cylindrical")
 Runtime type information. More...
 
 cylindrical ()=default
 Default construct - an identity transform. More...
 
 cylindrical (const cylindrical &crot)
 Copy construct. More...
 
 cylindrical (const vector &axis)
 
 cylindrical (const dictionary &dict)
 Construct from dictionary. More...
 
autoPtr< coordinateRotation > clone () const
 Return clone. More...
 
virtual ~cylindrical ()=default
 Destructor. 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 axes
 TypeNameNoDebug ("axes")
 Runtime type information. More...
 
 axes ()
 Default construct - an identity transform. More...
 
 axes (const axes &crot)
 Copy construct. More...
 
 axes (const vector &axis1, const vector &axis2, axisOrder order=E3_E1)
 Construct from two axes. More...
 
 axes (const vector &axis)
 
 axes (const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~axes ()=default
 Destructor. More...
 
virtual void clear ()
 Reset specification. More...
 
virtual tensor R () const
 The rotation tensor calculated from the specified axes and order. More...
 
- Public Member Functions inherited from coordinateRotation
 TypeNameNoDebug ("coordinateRotation")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
 
virtual ~coordinateRotation ()=default
 Destructor. More...
 

Static Public Member Functions

static tensor rotation (const vector &axis)
 The rotation tensor calculated from axes and order. More...
 
- 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. More...
 
- Static Public Member Functions inherited from coordinateRotation
static autoPtr< coordinateRotation > New (const dictionary &dict)
 Select constructed from dictionary. More...
 

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. More...
 
- Static Protected Member Functions inherited from coordinateRotation
static vector findOrthogonal (const vector &axis)
 Determine best-guess for an orthogonal axis. More...
 
- Protected Attributes inherited from axes
vector axis1_
 The primary axis. More...
 
vector axis2_
 The secondary axis. More...
 
axisOrder order_
 The axis order. More...
 

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 Required Default
type Type name: cylindrical yes
axis The z-axis yes
e3 Alias for 'axis' no
Source files

Definition at line 83 of file cylindricalRotation.H.

Constructor & Destructor Documentation

◆ cylindrical() [1/4]

cylindrical ( )
default

Default construct - an identity transform.

◆ cylindrical() [2/4]

cylindrical ( const cylindrical &  crot)

Copy construct.

Definition at line 62 of file cylindricalRotation.C.

◆ cylindrical() [3/4]

cylindrical ( const vector &  axis)
explicit

Construct from single axis (as e3) using best-guess for the second axis.

Definition at line 68 of file cylindricalRotation.C.

◆ cylindrical() [4/4]

cylindrical ( const dictionary &  dict)
explicit

Construct from dictionary.

Definition at line 74 of file cylindricalRotation.C.

◆ ~cylindrical()

virtual ~cylindrical ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "cylindrical"  )

Runtime type information.

◆ clone()

autoPtr<coordinateRotation> clone ( ) const
inlinevirtual

Return clone.

Reimplemented from axes.

Definition at line 109 of file cylindricalRotation.H.

◆ 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 51 of file cylindricalRotation.C.

References Foam::Zero.

◆ write()

void write ( Ostream &  os) const
virtual

Write information.

Reimplemented from axes.

Definition at line 82 of file cylindricalRotation.C.

References 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 89 of file cylindricalRotation.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: