A coordinateRotation defined by the STAR-CD convention. More...

Inheritance diagram for STARCDCoordinateRotation:

Collaboration diagram for STARCDCoordinateRotation:

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

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

	STARCDCoordinateRotation (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 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...

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 coordinateRotation defined by the STAR-CD convention.

The 3 rotations are defined in the STAR-CD convention (around Z, around X' and around Y''). The order of the parameter arguments matches this rotation order.

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

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

Source files

Definition at line 63 of file STARCDCoordinateRotation.H.

Constructor & Destructor Documentation

◆ STARCDCoordinateRotation() [1/2]

STARCDCoordinateRotation ( const dictionary & dict )

Construct from dictionary.

Definition at line 97 of file STARCDCoordinateRotation.C.

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

Referenced by STARCDCoordinateRotation::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STARCDCoordinateRotation() [2/2]

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

Construct from dictionary and list of points.

Definition at line 117 of file STARCDCoordinateRotation.C.

Member Function Documentation

◆ TypeName()

TypeName ( "STARCDRotation" )

Runtime type information.

◆ clone()

virtual autoPtr<coordinateRotation> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements coordinateRotation.

Definition at line 108 of file STARCDCoordinateRotation.H.

References STARCDCoordinateRotation::STARCDCoordinateRotation().

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 120 of file STARCDCoordinateRotation.H.

◆ R()

virtual const tensor& R ( ) const

inlinevirtual

Return local-to-global transformation tensor.

Implements coordinateRotation.

Definition at line 124 of file STARCDCoordinateRotation.H.

◆ e1()

virtual const vector e1 ( ) const

inlinevirtual

Return local Cartesian x-axis in global coordinates.

Implements coordinateRotation.

Definition at line 130 of file STARCDCoordinateRotation.H.

References Tensor< Cmpt >::x().

Here is the call graph for this function:

◆ e2()

virtual const vector e2 ( ) const

inlinevirtual

Return local Cartesian y-axis in global coordinates.

Implements coordinateRotation.

Definition at line 136 of file STARCDCoordinateRotation.H.

References Tensor< Cmpt >::y().

Here is the call graph for this function:

◆ e3()

virtual const vector e3 ( ) const

inlinevirtual

Return local Cartesian z-axis in global coordinates.

Implements coordinateRotation.

Definition at line 142 of file STARCDCoordinateRotation.H.

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

Here is the call 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 144 of file STARCDCoordinateRotation.C.

References STARCDCoordinateRotation::invTransform(), and NotImplemented.

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

Here is the call graph for this function:

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 128 of file STARCDCoordinateRotation.C.

References STARCDCoordinateRotation::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 154 of file STARCDCoordinateRotation.C.

References NotImplemented, and STARCDCoordinateRotation::transformTensor().

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

Here is the call graph for this function:

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 135 of file STARCDCoordinateRotation.C.

References STARCDCoordinateRotation::transform().

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 164 of file STARCDCoordinateRotation.C.

References NotImplemented.

Referenced by STARCDCoordinateRotation::e3(), and STARCDCoordinateRotation::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 174 of file STARCDCoordinateRotation.C.

References STARCDCoordinateRotation::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.

symmetrical tensorField

Implements coordinateRotation.

Definition at line 184 of file STARCDCoordinateRotation.C.

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

Referenced by STARCDCoordinateRotation::e3(), and STARCDCoordinateRotation::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.

symmetrical tensor

Implements coordinateRotation.

Definition at line 200 of file STARCDCoordinateRotation.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Implements coordinateRotation.

Definition at line 208 of file STARCDCoordinateRotation.C.

References Foam::writeEntry().

Referenced by STARCDCoordinateRotation::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/STARCDCoordinateRotation.H
src/meshTools/coordinateSystems/coordinateRotation/STARCDCoordinateRotation.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ STARCDCoordinateRotation() [1/2]

◆ STARCDCoordinateRotation() [2/2]

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]

◆ write()