coordinateRotation Class Reference

User specification of a coordinate rotation. More...

Inheritance diagram for coordinateRotation:

Public Member Functions
	TypeNameNoDebug ("coordinateRotation")
	declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
virtual autoPtr< coordinateRotation >	clone () const =0
virtual	~coordinateRotation ()=default
virtual void	clear ()=0
virtual tensor	R () const =0
virtual void	write (Ostream &os) const =0
virtual void	writeEntry (const word &keyword, Ostream &os) const =0

Static Public Member Functions
static autoPtr< coordinateRotation >	New (const dictionary &dict)

Static Protected Member Functions
static vector	findOrthogonal (const vector &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

• coordinateRotation.H
• coordinateRotation.C

Definition at line 75 of file coordinateRotation.H.

Constructor & Destructor Documentation

~coordinateRotation()

virtual ~coordinateRotation ( )

virtualdefault

Member Function Documentation

findOrthogonal()

Foam::vector findOrthogonal ( const vector &  axis )

staticprotected

Definition at line 36 of file coordinateRotation.C.

References VectorSpace::component(), Foam::mag(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, and Foam::Zero.

Here is the call graph for this function:

TypeNameNoDebug()

TypeNameNoDebug

(

"coordinateRotation"

)

declareRunTimeSelectionTable()

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

clone()

virtual autoPtr<coordinateRotation> clone ( ) const

pure virtual

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

New()

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

static

Definition at line 64 of file coordinateRotation.C.

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

Referenced by coordinateSystem::assign().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

virtual void clear ( )

pure virtual

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

R()

virtual tensor R ( ) const

pure virtual

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

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

writeEntry()

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

pure virtual

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

---

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

• src/meshTools/coordinate/rotation/coordinateRotation.H
• src/meshTools/coordinate/rotation/coordinateRotation.C