cylindrical Class Reference

A cylindrical coordinate system (r-theta-z). The coordinate system angle theta is always in radians. More...

Inheritance diagram for cylindrical:
[legend]
Collaboration diagram for cylindrical:
[legend]

Public Member Functions

 TypeNameNoDebug ("cylindrical")
 Runtime type information. More...
 
 cylindrical ()
 Default construct. This is an identity coordinate system. More...
 
 cylindrical (const cylindrical &csys)=default
 Copy construct. More...
 
 cylindrical (cylindrical &&csys)=default
 Move construct. More...
 
 cylindrical (const coordinateSystem &csys)
 Copy construct from another coordinateSystem type. More...
 
 cylindrical (coordinateSystem &&csys)
 Move construct from another coordinateSystem type. More...
 
 cylindrical (autoPtr< coordinateSystem > &&csys)
 Move construct from autoPtr of another coordinateSystem type. More...
 
 cylindrical (const coordinateRotation &crot)
 Copy construct from rotation with origin=0. More...
 
 cylindrical (const point &origin, const coordinateRotation &crot)
 Construct from origin and rotation. More...
 
 cylindrical (const point &origin, const vector &axis)
 Construct from origin and single axis. More...
 
 cylindrical (const word &name, const point &origin, const vector &axis)
 Construct from origin and single axis. More...
 
 cylindrical (const point &origin, const vector &axis, const vector &dirn)
 Construct from origin and two axes. More...
 
 cylindrical (const word &name, const point &origin, const vector &axis, const vector &dirn)
 Construct from origin and two axes. More...
 
 cylindrical (const word &name, const dictionary &dict)
 Construct from dictionary with a given name. More...
 
 cylindrical (const dictionary &dict)
 Construct from dictionary without a name. More...
 
 cylindrical (const dictionary &dict, const word &dictName)
 Construct from dictionary with optional subDict lookup. More...
 
virtual autoPtr< coordinateSystemclone () const
 Return clone. More...
 
virtual ~cylindrical ()=default
 Destructor. More...
 
virtual bool uniform () const
 Treat the rotation tensor as non-uniform. More...
 
virtual tensor R (const point &global) const
 
cylindricaloperator= (const cylindrical &)=default
 Copy assignment. More...
 
cylindricaloperator= (cylindrical &&)=default
 Move assignment. More...
 
virtual const tensorR () const
 Position-dependent rotation tensors at multiple points. More...
 
virtual tensor R (const point &global) const
 Position-dependent rotation tensors at multiple points. More...
 
virtual tmp< tensorFieldR (const UList< point > &global) const
 Position-dependent rotation tensors at multiple points. More...
 
virtual tmp< tensorFieldR (const pointUIndList &global) const
 Position-dependent rotation tensors at multiple points. More...
 
- Public Member Functions inherited from coordinateSystem
 TypeName ("coordinateSystem")
 Runtime type information. More...
 
 coordinateSystem ()
 Default construct. This is an identity coordinate system. More...
 
 coordinateSystem (const coordinateRotation &crot)
 Copy construct from rotation with origin=0. More...
 
 coordinateSystem (coordinateRotation &&crot)
 Move construct from rotation with origin=0. More...
 
 coordinateSystem (const coordinateSystem &csys)
 Copy construct. More...
 
 coordinateSystem (coordinateSystem &&csys)
 Move construct. More...
 
 coordinateSystem (autoPtr< coordinateSystem > &&csys)
 Move construct from autoPtr. More...
 
 coordinateSystem (const word &name, const coordinateSystem &csys)
 Copy construct with a different name. More...
 
 coordinateSystem (const point &origin, const coordinateRotation &crot)
 Construct from origin and rotation. More...
 
 coordinateSystem (const point &origin, const vector &axis, const vector &dirn)
 Construct from origin and 2 axes. More...
 
 coordinateSystem (const word &name, const point &origin, const coordinateRotation &crot)
 Construct from origin and rotation. More...
 
 coordinateSystem (const word &name, const point &origin, const vector &axis, const vector &dirn)
 Construct from origin and 2 axes. More...
 
 coordinateSystem (const word &name, const dictionary &dict)
 Construct from dictionary with a given name. More...
 
 coordinateSystem (const dictionary &dict)
 Construct from dictionary without a name. More...
 
 coordinateSystem (const dictionary &dict, const word &dictName)
 Construct from dictionary with optional subDict lookup. More...
 
virtual autoPtr< coordinateSystemclone () const
 Return clone. More...
 
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const dictionary &dict),(dict))
 
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, registry,(const objectRegistry &obr, const dictionary &dict),(obr, dict))
 
virtual ~coordinateSystem ()=default
 Destructor. More...
 
virtual bool valid () const
 Consider valid if it has a specification. More...
 
virtual bool uniform () const
 True if the rotation tensor is uniform for all locations. More...
 
virtual const pointorigin () const
 Return origin. More...
 
virtual const coordinateRotationrotation () const
 The rotation specification. More...
 
virtual const wordname () const
 Return the name. More...
 
virtual const stringnote () const
 Return the optional note. More...
 
virtual const tensorR () const
 Return const reference to the rotation tensor. More...
 
virtual const vector e1 () const
 The local Cartesian x-axis in global coordinates. More...
 
virtual const vector e2 () const
 The local Cartesian y-axis in global coordinates. More...
 
virtual const vector e3 () const
 The local Cartesian z-axis in global coordinates. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
virtual stringnote ()
 Edit access to optional note. More...
 
virtual pointorigin ()
 Edit access to origin. More...
 
virtual void clear ()
 Reset origin and rotation to an identity coordinateSystem. More...
 
virtual void rotation (autoPtr< coordinateRotation > &&crot)
 Change the rotation. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
virtual void writeEntry (Ostream &os) const
 Write 'coordinateSystem' dictionary entry. More...
 
virtual void writeEntry (const word &keyword, Ostream &os) const
 Write dictionary entry. More...
 
void operator= (const coordinateSystem &csys)
 Copy assignment. More...
 
void operator= (coordinateSystem &&csys)
 Move assignment. More...
 
void operator= (const autoPtr< coordinateSystem > &csys)
 Copy assignment from autoPtr. More...
 
void operator= (autoPtr< coordinateSystem > &&csys)
 Move assignment from autoPtr. More...
 
virtual tensor R (const point &global) const
 
virtual tmp< tensorFieldR (const UList< point > &global) const
 
virtual tmp< tensorFieldR (const pointUIndList &global) const
 
point transformPoint (const point &localCart) const
 Transform point and add origin offset. More...
 
tmp< pointFieldtransformPoint (const UList< point > &localCart) const
 Transform points and add origin offset. More...
 
tmp< pointFieldtransformPoint (const pointUIndList &localCart) const
 Transform points and add origin offset. More...
 
point invTransformPoint (const point &global) const
 Remove origin offset and inverse transform point. More...
 
tmp< pointFieldinvTransformPoint (const UList< point > &global) const
 Remove origin offset and inverse transform points. More...
 
tmp< pointFieldinvTransformPoint (const pointUIndList &global) const
 Remove origin offset and inverse transform points. More...
 
point globalPosition (const point &local) const
 From local coordinate position to global (cartesian) position. More...
 
tmp< pointFieldglobalPosition (const pointField &local) const
 From local coordinate position to global (cartesian) position. More...
 
point localPosition (const point &global) const
 From global (cartesian) position to local coordinate position. More...
 
tmp< pointFieldlocalPosition (const pointField &global) const
 From global (cartesian) position to local coordinate position. More...
 
vector globalVector (const vector &local) const
 From local to global (cartesian) vector components. More...
 
tmp< vectorFieldglobalVector (const vectorField &local) const
 From local to global (cartesian) vector components. More...
 
vector localVector (const vector &global) const
 From global (cartesian) to local vector components. More...
 
tmp< vectorFieldlocalVector (const vectorField &global) const
 From global (cartesian) to local vector components. More...
 
virtual symmTensor transformPrincipal (const vector &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< symmTensor > > transformPrincipal (const UList< vector > &input) const
 With constant rotation tensor. More...
 
virtual symmTensor transformPrincipal (const point &global, const vector &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< symmTensor > > transformPrincipal (const UList< point > &global, const vector &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > transformPrincipal (const pointUIndList &global, const vector &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > transformPrincipal (const UList< point > &global, const UList< vector > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > transformPrincipal (const pointUIndList &global, const UList< vector > &input) const
 With rotation tensors at given global positions. More...
 
virtual scalar transform (const scalar &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< scalar > > transform (const UList< scalar > &input) const
 With constant rotation tensor. More...
 
virtual scalar transform (const point &global, const scalar &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< scalar > > transform (const UList< point > &global, const scalar &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< scalar > > transform (const pointUIndList &global, const scalar &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< scalar > > transform (const UList< point > &global, const UList< scalar > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< scalar > > transform (const pointUIndList &global, const UList< scalar > &input) const
 With rotation tensors at given global positions. More...
 
virtual vector transform (const vector &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< vector > > transform (const UList< vector > &input) const
 With constant rotation tensor. More...
 
virtual vector transform (const point &global, const vector &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< vector > > transform (const UList< point > &global, const vector &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< vector > > transform (const pointUIndList &global, const vector &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< vector > > transform (const UList< point > &global, const UList< vector > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< vector > > transform (const pointUIndList &global, const UList< vector > &input) const
 With rotation tensors at given global positions. More...
 
virtual sphericalTensor transform (const sphericalTensor &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< sphericalTensor > > transform (const UList< sphericalTensor > &input) const
 With constant rotation tensor. More...
 
virtual sphericalTensor transform (const point &global, const sphericalTensor &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< sphericalTensor > > transform (const UList< point > &global, const sphericalTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< sphericalTensor > > transform (const pointUIndList &global, const sphericalTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< sphericalTensor > > transform (const UList< point > &global, const UList< sphericalTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< sphericalTensor > > transform (const pointUIndList &global, const UList< sphericalTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual symmTensor transform (const symmTensor &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< symmTensor > > transform (const UList< symmTensor > &input) const
 With constant rotation tensor. More...
 
virtual symmTensor transform (const point &global, const symmTensor &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< symmTensor > > transform (const UList< point > &global, const symmTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > transform (const pointUIndList &global, const symmTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > transform (const UList< point > &global, const UList< symmTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > transform (const pointUIndList &global, const UList< symmTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tensor transform (const tensor &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< tensor > > transform (const UList< tensor > &input) const
 With constant rotation tensor. More...
 
virtual tensor transform (const point &global, const tensor &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< tensor > > transform (const UList< point > &global, const tensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< tensor > > transform (const pointUIndList &global, const tensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< tensor > > transform (const UList< point > &global, const UList< tensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< tensor > > transform (const pointUIndList &global, const UList< tensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual scalar invTransform (const scalar &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< scalar > > invTransform (const UList< scalar > &input) const
 With constant rotation tensor. More...
 
virtual scalar invTransform (const point &global, const scalar &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< scalar > > invTransform (const UList< point > &global, const scalar &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< scalar > > invTransform (const pointUIndList &global, const scalar &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< scalar > > invTransform (const UList< point > &global, const UList< scalar > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< scalar > > invTransform (const pointUIndList &global, const UList< scalar > &input) const
 With rotation tensors at given global positions. More...
 
virtual vector invTransform (const vector &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< vector > > invTransform (const UList< vector > &input) const
 With constant rotation tensor. More...
 
virtual vector invTransform (const point &global, const vector &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< vector > > invTransform (const UList< point > &global, const vector &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< vector > > invTransform (const pointUIndList &global, const vector &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< vector > > invTransform (const UList< point > &global, const UList< vector > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< vector > > invTransform (const pointUIndList &global, const UList< vector > &input) const
 With rotation tensors at given global positions. More...
 
virtual sphericalTensor invTransform (const sphericalTensor &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< sphericalTensor > > invTransform (const UList< sphericalTensor > &input) const
 With constant rotation tensor. More...
 
virtual sphericalTensor invTransform (const point &global, const sphericalTensor &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< sphericalTensor > > invTransform (const UList< point > &global, const sphericalTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< sphericalTensor > > invTransform (const pointUIndList &global, const sphericalTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< sphericalTensor > > invTransform (const UList< point > &global, const UList< sphericalTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< sphericalTensor > > invTransform (const pointUIndList &global, const UList< sphericalTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual symmTensor invTransform (const symmTensor &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< symmTensor > > invTransform (const UList< symmTensor > &input) const
 With constant rotation tensor. More...
 
virtual symmTensor invTransform (const point &global, const symmTensor &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< symmTensor > > invTransform (const UList< point > &global, const symmTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > invTransform (const pointUIndList &global, const symmTensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > invTransform (const UList< point > &global, const UList< symmTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< symmTensor > > invTransform (const pointUIndList &global, const UList< symmTensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tensor invTransform (const tensor &input) const
 With constant rotation tensor. More...
 
virtual tmp< Field< tensor > > invTransform (const UList< tensor > &input) const
 With constant rotation tensor. More...
 
virtual tensor invTransform (const point &global, const tensor &input) const
 With rotation tensor at given global position. More...
 
virtual tmp< Field< tensor > > invTransform (const UList< point > &global, const tensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< tensor > > invTransform (const pointUIndList &global, const tensor &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< tensor > > invTransform (const UList< point > &global, const UList< tensor > &input) const
 With rotation tensors at given global positions. More...
 
virtual tmp< Field< tensor > > invTransform (const pointUIndList &global, const UList< tensor > &input) const
 With rotation tensors at given global positions. More...
 
template<class PointField >
Foam::tmp< Foam::tensorFieldrotationsImpl (const PointField &global) const
 
template<class PointField >
Foam::tmp< Foam::pointFieldtransformPointImpl (const PointField &localCart) const
 
template<class PointField >
Foam::tmp< Foam::pointFieldinvTransformPointImpl (const PointField &global) const
 
template<class RetType , class Type , class BinaryOp >
Foam::tmp< Foam::Field< RetType > > manyTimesImpl (const tensor &tt, const UList< Type > &input, const BinaryOp &bop)
 
template<class RetType , class PointField , class Type , class BinaryOp >
Foam::tmp< Foam::Field< RetType > > oneToOneImpl (const PointField &global, const UList< Type > &input, const BinaryOp &bop) const
 
template<class RetType , class PointField , class Type , class BinaryOp >
Foam::tmp< Foam::Field< RetType > > oneToManyImpl (const PointField &global, const Type &input, const BinaryOp &bop) const
 

Static Public Attributes

static const cylindrical null
 Global (identity) cylindrical coordinate system. More...
 

Protected Member Functions

virtual vector localToGlobal (const vector &local, bool translate) const
 
virtual tmp< vectorFieldlocalToGlobal (const vectorField &local, bool translate) const
 
virtual vector globalToLocal (const vector &global, bool translate) const
 
virtual tmp< vectorFieldglobalToLocal (const vectorField &global, bool translate) const
 
- Protected Member Functions inherited from coordinateSystem
template<class PointField >
tmp< tensorFieldrotationsImpl (const PointField &global) const
 Implementation for R() methods. More...
 
template<class PointField >
tmp< pointFieldtransformPointImpl (const PointField &localCart) const
 Implementation for transformPoint() methods. More...
 
template<class PointField >
tmp< pointFieldinvTransformPointImpl (const PointField &global) const
 Implementation for transformPosition() methods. More...
 
template<class RetType , class PointField , class Type , class BinaryOp >
tmp< Field< RetType > > oneToOneImpl (const PointField &global, const UList< Type > &input, const BinaryOp &bop) const
 Use position-dependent transform tensors for multiple inputs. More...
 
template<class RetType , class PointField , class Type , class BinaryOp >
tmp< Field< RetType > > oneToManyImpl (const PointField &global, const Type &input, const BinaryOp &bop) const
 Use position-dependent transform tensors for single input. More...
 
virtual vector localToGlobal (const vector &local, bool translate) const
 
virtual tmp< vectorFieldlocalToGlobal (const vectorField &local, bool translate) const
 
virtual vector globalToLocal (const vector &global, bool translate) const
 
virtual tmp< vectorFieldglobalToLocal (const vectorField &global, bool translate) const
 
void assign (const dictionary &dict)
 Assign from dictionary content. More...
 
 coordinateSystem (std::nullptr_t)
 

Additional Inherited Members

- Static Public Member Functions inherited from coordinateSystem
static autoPtr< coordinateSystemNew (word modelType, const objectRegistry &obr, const dictionary &dict)
 
static autoPtr< coordinateSystemNew (word modelType, const dictionary &dict)
 Select construct the specified coordinate system type. More...
 
static autoPtr< coordinateSystemNew (const objectRegistry &obr, const dictionary &dict, const word &dictName="")
 
static autoPtr< coordinateSystemNew (const dictionary &dict, const word &dictName="")
 Select constructed from dictionary. More...
 
static autoPtr< coordinateSystemNew (Istream &is)
 Select constructed from Istream. More...
 
- Static Protected Member Functions inherited from coordinateSystem
template<class RetType , class Type , class BinaryOp >
static tmp< Field< RetType > > manyTimesImpl (const tensor &tt, const UList< Type > &input, const BinaryOp &bop)
 Apply single transform tensor for multiple inputs. More...
 
- Protected Attributes inherited from coordinateSystem
autoPtr< coordinateRotationspec_
 User specification of the coordinate rotation. More...
 
point origin_
 The coordinate system origin. More...
 
tensor rot_
 The rotation tensor. More...
 
word name_
 The name of the coordinate system (optional) More...
 
string note_
 An optional note describing the coordinate system. More...
 
- Static Protected Attributes inherited from coordinateSystem
static coordinateSystem dummy_
 Dummy coordinate system for suppressed manipulation. More...
 

Detailed Description

A cylindrical coordinate system (r-theta-z). The coordinate system angle theta is always in radians.


Dictionary entries

Property Description Required Default
type type name: cylindrical yes
Source files

Definition at line 71 of file cylindricalCS.H.

Constructor & Destructor Documentation

◆ cylindrical() [1/15]

Default construct. This is an identity coordinate system.

Definition at line 87 of file cylindricalCS.C.

◆ cylindrical() [2/15]

cylindrical ( const cylindrical csys)
default

Copy construct.

◆ cylindrical() [3/15]

cylindrical ( cylindrical &&  csys)
default

Move construct.

◆ cylindrical() [4/15]

cylindrical ( const coordinateSystem csys)
explicit

Copy construct from another coordinateSystem type.

Definition at line 93 of file cylindricalCS.C.

◆ cylindrical() [5/15]

cylindrical ( coordinateSystem &&  csys)
explicit

Move construct from another coordinateSystem type.

Definition at line 99 of file cylindricalCS.C.

◆ cylindrical() [6/15]

cylindrical ( autoPtr< coordinateSystem > &&  csys)
explicit

Move construct from autoPtr of another coordinateSystem type.

Definition at line 105 of file cylindricalCS.C.

◆ cylindrical() [7/15]

cylindrical ( const coordinateRotation crot)
explicit

Copy construct from rotation with origin=0.

Definition at line 111 of file cylindricalCS.C.

◆ cylindrical() [8/15]

cylindrical ( const point origin,
const coordinateRotation crot 
)

Construct from origin and rotation.

Definition at line 117 of file cylindricalCS.C.

◆ cylindrical() [9/15]

cylindrical ( const point origin,
const vector axis 
)

Construct from origin and single axis.

Definition at line 127 of file cylindricalCS.C.

◆ cylindrical() [10/15]

cylindrical ( const word name,
const point origin,
const vector axis 
)

Construct from origin and single axis.

Definition at line 137 of file cylindricalCS.C.

◆ cylindrical() [11/15]

cylindrical ( const point origin,
const vector axis,
const vector dirn 
)

Construct from origin and two axes.

Definition at line 153 of file cylindricalCS.C.

◆ cylindrical() [12/15]

cylindrical ( const word name,
const point origin,
const vector axis,
const vector dirn 
)

Construct from origin and two axes.

Definition at line 164 of file cylindricalCS.C.

◆ cylindrical() [13/15]

cylindrical ( const word name,
const dictionary dict 
)

Construct from dictionary with a given name.

Definition at line 176 of file cylindricalCS.C.

References dict, dictionary::getOrDefault(), and Foam::warnCompatDegrees().

Here is the call graph for this function:

◆ cylindrical() [14/15]

cylindrical ( const dictionary dict)
explicit

Construct from dictionary without a name.

Definition at line 191 of file cylindricalCS.C.

References dict, dictionary::getOrDefault(), and Foam::warnCompatDegrees().

Here is the call graph for this function:

◆ cylindrical() [15/15]

cylindrical ( const dictionary dict,
const word dictName 
)

Construct from dictionary with optional subDict lookup.

Parameters
dictNameIf non-empty, the sub-dictionary to use.

Definition at line 202 of file cylindricalCS.C.

References dict, dictName(), dictionary::getOrDefault(), dictionary::subDict(), and Foam::warnCompatDegrees().

Here is the call graph for this function:

◆ ~cylindrical()

virtual ~cylindrical ( )
virtualdefault

Destructor.

Member Function Documentation

◆ localToGlobal() [1/2]

Foam::vector localToGlobal ( const vector local,
bool  translate 
) const
protectedvirtual

From local coordinate system to the global Cartesian system with optional translation for the origin

Reimplemented from coordinateSystem.

Definition at line 259 of file cylindricalCS.C.

References coordinateSystem::localToGlobal(), and Foam::toCartesian().

Here is the call graph for this function:

◆ localToGlobal() [2/2]

Foam::tmp< Foam::vectorField > localToGlobal ( const vectorField local,
bool  translate 
) const
protectedvirtual

From local coordinate system to the global Cartesian system with optional translation for the origin

Reimplemented from coordinateSystem.

Definition at line 273 of file cylindricalCS.C.

References coordinateSystem::localToGlobal(), Time::New(), UList< T >::size(), and Foam::toCartesian().

Here is the call graph for this function:

◆ globalToLocal() [1/2]

Foam::vector globalToLocal ( const vector global,
bool  translate 
) const
protectedvirtual

From global Cartesian system to the local coordinate system with optional translation for the origin

Reimplemented from coordinateSystem.

Definition at line 298 of file cylindricalCS.C.

References Foam::fromCartesian(), and coordinateSystem::globalToLocal().

Here is the call graph for this function:

◆ globalToLocal() [2/2]

Foam::tmp< Foam::vectorField > globalToLocal ( const vectorField global,
bool  translate 
) const
protectedvirtual

Convert from global Cartesian system to the local coordinate system with optional translation for the origin

Reimplemented from coordinateSystem.

Definition at line 311 of file cylindricalCS.C.

References Foam::fromCartesian(), coordinateSystem::globalToLocal(), tmp< T >::ref(), and UList< T >::size().

Here is the call graph for this function:

◆ TypeNameNoDebug()

TypeNameNoDebug ( "cylindrical"  )

Runtime type information.

◆ clone()

virtual autoPtr< coordinateSystem > clone ( ) const
inlinevirtual

Return clone.

Reimplemented from coordinateSystem.

Definition at line 185 of file cylindricalCS.H.

◆ uniform()

virtual bool uniform ( ) const
inlinevirtual

Treat the rotation tensor as non-uniform.

Reimplemented from coordinateSystem.

Definition at line 198 of file cylindricalCS.H.

◆ R() [1/5]

Foam::tensor R ( const point global) const
virtual

Position-dependent rotation tensor at a single point

Returns
tensor

Reimplemented from coordinateSystem.

Definition at line 226 of file cylindricalCS.C.

References Tensor< Cmpt >::col(), Foam::mag(), and Vector< Cmpt >::removeCollinear().

Referenced by rotorDiskSource::calculate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=() [1/2]

cylindrical & operator= ( const cylindrical )
default

Copy assignment.

◆ operator=() [2/2]

cylindrical & operator= ( cylindrical &&  )
default

Move assignment.

◆ R() [2/5]

virtual const tensor & R ( ) const
inlinevirtual

Position-dependent rotation tensors at multiple points.

Reimplemented from coordinateSystem.

Definition at line 484 of file coordinateSystem.H.

◆ R() [3/5]

Foam::tensor R ( const point global) const
virtual

Position-dependent rotation tensors at multiple points.

Reimplemented from coordinateSystem.

Definition at line 567 of file coordinateSystem.C.

◆ R() [4/5]

Foam::tmp< Foam::tensorField > R ( const UList< point > &  global) const
virtual

Position-dependent rotation tensors at multiple points.

Reimplemented from coordinateSystem.

Definition at line 571 of file coordinateSystem.C.

◆ R() [5/5]

Foam::tmp< Foam::tensorField > R ( const pointUIndList global) const
virtual

Position-dependent rotation tensors at multiple points.

Reimplemented from coordinateSystem.

Definition at line 575 of file coordinateSystem.C.

Member Data Documentation

◆ null

const Foam::coordSystem::cylindrical null
static

Global (identity) cylindrical coordinate system.

Definition at line 121 of file cylindricalCS.H.


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