A cylindrical coordinate system (r-theta-z). The coordinate system angle theta is always in radians. More...
Public Member Functions | |
| TypeNameNoDebug ("cylindrical") | |
| Runtime type information. More... | |
| cylindrical () | |
| Construct null (identity coordinateSystem) 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 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< coordinateSystem > | clone () 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 |
| cylindrical & | operator= (const cylindrical &)=default |
| Copy assignment. More... | |
| cylindrical & | operator= (cylindrical &&)=default |
| Move assignment. More... | |
| virtual const tensor & | R () 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< tensorField > | R (const UList< point > &global) const |
| Position-dependent rotation tensors at multiple points. More... | |
| virtual tmp< tensorField > | R (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 () | |
| Construct null. This is an identity coordinateSystem. 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... | |
| 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 |
| Considered valid if it has a specification. More... | |
| virtual const coordinateRotation & | rotation () const |
| The rotation specification. More... | |
| virtual const word & | name () const |
| Return the name. More... | |
| virtual const string & | note () const |
| Return the optional note. More... | |
| virtual const point & | origin () const |
| Return origin. More... | |
| virtual const tensor & | R () 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 string & | note () |
| Provide non-constant access to the optional note. More... | |
| virtual point & | origin () |
| 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 (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 tmp< tensorField > | R (const UList< point > &global) const |
| virtual tmp< tensorField > | R (const pointUIndList &global) const |
| point | transformPoint (const point &localCart) const |
| Transform point and add origin offset. More... | |
| tmp< pointField > | transformPoint (const UList< point > &localCart) const |
| Transform points and add origin offset. More... | |
| tmp< pointField > | transformPoint (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< pointField > | invTransformPoint (const UList< point > &global) const |
| Remove origin offset and inverse transform points. More... | |
| tmp< pointField > | invTransformPoint (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< pointField > | globalPosition (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< pointField > | localPosition (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< vectorField > | globalVector (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< vectorField > | localVector (const vectorField &global) const |
| From global (cartesian) to local vector components. More... | |
| virtual symmTensor | transformPrincipal (const vector &input) const |
| virtual tmp< Field< symmTensor > > | transformPrincipal (const UList< vector > &input) const |
| virtual symmTensor | transformPrincipal (const point &global, const vector &input) const |
| virtual tmp< Field< symmTensor > > | transformPrincipal (const UList< point > &global, const vector &input) const |
| virtual tmp< Field< symmTensor > > | transformPrincipal (const pointUIndList &global, const vector &input) const |
| virtual tmp< Field< symmTensor > > | transformPrincipal (const UList< point > &global, const UList< vector > &input) const |
| virtual tmp< Field< symmTensor > > | transformPrincipal (const pointUIndList &global, const UList< vector > &input) const |
| virtual scalar | transform (const scalar &input) const |
| virtual tmp< Field< scalar > > | transform (const UList< scalar > &input) const |
| virtual scalar | transform (const point &global, const scalar &input) const |
| virtual tmp< Field< scalar > > | transform (const UList< point > &global, const scalar &input) const |
| virtual tmp< Field< scalar > > | transform (const pointUIndList &global, const scalar &input) const |
| virtual tmp< Field< scalar > > | transform (const UList< point > &global, const UList< scalar > &input) const |
| virtual tmp< Field< scalar > > | transform (const pointUIndList &global, const UList< scalar > &input) const |
| virtual vector | transform (const vector &input) const |
| virtual tmp< Field< vector > > | transform (const UList< vector > &input) const |
| virtual vector | transform (const point &global, const vector &input) const |
| virtual tmp< Field< vector > > | transform (const UList< point > &global, const vector &input) const |
| virtual tmp< Field< vector > > | transform (const pointUIndList &global, const vector &input) const |
| virtual tmp< Field< vector > > | transform (const UList< point > &global, const UList< vector > &input) const |
| virtual tmp< Field< vector > > | transform (const pointUIndList &global, const UList< vector > &input) const |
| virtual sphericalTensor | transform (const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | transform (const UList< sphericalTensor > &input) const |
| virtual sphericalTensor | transform (const point &global, const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | transform (const UList< point > &global, const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | transform (const pointUIndList &global, const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | transform (const UList< point > &global, const UList< sphericalTensor > &input) const |
| virtual tmp< Field< sphericalTensor > > | transform (const pointUIndList &global, const UList< sphericalTensor > &input) const |
| virtual symmTensor | transform (const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | transform (const UList< symmTensor > &input) const |
| virtual symmTensor | transform (const point &global, const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | transform (const UList< point > &global, const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | transform (const pointUIndList &global, const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | transform (const UList< point > &global, const UList< symmTensor > &input) const |
| virtual tmp< Field< symmTensor > > | transform (const pointUIndList &global, const UList< symmTensor > &input) const |
| virtual tensor | transform (const tensor &input) const |
| virtual tmp< Field< tensor > > | transform (const UList< tensor > &input) const |
| virtual tensor | transform (const point &global, const tensor &input) const |
| virtual tmp< Field< tensor > > | transform (const UList< point > &global, const tensor &input) const |
| virtual tmp< Field< tensor > > | transform (const pointUIndList &global, const tensor &input) const |
| virtual tmp< Field< tensor > > | transform (const UList< point > &global, const UList< tensor > &input) const |
| virtual tmp< Field< tensor > > | transform (const pointUIndList &global, const UList< tensor > &input) const |
| virtual scalar | invTransform (const scalar &input) const |
| virtual tmp< Field< scalar > > | invTransform (const UList< scalar > &input) const |
| virtual scalar | invTransform (const point &global, const scalar &input) const |
| virtual tmp< Field< scalar > > | invTransform (const UList< point > &global, const scalar &input) const |
| virtual tmp< Field< scalar > > | invTransform (const pointUIndList &global, const scalar &input) const |
| virtual tmp< Field< scalar > > | invTransform (const UList< point > &global, const UList< scalar > &input) const |
| virtual tmp< Field< scalar > > | invTransform (const pointUIndList &global, const UList< scalar > &input) const |
| virtual vector | invTransform (const vector &input) const |
| virtual tmp< Field< vector > > | invTransform (const UList< vector > &input) const |
| virtual vector | invTransform (const point &global, const vector &input) const |
| virtual tmp< Field< vector > > | invTransform (const UList< point > &global, const vector &input) const |
| virtual tmp< Field< vector > > | invTransform (const pointUIndList &global, const vector &input) const |
| virtual tmp< Field< vector > > | invTransform (const UList< point > &global, const UList< vector > &input) const |
| virtual tmp< Field< vector > > | invTransform (const pointUIndList &global, const UList< vector > &input) const |
| virtual sphericalTensor | invTransform (const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | invTransform (const UList< sphericalTensor > &input) const |
| virtual sphericalTensor | invTransform (const point &global, const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | invTransform (const UList< point > &global, const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | invTransform (const pointUIndList &global, const sphericalTensor &input) const |
| virtual tmp< Field< sphericalTensor > > | invTransform (const UList< point > &global, const UList< sphericalTensor > &input) const |
| virtual tmp< Field< sphericalTensor > > | invTransform (const pointUIndList &global, const UList< sphericalTensor > &input) const |
| virtual symmTensor | invTransform (const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | invTransform (const UList< symmTensor > &input) const |
| virtual symmTensor | invTransform (const point &global, const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | invTransform (const UList< point > &global, const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | invTransform (const pointUIndList &global, const symmTensor &input) const |
| virtual tmp< Field< symmTensor > > | invTransform (const UList< point > &global, const UList< symmTensor > &input) const |
| virtual tmp< Field< symmTensor > > | invTransform (const pointUIndList &global, const UList< symmTensor > &input) const |
| virtual tensor | invTransform (const tensor &input) const |
| virtual tmp< Field< tensor > > | invTransform (const UList< tensor > &input) const |
| virtual tensor | invTransform (const point &global, const tensor &input) const |
| virtual tmp< Field< tensor > > | invTransform (const UList< point > &global, const tensor &input) const |
| virtual tmp< Field< tensor > > | invTransform (const pointUIndList &global, const tensor &input) const |
| virtual tmp< Field< tensor > > | invTransform (const UList< point > &global, const UList< tensor > &input) const |
| virtual tmp< Field< tensor > > | invTransform (const pointUIndList &global, const UList< tensor > &input) const |
| template<class PointField > | |
| Foam::tmp< Foam::tensorField > | rotationsImpl (const PointField &global) const |
| template<class PointField > | |
| Foam::tmp< Foam::pointField > | transformPointImpl (const PointField &localCart) const |
| template<class PointField > | |
| Foam::tmp< Foam::pointField > | invTransformPointImpl (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< vectorField > | localToGlobal (const vectorField &local, bool translate) const |
| virtual vector | globalToLocal (const vector &global, bool translate) const |
| virtual tmp< vectorField > | globalToLocal (const vectorField &global, bool translate) const |
Protected Member Functions inherited from coordinateSystem | |
| template<class PointField > | |
| tmp< tensorField > | rotationsImpl (const PointField &global) const |
| Implementation for R() methods. More... | |
| template<class PointField > | |
| tmp< pointField > | transformPointImpl (const PointField &localCart) const |
| Implementation for transformPoint() methods. More... | |
| template<class PointField > | |
| tmp< pointField > | invTransformPointImpl (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... | |
| 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< coordinateSystem > | New (word modelType, const objectRegistry &obr, const dictionary &dict) |
| static autoPtr< coordinateSystem > | New (word modelType, const dictionary &dict) |
| Select construct the specified coordinate system type. More... | |
| static autoPtr< coordinateSystem > | New (const objectRegistry &obr, const dictionary &dict, const word &dictName="") |
| static autoPtr< coordinateSystem > | New (const dictionary &dict, const word &dictName="") |
| Select constructed from dictionary. More... | |
| static autoPtr< coordinateSystem > | New (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< coordinateRotation > | spec_ |
| 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... | |
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 |
Definition at line 71 of file cylindricalCS.H.
| cylindrical | ( | ) |
Construct null (identity coordinateSystem)
Definition at line 87 of file cylindricalCS.C.
|
default |
Copy construct.
|
default |
Move construct.
|
explicit |
Copy construct from another coordinateSystem type.
Definition at line 93 of file cylindricalCS.C.
|
explicit |
Move construct from another coordinateSystem type.
Definition at line 99 of file cylindricalCS.C.
|
explicit |
Move construct from autoPtr of another coordinateSystem type.
Definition at line 105 of file cylindricalCS.C.
| cylindrical | ( | const point & | origin, |
| const coordinateRotation & | crot | ||
| ) |
Construct from origin and rotation.
Definition at line 112 of file cylindricalCS.C.
| cylindrical | ( | const point & | origin, |
| const vector & | axis | ||
| ) |
Construct from origin and single axis.
Definition at line 122 of file cylindricalCS.C.
| cylindrical | ( | const word & | name, |
| const point & | origin, | ||
| const vector & | axis | ||
| ) |
Construct from origin and single axis.
Definition at line 132 of file cylindricalCS.C.
| cylindrical | ( | const point & | origin, |
| const vector & | axis, | ||
| const vector & | dirn | ||
| ) |
Construct from origin and two axes.
Definition at line 148 of file cylindricalCS.C.
| cylindrical | ( | const word & | name, |
| const point & | origin, | ||
| const vector & | axis, | ||
| const vector & | dirn | ||
| ) |
Construct from origin and two axes.
Definition at line 159 of file cylindricalCS.C.
| cylindrical | ( | const word & | name, |
| const dictionary & | dict | ||
| ) |
Construct from dictionary with a given name.
Definition at line 171 of file cylindricalCS.C.
References dict, and Foam::warnCompatDegrees().
|
explicit |
Construct from dictionary without a name.
Definition at line 185 of file cylindricalCS.C.
References dict, and Foam::warnCompatDegrees().
| cylindrical | ( | const dictionary & | dict, |
| const word & | dictName | ||
| ) |
Construct from dictionary with optional subDict lookup.
| dictName | If non-empty, the sub-dictionary to use. |
Definition at line 197 of file cylindricalCS.C.
References dict, dictName(), dictionary::getOrDefault(), and Foam::warnCompatDegrees().
|
virtualdefault |
Destructor.
|
protectedvirtual |
From local coordinate system to the global Cartesian system with optional translation for the origin
Reimplemented from coordinateSystem.
Definition at line 255 of file cylindricalCS.C.
References coordinateSystem::localToGlobal(), and Foam::toCartesian().
|
protectedvirtual |
From local coordinate system to the global Cartesian system with optional translation for the origin
Reimplemented from coordinateSystem.
Definition at line 269 of file cylindricalCS.C.
References coordinateSystem::localToGlobal(), tmp< T >::New(), and Foam::toCartesian().
|
protectedvirtual |
From global Cartesian system to the local coordinate system with optional translation for the origin
Reimplemented from coordinateSystem.
Definition at line 294 of file cylindricalCS.C.
References Foam::fromCartesian(), and coordinateSystem::globalToLocal().
|
protectedvirtual |
Convert from global Cartesian system to the local coordinate system with optional translation for the origin
Reimplemented from coordinateSystem.
Definition at line 307 of file cylindricalCS.C.
References Foam::fromCartesian(), coordinateSystem::globalToLocal(), and tmp< T >::ref().
| TypeNameNoDebug | ( | "cylindrical" | ) |
Runtime type information.
|
inlinevirtual |
Treat the rotation tensor as non-uniform.
Reimplemented from coordinateSystem.
Definition at line 195 of file cylindricalCS.H.
|
virtual |
Position-dependent rotation tensor at a single point
Reimplemented from coordinateSystem.
Definition at line 220 of file cylindricalCS.C.
References Tensor< Cmpt >::col(), and Foam::mag().
|
default |
Copy assignment.
|
default |
Move assignment.
|
inline |
Position-dependent rotation tensors at multiple points.
Definition at line 465 of file coordinateSystem.H.
Position-dependent rotation tensors at multiple points.
Definition at line 291 of file coordinateSystem.C.
Position-dependent rotation tensors at multiple points.
Definition at line 298 of file coordinateSystem.C.
Position-dependent rotation tensors at multiple points.
Definition at line 307 of file coordinateSystem.C.
|
static |
Global (identity) cylindrical coordinate system.
Definition at line 121 of file cylindricalCS.H.