A coordinateRotation defined in the z-x-y Euler convention. More...

Inheritance diagram for EulerCoordinateRotation:

Collaboration diagram for EulerCoordinateRotation:

Public Member Functions
	TypeName ("EulerRotation")
	Runtime type information. More...

	EulerCoordinateRotation ()
	Construct null. More...

	EulerCoordinateRotation (const vector &phiThetaPsi, const bool inDegrees=true)
	Construct from rotation vector. More...

	EulerCoordinateRotation (const scalar phiAngle, const scalar thetaAngle, const scalar psiAngle, const bool inDegrees=true)
	Construct from components of rotation vector. More...

	EulerCoordinateRotation (const dictionary &)
	Construct from dictionary. More...

	EulerCoordinateRotation (const dictionary &, const objectRegistry &)
	Construct from dictionary and mesh. More...

	EulerCoordinateRotation (const EulerCoordinateRotation &)
	Construct as copy. More...

autoPtr< coordinateRotation >	clone () const
	Return clone. More...

virtual void	clear ()
	Reset rotation to an identity rotation. More...

virtual void	updateCells (const polyMesh &, const labelList &)
	Update the rotation for a list of cells. More...

virtual const tensor &	R () const
	Return local-to-global transformation tensor. More...

virtual const tensor &	Rtr () const
	Return global-to-local transformation tensor. More...

virtual const vector	e1 () const
	Return local Cartesian x-axis. More...

virtual const vector	e2 () const
	Return local Cartesian y-axis. More...

virtual const vector	e3 () const
	Return local Cartesian z-axis. More...

virtual const tensorField &	Tr () const
	Return transformation tensor field. More...

virtual tmp< vectorField >	transform (const vectorField &st) const
	Transform vectorField using transformation tensor field. More...

virtual vector	transform (const vector &st) const
	Transform vector using transformation tensor. More...

virtual tmp< vectorField >	invTransform (const vectorField &st) const
	Inverse transform vectorField using transformation tensor field. More...

virtual vector	invTransform (const vector &st) const
	Inverse transform vector using transformation tensor. More...

virtual tmp< tensorField >	transformTensor (const tensorField &st) const
	Transform tensor field using transformation tensorField. More...

virtual tensor	transformTensor (const tensor &st) const
	Transform tensor using transformation tensorField. More...

virtual tmp< tensorField >	transformTensor (const tensorField &st, const labelList &cellMap) const
	Transform tensor sub-field using transformation tensorField. More...

virtual tmp< symmTensorField >	transformVector (const vectorField &st) const
	Transform vectorField using transformation tensorField and return. More...

virtual symmTensor	transformVector (const vector &st) const
	Transform vector using transformation tensor and return. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from coordinateRotation
	TypeName ("coordinateRotation")
	Runtime type information. More...

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

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

virtual	~coordinateRotation ()
	Destructor. More...

virtual bool	uniform () const
	Return true if the rotation tensor is uniform. More...

Private Member Functions
void	calcTransform (const scalar phiAngle, const scalar thetaAngle, const scalar psiAngle, const bool inDegrees=true)
	Calculate transformation tensor. More...

Private Attributes
tensor	R_
	Local-to-global transformation tensor. More...

tensor	Rtr_
	Global-to-Local transformation tensor. More...

Additional Inherited Members
Static Public Member Functions inherited from coordinateRotation
static autoPtr< coordinateRotation >	New (const dictionary &dict, const objectRegistry &obr)
	Select constructed from dictionary and objectRegistry. More...

static autoPtr< coordinateRotation >	New (const dictionary &dict)
	Select constructed from dictionary. More...

Protected Member Functions inherited from coordinateRotation
symmTensor	transformPrincipal (const tensor &, const vector &) const
	Transform principal. More...

Detailed Description

A coordinateRotation defined in the z-x-y Euler convention.

The 3 rotations are defined in the Euler convention (around Z, around X' and around Z'). For reference and illustration, see http://mathworld.wolfram.com/EulerAngles.html Note, however, that it is the reverse transformation (local->global) that is defined here.

the rotation angles are in degrees, unless otherwise explictly specified:

    coordinateRotation
    {
        type        EulerRotation
        degrees     false;
        rotation    (0 0 3.141592654);
    }

Definition at line 63 of file EulerCoordinateRotation.H.

Constructor & Destructor Documentation

◆ EulerCoordinateRotation() [1/6]

EulerCoordinateRotation ( )

Construct null.

Definition at line 195 of file EulerCoordinateRotation.C.

◆ EulerCoordinateRotation() [2/6]

EulerCoordinateRotation	(	const vector &	phiThetaPsi,
		const bool	inDegrees = `true`
	)

Construct from rotation vector.

Definition at line 203 of file EulerCoordinateRotation.C.

References VectorSpace::component(), Vector< scalar >::X, Vector< scalar >::Y, and Vector< scalar >::Z.

Here is the call graph for this function:

◆ EulerCoordinateRotation() [3/6]

EulerCoordinateRotation	(	const scalar	phiAngle,
		const scalar	thetaAngle,
		const scalar	psiAngle,
		const bool	inDegrees = `true`
	)

Construct from components of rotation vector.

Definition at line 222 of file EulerCoordinateRotation.C.

◆ EulerCoordinateRotation() [4/6]

EulerCoordinateRotation ( const dictionary & dict )

Construct from dictionary.

Definition at line 237 of file EulerCoordinateRotation.C.

References VectorSpace::component(), dict, dictionary::lookup(), dictionary::lookupOrDefault(), Vector< scalar >::X, Vector< scalar >::Y, and Vector< scalar >::Z.

Here is the call graph for this function:

◆ EulerCoordinateRotation() [5/6]

EulerCoordinateRotation	(	const dictionary &	dict,
		const objectRegistry &
	)

Construct from dictionary and mesh.

Definition at line 257 of file EulerCoordinateRotation.C.

References VectorSpace::component(), dict, dictionary::lookup(), dictionary::lookupOrDefault(), Vector< scalar >::X, Vector< scalar >::Y, and Vector< scalar >::Z.

Here is the call graph for this function:

◆ EulerCoordinateRotation() [6/6]

EulerCoordinateRotation ( const EulerCoordinateRotation & r )

Construct as copy.

Definition at line 278 of file EulerCoordinateRotation.C.

Member Function Documentation

◆ calcTransform()

void calcTransform	(	const scalar	phiAngle,
		const scalar	thetaAngle,
		const scalar	psiAngle,
		const bool	inDegrees = `true`
	)

private

Calculate transformation tensor.

Definition at line 153 of file EulerCoordinateRotation.C.

References Foam::cos(), phi, Foam::constant::mathematical::pi(), psi, and Foam::sin().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "EulerRotation" )

Runtime type information.

◆ clone()

autoPtr<coordinateRotation> clone ( ) const

inlinevirtual

Return clone.

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EulerCoordinateRotation() [1/6]

◆ EulerCoordinateRotation() [2/6]

◆ EulerCoordinateRotation() [3/6]

◆ EulerCoordinateRotation() [4/6]

◆ EulerCoordinateRotation() [5/6]

◆ EulerCoordinateRotation() [6/6]

Member Function Documentation

◆ calcTransform()

◆ TypeName()

◆ clone()

◆ clear()

◆ updateCells()

◆ R()

◆ Rtr()

◆ e1()

◆ e2()

◆ e3()

◆ Tr()

◆ transform() [1/2]

◆ transform() [2/2]

◆ invTransform() [1/2]

◆ invTransform() [2/2]

◆ transformTensor() [1/3]

◆ transformTensor() [2/3]

◆ transformTensor() [3/3]

◆ transformVector() [1/2]

◆ transformVector() [2/2]

◆ write()

Field Documentation

◆ R_

◆ Rtr_