cylindrical Class Reference

A local coordinate rotation. More...

Inheritance diagram for cylindrical:
Collaboration diagram for cylindrical:

Public Member Functions

 TypeName ("cylindrical")
 Runtime type information. More...
 
 cylindrical (const vector &axis, const point &origin, const UList< vector > &points)
 Construct from components for list of points. More...
 
 cylindrical (const dictionary &)
 Construct from dictionary. More...
 
 cylindrical (const dictionary &, const UList< vector > &points)
 Construct from dictionary. More...
 
virtual autoPtr< coordinateRotationclone () const
 Return clone. More...
 
virtual ~cylindrical ()
 Destructor. More...
 
virtual void updatePoints (const UList< vector > &points)
 Update the rotation for a list of points. More...
 
virtual const tensorR () 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 const vector axis () const
 Return local Cartesian z-axis in global coordinates. More...
 
virtual bool uniform () const
 Return if the rotation is uniform. More...
 
virtual vector transform (const vector &v) const
 Transform vector using transformation tensor. More...
 
virtual tmp< vectorFieldtransform (const vectorField &tf) const
 Transform vectorField using transformation tensor field. More...
 
virtual vector transform (const vector &v, const label cmptI) const
 Transform vector using transformation tensor for component. More...
 
virtual vector invTransform (const vector &v) const
 Inverse transform vector using transformation tensor. More...
 
virtual tmp< vectorFieldinvTransform (const vectorField &vf) const
 Inverse transform vectorField using transformation tensor field. More...
 
virtual vector invTransform (const vector &v, const label cmptI) const
 Inverse transform vector using transformation tensor for component. More...
 
virtual tensor transform (const vector &p, const tensor &t) const
 Transform tensor using transformation tensorField. More...
 
virtual tmp< tensorFieldtransform (const tensorField &tf) const
 Transform tensor field using transformation tensorField. More...
 
virtual symmTensor transformDiagTensor (const vector &p, const vector &v) const
 Transform diagTensor masquerading as a vector using transformation. More...
 
virtual tmp< symmTensorFieldtransformDiagTensor (const vectorField &vf) const
 Transform diagTensorField masquerading as a vectorField. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from coordinateRotation
static autoPtr< coordinateRotationNew (const dictionary &dict, const UList< vector > &points)
 Select constructed from dictionary and list of points. More...
 
static autoPtr< coordinateRotationNew (const dictionary &dict)
 Select constructed from dictionary. More...
 
- Protected Member Functions inherited from coordinateRotation
symmTensor transformVectorDiagTensor (const tensor &, const vector &) const
 Transform the vector as if it is a diagonal tensor. More...
 

Detailed Description

A local coordinate rotation.

The rotational field can be created in two ways:

  1. Each rotational tensor is defined with two vectors (dir and axis) where dir = point - origin and axis is the rotation axis. Per each point an axesRotation type of rotation is created (cylindrical coordinates). For example:
          cylindrical
          {
              type        localAxes;
              axis          (0 0 1);
          }
  2. The rotational tensor field is provided at construction.
Source files

Definition at line 65 of file cylindrical.H.

Constructor & Destructor Documentation

◆ cylindrical() [1/3]

cylindrical ( const vector axis,
const point origin,
const UList< vector > &  points 
)

Construct from components for list of points.

Definition at line 79 of file cylindrical.C.

References points.

Referenced by cylindrical::clone().

Here is the caller graph for this function:

◆ cylindrical() [2/3]

cylindrical ( const dictionary dict)

Construct from dictionary.

Definition at line 94 of file cylindrical.C.

◆ cylindrical() [3/3]

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

Construct from dictionary.

Definition at line 107 of file cylindrical.C.

References points.

◆ ~cylindrical()

virtual ~cylindrical ( )
inlinevirtual

Destructor.

Definition at line 120 of file cylindrical.H.

Member Function Documentation

◆ TypeName()

TypeName ( "cylindrical"  )

Runtime type information.

◆ clone()

virtual autoPtr<coordinateRotation> clone ( ) const
inlinevirtual

Return clone.

Implements coordinateRotation.

Definition at line 113 of file cylindrical.H.

References cylindrical::cylindrical().

Here is the call graph for this function:

◆ updatePoints()

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

Update the rotation for a list of points.

Implements coordinateRotation.

Definition at line 121 of file cylindrical.C.

References forAll, points, Foam::R(), and List< T >::size().

Here is the call graph for this function:

◆ R()

virtual const tensor& R ( ) const
inlinevirtual

Return local-to-global transformation tensor.

Implements coordinateRotation.

Definition at line 130 of file cylindrical.H.

References NotImplemented, and VectorSpace< Form, Cmpt, Mrows *Ncols >::zero.

◆ e1()

virtual const vector e1 ( ) const
inlinevirtual

Return local Cartesian x-axis in global coordinates.

Implements coordinateRotation.

Definition at line 137 of file cylindrical.H.

References NotImplemented, and VectorSpace< Form, Cmpt, Ncmpts >::zero.

◆ e2()

virtual const vector e2 ( ) const
inlinevirtual

Return local Cartesian y-axis in global coordinates.

Implements coordinateRotation.

Definition at line 144 of file cylindrical.H.

References NotImplemented, and VectorSpace< Form, Cmpt, Ncmpts >::zero.

◆ e3()

virtual const vector e3 ( ) const
inlinevirtual

Return local Cartesian z-axis in global coordinates.

Implements coordinateRotation.

Definition at line 151 of file cylindrical.H.

◆ axis()

virtual const vector axis ( ) const
inlinevirtual

Return local Cartesian z-axis in global coordinates.

Definition at line 157 of file cylindrical.H.

◆ uniform()

virtual bool uniform ( ) const
inlinevirtual

Return if the rotation is uniform.

Reimplemented from coordinateRotation.

Definition at line 163 of file cylindrical.H.

◆ transform() [1/5]

Foam::vector transform ( const vector v) const
virtual

Transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 157 of file cylindrical.C.

References NotImplemented, and Foam::Zero.

◆ transform() [2/5]

Foam::tmp< Foam::vectorField > transform ( const vectorField tf) const
virtual

Transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 141 of file cylindrical.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and List< T >::size().

Here is the call graph for this function:

◆ transform() [3/5]

Foam::vector transform ( const vector v,
const label  cmptI 
) const
virtual

Transform vector using transformation tensor for component.

Definition at line 164 of file cylindrical.C.

◆ invTransform() [1/3]

Foam::vector invTransform ( const vector v) const
virtual

Inverse transform vector using transformation tensor.

Implements coordinateRotation.

Definition at line 190 of file cylindrical.C.

References NotImplemented, and Foam::Zero.

◆ invTransform() [2/3]

Foam::tmp< Foam::vectorField > invTransform ( const vectorField vf) const
virtual

Inverse transform vectorField using transformation tensor field.

Implements coordinateRotation.

Definition at line 174 of file cylindrical.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, List< T >::size(), and Foam::T().

Here is the call graph for this function:

◆ invTransform() [3/3]

Foam::vector invTransform ( const vector v,
const label  cmptI 
) const
virtual

Inverse transform vector using transformation tensor for component.

Definition at line 197 of file cylindrical.C.

References Foam::T().

Here is the call graph for this function:

◆ transform() [4/5]

Foam::tensor transform ( const vector p,
const tensor t 
) const
virtual

Transform tensor using transformation tensorField.

Implements coordinateRotation.

Definition at line 222 of file cylindrical.C.

References Foam::R().

Here is the call graph for this function:

◆ transform() [5/5]

Foam::tmp< Foam::tensorField > transform ( const tensorField tf) const
virtual

Transform tensor field using transformation tensorField.

Implements coordinateRotation.

Definition at line 207 of file cylindrical.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, List< T >::size(), Foam::T(), and tf.

Here is the call graph for this function:

◆ transformDiagTensor() [1/2]

Foam::symmTensor transformDiagTensor ( const vector p,
const vector v 
) const
virtual

Transform diagTensor masquerading as a vector using transformation.

tensor and return symmTensor

Implements coordinateRotation.

Definition at line 257 of file cylindrical.C.

References p, and Foam::R().

Here is the call graph for this function:

◆ transformDiagTensor() [2/2]

Foam::tmp< Foam::symmTensorField > transformDiagTensor ( const vectorField vf) const
virtual

Transform diagTensorField masquerading as a vectorField.

using transformation tensorField and return symmTensorField

Implements coordinateRotation.

Definition at line 233 of file cylindrical.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, fld(), forAll, Foam::R(), tmp< T >::ref(), and List< T >::size().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Implements coordinateRotation.

Definition at line 267 of file cylindrical.C.

References Foam::writeEntry().

Here is the call graph for this function:

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