coordinateRotation Class Reference

User specification of a coordinate rotation. More...

Inheritance diagram for coordinateRotation:

Public Member Functions
	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 autoPtr< coordinateRotation >	New (const 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...

Static Protected Member Functions
static vector	findOrthogonal (const vector &axis)
	Determine best-guess for an orthogonal axis. More...

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

• coordinateRotation.H
• coordinateRotation.C

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 Foam::mag(), and Foam::Zero.

Here is the call graph for this function:

TypeNameNoDebug()

TypeNameNoDebug

(

"coordinateRotation"

)

Runtime type information.

declareRunTimeSelectionTable()

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

clone()

virtual autoPtr<coordinateRotation> clone ( ) const

pure virtual

Construct and return a clone.

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

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 66 of file coordinateRotation.C.

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

Referenced by coordinateRotation::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 98 of file coordinateRotation.C.

References dict, dictionary::get(), and coordinateRotation::New().

Here is the call graph for this function:

clear()

virtual void clear ( )

pure virtual

Reset specification.

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

R()

virtual tensor R ( ) const

pure virtual

Calculate and return the rotation tensor.

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

Referenced by coordinateSystem::rotation().

Here is the caller graph for this function:

write()

virtual void write ( Ostream &  os ) const

pure virtual

Write information.

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

writeEntry()

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

pure virtual

Write dictionary entry.

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

---

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

• src/OpenFOAM/primitives/coordinate/rotation/coordinateRotation.H
• src/OpenFOAM/primitives/coordinate/rotation/coordinateRotation.C