Abstract base class for coordinate rotation. More...

Inheritance diagram for coordinateRotation:

[legend]

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

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

	declareRunTimeSelectionTable (autoPtr, coordinateRotation, points,(const dictionary &dict, const UList< vector > &points),(dict, points))

virtual autoPtr< coordinateRotation >	clone () const =0
	Construct and return a clone. More...

virtual	~coordinateRotation ()
	Destructor. More...

virtual void	updatePoints (const UList< vector > &points)=0
	Update the rotation for a list of points. More...

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

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

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

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

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

virtual vector	transform (const vector &v) const =0
	Transform vector using transformation tensor. More...

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

virtual vector	invTransform (const vector &v) const =0
	Inverse transform vector using transformation tensor. More...

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

virtual tensor	transform (const vector &p, const tensor &t) const =0
	Transform tensor using transformation tensorField. More...

virtual tmp< tensorField >	transform (const tensorField &tf) const =0
	Transform tensor field using transformation tensorField. More...

virtual symmTensor	transformDiagTensor (const vector &p, const vector &v) const =0
	Transform diagTensor masquerading as a vector using transformation. More...

virtual tmp< symmTensorField >	transformDiagTensor (const vectorField &vf) const =0
	Transform diagTensorField masquerading as a vectorField. More...

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

Static Public Member Functions
static autoPtr< coordinateRotation >	New (const dictionary &dict, const UList< vector > &points)
	Select constructed from dictionary and list of points. More...

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

Protected Member Functions
symmTensor	transformVectorDiagTensor (const tensor &, const vector &) const
	Transform the vector as if it is a diagonal tensor. More...

Detailed Description

Abstract base class for coordinate rotation.

coordinateRotation
{
    type        axesRotation
    e1          (1 0 0);
    e2          (0 1 0);
}

Types of coordinateRotation:

axesRotation
STARCDRotation
cylindrical
EulerCoordinateRotation

Source files

Definition at line 70 of file coordinateRotation.H.

Constructor & Destructor Documentation

◆ ~coordinateRotation()

virtual ~coordinateRotation ( )

inlinevirtual

Destructor.

Definition at line 140 of file coordinateRotation.H.

Member Function Documentation

◆ transformVectorDiagTensor()

Foam::symmTensor transformVectorDiagTensor	(	const tensor &	tt,
		const vector &	st
	)		const

protected

Transform the vector as if it is a diagonal tensor.

Definition at line 42 of file coordinateRotation.C.

References Vector< Cmpt >::x(), Tensor< Cmpt >::xx(), Tensor< Cmpt >::xy(), Tensor< Cmpt >::xz(), Vector< Cmpt >::y(), Tensor< Cmpt >::yx(), Tensor< Cmpt >::yy(), Tensor< Cmpt >::yz(), Vector< Cmpt >::z(), Tensor< Cmpt >::zx(), Tensor< Cmpt >::zy(), and Tensor< Cmpt >::zz().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "coordinateRotation" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		coordinateRotation	,
		points	,
		(const dictionary &dict, const UList< vector > &points)	,
		(dict, points)
	)

◆ clone()

virtual autoPtr<coordinateRotation> clone ( ) const

pure virtual

Construct and return a clone.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ New() [1/2]

Foam::autoPtr< Foam::coordinateRotation > New	(	const dictionary &	dict,
		const UList< vector > &	points
	)

static

Select constructed from dictionary and list of points.

Definition at line 64 of file coordinateRotationNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookup(), Foam::nl, points, and Foam::Pout.

Here is the call graph for this function:

◆ New() [2/2]

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

static

Select constructed from dictionary.

Definition at line 31 of file coordinateRotationNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and Foam::Pout.

Here is the call graph for this function:

◆ updatePoints()

virtual void updatePoints ( const UList< vector > & points )

pure virtual

Update the rotation for a list of points.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ R()

virtual const tensor& R ( ) const

pure virtual

Return local-to-global transformation tensor.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

Referenced by fieldCoordinateSystemTransform::transformField().

Here is the caller graph for this function:

◆ e1()

virtual const vector e1 ( ) const

pure virtual

Return local Cartesian x-axis.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ e2()

virtual const vector e2 ( ) const

pure virtual

Return local Cartesian y-axis.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ e3()

virtual const vector e3 ( ) const

pure virtual

Return local Cartesian z-axis.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ uniform()

virtual bool uniform ( ) const

inlinevirtual

Return true if the rotation tensor is uniform.

Reimplemented in cylindrical.

Definition at line 162 of file coordinateRotation.H.

◆ transform() [1/4]

virtual vector transform ( const vector & v ) const

pure virtual

Transform vector using transformation tensor.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ transform() [2/4]

virtual tmp<vectorField> transform ( const vectorField & vf ) const

pure virtual

Transform vectorField using transformation tensor field.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ invTransform() [1/2]

virtual vector invTransform ( const vector & v ) const

pure virtual

Inverse transform vector using transformation tensor.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ invTransform() [2/2]

virtual tmp<vectorField> invTransform ( const vectorField & vf ) const

pure virtual

Inverse transform vectorField using transformation tensor field.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ transform() [3/4]

virtual tensor transform	(	const vector &	p,
		const tensor &	t
	)		const

pure virtual

Transform tensor using transformation tensorField.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ transform() [4/4]

virtual tmp<tensorField> transform ( const tensorField & tf ) const

pure virtual

Transform tensor field using transformation tensorField.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ transformDiagTensor() [1/2]

virtual symmTensor transformDiagTensor	(	const vector &	p,
		const vector &	v
	)		const

pure virtual

Transform diagTensor masquerading as a vector using transformation.

tensor and return symmTensor

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ transformDiagTensor() [2/2]

virtual tmp<symmTensorField> transformDiagTensor ( const vectorField & vf ) const

pure virtual

Transform diagTensorField masquerading as a vectorField.

using transformation tensorField and return symmTensorField

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

◆ write()

virtual void write ( Ostream & ) const

pure virtual

Write.

Implemented in STARCDCoordinateRotation, EulerCoordinateRotation, cylindrical, and axesRotation.

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

src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.C
src/meshTools/coordinateSystems/coordinateRotation/coordinateRotationNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~coordinateRotation()

Member Function Documentation

◆ transformVectorDiagTensor()

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ clone()

◆ New() [1/2]

◆ New() [2/2]

◆ updatePoints()

◆ R()

◆ e1()

◆ e2()

◆ e3()

◆ uniform()

◆ transform() [1/4]

◆ transform() [2/4]

◆ invTransform() [1/2]

◆ invTransform() [2/2]

◆ transform() [3/4]

◆ transform() [4/4]

◆ transformDiagTensor() [1/2]

◆ transformDiagTensor() [2/2]

◆ write()