A coordinate rotation specified using global axis. More...

Inheritance diagram for axesRotation:

Collaboration diagram for axesRotation:

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

	axesRotation (const vector &axis, const vector &dir)
	Construct from 2 axes. More...

	axesRotation (const tensor &R)
	Construct from components. More...

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

	axesRotation (const dictionary &, const UList< vector > &points)
	Construct from dictionary and list of points. More...

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

virtual	~axesRotation ()
	Destructor. More...

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

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

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

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

virtual const vector	e3 () const
	Return local Cartesian z-axis in global coordinates. 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< 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...

void	operator= (const dictionary &)
	Assign from dictionary. More...

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

Public Member Functions inherited from coordinateRotation
	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	~coordinateRotation ()
	Destructor. More...

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

Additional Inherited Members
Static Public Member Functions inherited from coordinateRotation
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 inherited from coordinateRotation
symmTensor	transformPrincipal (const tensor &, const vector &) const
	Transform principal. More...

Detailed Description

A coordinate rotation specified using global axis.

The rotation is defined by a combination of vectors (e1/e2), (e2/e3) or (e3/e1). Any nonorthogonality will be absorbed into the second vector.

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

Source files

Definition at line 64 of file axesRotation.H.

Constructor & Destructor Documentation

◆ axesRotation() [1/4]

axesRotation	(	const vector &	axis,
		const vector &	dir
	)

Construct from 2 axes.

Definition at line 104 of file axesRotation.C.

Referenced by axesRotation::axesRotation(), and axesRotation::clone().

Here is the caller graph for this function:

◆ axesRotation() [2/4]

axesRotation ( const tensor & R )

Construct from components.

Definition at line 116 of file axesRotation.C.

References axesRotation::axesRotation().

Here is the call graph for this function:

◆ axesRotation() [3/4]

axesRotation ( const dictionary & dict )

Construct from dictionary.

Definition at line 124 of file axesRotation.C.

References axesRotation::axesRotation(), and axesRotation::operator=().

Here is the call graph for this function:

◆ axesRotation() [4/4]

axesRotation	(	const dictionary &	dict,
		const UList< vector > &	points
	)

Construct from dictionary and list of points.

Definition at line 136 of file axesRotation.C.

References axesRotation::transform().

Here is the call graph for this function:

◆ ~axesRotation()

virtual ~axesRotation ( )

inlinevirtual

Destructor.

Definition at line 122 of file axesRotation.H.

Member Function Documentation

◆ TypeName()

TypeName ( "axesRotation" )

Runtime type information.

◆ clone()

virtual autoPtr<coordinateRotation> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements coordinateRotation.

Definition at line 115 of file axesRotation.H.

References axesRotation::axesRotation().

Here is the call graph for this function:

◆ updatePoints()

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

inlinevirtual

Update the rotation for a list of points.

Implements coordinateRotation.

Definition at line 129 of file axesRotation.H.

◆ R()

virtual const tensor& R ( ) const

inlinevirtual

Return local-to-global transformation tensor.

Implements coordinateRotation.

Definition at line 133 of file axesRotation.H.

◆ e1()

virtual const vector e1 ( ) const

inlinevirtual

Return local Cartesian x-axis in global coordinates.

Implements coordinateRotation.

Definition at line 139 of file axesRotation.H.

References Tensor< Cmpt >::x().

Referenced by axesRotation::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ e2()

virtual const vector e2 ( ) const

inlinevirtual

Return local Cartesian y-axis in global coordinates.

Implements coordinateRotation.

Definition at line 145 of file axesRotation.H.

References Tensor< Cmpt >::y().

Referenced by axesRotation::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ e3()

virtual const vector e3 ( ) const

inlinevirtual

Return local Cartesian z-axis in global coordinates.

Implements coordinateRotation.

Definition at line 151 of file axesRotation.H.

References axesRotation::invTransform(), axesRotation::operator=(), axesRotation::transform(), axesRotation::transformTensor(), axesRotation::transformVector(), axesRotation::write(), and Tensor< Cmpt >::z().

Referenced by axesRotation::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transform() [1/2]

Foam::tmp< Foam::vectorField > transform ( const vectorField & st ) const

virtual

Transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 148 of file axesRotation.C.

Referenced by axesRotation::axesRotation(), and axesRotation::e3().

Here is the caller graph for this function:

◆ transform() [2/2]

Foam::vector transform ( const vector & st ) const

virtual

Transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 156 of file axesRotation.C.

References axesRotation::invTransform().

Here is the call graph for this function:

◆ invTransform() [1/2]

Foam::tmp< Foam::vectorField > invTransform ( const vectorField & st ) const

virtual

Inverse transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 163 of file axesRotation.C.

Referenced by axesRotation::e3(), and axesRotation::transform().

Here is the caller graph for this function:

◆ invTransform() [2/2]

Foam::vector invTransform ( const vector & st ) const

virtual

Inverse transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 171 of file axesRotation.C.

References axesRotation::transformTensor().

Here is the call graph for this function:

◆ transformTensor() [1/2]

Foam::tmp< Foam::tensorField > transformTensor ( const tensorField & st ) const

virtual

Transform tensor field using transformation tensorField.

Implements coordinateRotation.

Definition at line 178 of file axesRotation.C.

References NotImplemented.

Referenced by axesRotation::e3(), and axesRotation::invTransform().

Here is the caller graph for this function:

◆ transformTensor() [2/2]

Foam::tensor transformTensor ( const tensor & st ) const

virtual

Transform tensor using transformation tensorField.

Implements coordinateRotation.

Definition at line 188 of file axesRotation.C.

References axesRotation::transformVector().

Here is the call graph for this function:

◆ transformVector() [1/2]

Foam::tmp< Foam::symmTensorField > transformVector ( const vectorField & st ) const

virtual

Transform vectorField using transformation tensorField and return.

symmetric tensorField

Implements coordinateRotation.

Definition at line 197 of file axesRotation.C.

References fld(), forAll, tmp< T >::ref(), List< T >::size(), and coordinateRotation::transformPrincipal().

Referenced by axesRotation::e3(), and axesRotation::transformTensor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transformVector() [2/2]

Foam::symmTensor transformVector ( const vector & st ) const

virtual

Transform vector using transformation tensor and return.

symmetric tensor

Implements coordinateRotation.

Definition at line 213 of file axesRotation.C.

References coordinateRotation::transformPrincipal().

Here is the call graph for this function:

◆ operator=()

void operator= ( const dictionary & dict )

Assign from dictionary.

Definition at line 231 of file axesRotation.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), dictionary::lookup(), Foam::Pout, and dictionary::readIfPresent().

Referenced by axesRotation::axesRotation(), and axesRotation::e3().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Implements coordinateRotation.

Definition at line 221 of file axesRotation.C.

References axesRotation::e1(), axesRotation::e2(), axesRotation::e3(), and Foam::writeEntry().

Referenced by axesRotation::e3().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ axesRotation() [1/4]

◆ axesRotation() [2/4]

◆ axesRotation() [3/4]

◆ axesRotation() [4/4]

◆ ~axesRotation()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ updatePoints()

◆ R()

◆ e1()

◆ e2()

◆ e3()

◆ transform() [1/2]

◆ transform() [2/2]

◆ invTransform() [1/2]

◆ invTransform() [2/2]

◆ transformTensor() [1/2]

◆ transformTensor() [2/2]

◆ transformVector() [1/2]

◆ transformVector() [2/2]

◆ operator=()

◆ write()