Loading...
Searching...
No Matches
coordinateRotation Class Referenceabstract

User specification of a coordinate rotation. More...

#include <coordinateRotation.H>

Inheritance diagram for coordinateRotation:
Inheritance graph
[legend]

Public Member Functions

 TypeNameNoDebug ("coordinateRotation")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
virtual autoPtr< coordinateRotation > clone () const =0
 Return a clone.
virtual ~coordinateRotation ()=default
 Destructor.
virtual void clear ()=0
 Reset specification.
virtual tensor R () const =0
 Calculate and return the rotation tensor.
virtual void write (Ostream &os) const =0
 Write information.
virtual void writeEntry (const word &keyword, Ostream &os) const =0
 Write dictionary entry.

Static Public Member Functions

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).

Static Protected Member Functions

static vector findOrthogonal (const vector &axis)
 Determine best-guess for an orthogonal axis.

Detailed Description

User specification of a coordinate rotation. 

rotation
{
    type    axes
    e1      (1 0 0);
    e2      (0 1 0);
}

Types of coordinateRotations:

  1. none
  2. axes
  3. axisAngle
  4. cylindrical
  5. euler
  6. starcd
Source files

Definition at line 76 of file coordinateRotation.H.

Constructor & Destructor Documentation

◆ ~coordinateRotation()

virtual ~coordinateRotation ( )
virtualdefault

Destructor.

Member Function Documentation

◆ findOrthogonal()

Foam::vector findOrthogonal ( const vector & axis)
staticprotected

Determine best-guess for an orthogonal axis.

Definition at line 37 of file coordinateRotation.C.

References VectorSpace< Form, Cmpt, Ncmpts >::component(), Foam::mag(), VectorSpace< Form, Cmpt, Ncmpts >::nComponents, and Foam::Zero.

Referenced by axes::rotation().

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

◆ TypeNameNoDebug()

TypeNameNoDebug ( "coordinateRotation" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
coordinateRotation ,
dictionary ,
(const dictionary &dict) ,
(dict)  )

References dict.

◆ clone()

virtual autoPtr< coordinateRotation > clone ( ) const
pure virtual

Return a clone.

Implemented in axes, axisAngle, cylindrical, euler, identity, specified, and starcd.

◆ Clone()

template<class Derived>
autoPtr< coordinateRotation > Clone ( const Derived & crot)
inlinestatic

Clone a coordinate rotation.

Definition at line 124 of file coordinateRotation.H.

Referenced by axes::clone(), axisAngle::clone(), cylindrical::clone(), euler::clone(), identity::clone(), specified::clone(), and starcd::clone().

Here is the caller graph for this function:

◆ New() [1/2]

Foam::autoPtr< Foam::coordinateRotation > New ( const word & modelType,
const dictionary & dict )
static

Select construct the specified coordinate rotation type.

An empty modelType will be treated as "axes" (eg, e1/e3)

Definition at line 65 of file coordinateRotation.C.

References dict, Foam::exit(), Foam::FatalIOError, and FatalIOErrorInLookup.

Referenced by coordinateSystem::assign(), and New().

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

◆ New() [2/2]

Foam::autoPtr< Foam::coordinateRotation > New ( const dictionary & dict)
static

Select construct from dictionary (requires the "type" entry).

Definition at line 97 of file coordinateRotation.C.

References dict, and New().

Here is the call graph for this function:

◆ clear()

virtual void clear ( )
pure virtual

Reset specification.

Implemented in axes, axisAngle, euler, identity, specified, and starcd.

◆ R()

virtual tensor R ( ) const
pure virtual

Calculate and return the rotation tensor.

Implemented in axes, axisAngle, euler, identity, specified, and starcd.

◆ write()

virtual void write ( Ostream & os) const
pure virtual

Write information.

Implemented in axes, axisAngle, cylindrical, euler, identity, specified, and starcd.

References os().

Here is the call graph for this function:

◆ writeEntry()

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

Write dictionary entry.

Implemented in axes, axisAngle, cylindrical, euler, identity, specified, and starcd.

References os().

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