A Cartesian coordinate system. More...
Public Member Functions | |
TypeNameNoDebug ("cartesian") | |
Runtime type information. More... | |
cartesian () | |
Default construct. This is an identity coordinate system. More... | |
cartesian (const cartesian &csys)=default | |
Copy construct. More... | |
cartesian (cartesian &&csys)=default | |
Move construct. More... | |
cartesian (const coordinateSystem &csys) | |
Copy construct from another coordinateSystem type. More... | |
cartesian (coordinateSystem &&csys) | |
Move construct from another coordinateSystem type. More... | |
cartesian (autoPtr< coordinateSystem > &&csys) | |
Move construct from autoPtr of another coordinateSystem type. More... | |
cartesian (const coordinateRotation &crot) | |
Copy construct from rotation with origin=0. More... | |
cartesian (coordinateRotation &&crot) | |
Move construct from rotation with origin=0. More... | |
cartesian (const point &origin, const coordinateRotation &crot) | |
Construct from origin and rotation. More... | |
cartesian (const point &origin, const vector &axis, const vector &dirn) | |
Construct from origin and 2 axes. More... | |
cartesian (const word &name, const point &origin, const vector &axis, const vector &dirn) | |
Construct from origin and 2 axes. More... | |
cartesian (const word &name, const dictionary &dict) | |
Construct from dictionary with a given name. More... | |
cartesian (const dictionary &dict) | |
Construct from dictionary without a name. More... | |
cartesian (const dictionary &dict, const word &dictName) | |
Construct from dictionary with optional subDict lookup. More... | |
virtual autoPtr< coordinateSystem > | clone () const |
Return clone. More... | |
virtual | ~cartesian ()=default |
Destructor. More... | |
cartesian & | operator= (const cartesian &)=default |
Copy assignment. More... | |
cartesian & | operator= (cartesian &&)=default |
Move assignment. More... | |
void | operator= (const coordinateSystem &csys) |
Copy/move assignment from coordinateSystem, autoPtr. More... | |
void | operator= (coordinateSystem &&csys) |
Copy/move assignment from coordinateSystem, autoPtr. More... | |
void | operator= (const autoPtr< coordinateSystem > &csys) |
Copy/move assignment from coordinateSystem, autoPtr. More... | |
void | operator= (autoPtr< coordinateSystem > &&csys) |
Copy/move assignment from coordinateSystem, autoPtr. More... | |
![]() | |
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... | |
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 bool | uniform () const |
True if the rotation tensor is uniform for all locations. 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 () |
Edit access to 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 tensor | R (const point &global) const |
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 |
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::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 cartesian | null |
Global (identity) cartesian coordinate system. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
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... | |
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 |
void | assign (const dictionary &dict) |
Assign from dictionary content. More... | |
coordinateSystem (std::nullptr_t) | |
![]() | |
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... | |
![]() | |
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 coordinateSystem | dummy_ |
Dummy coordinate system for suppressed manipulation. More... | |
A Cartesian coordinate system.
Dictionary entries
Property | Description | Required | Default |
---|---|---|---|
type | Type name: cartesian | yes |
Definition at line 69 of file cartesianCS.H.
cartesian | ( | ) |
Default construct. This is an identity coordinate system.
Definition at line 49 of file cartesianCS.C.
|
explicit |
Copy construct from another coordinateSystem type.
Definition at line 55 of file cartesianCS.C.
|
explicit |
Move construct from another coordinateSystem type.
Definition at line 61 of file cartesianCS.C.
|
explicit |
Move construct from autoPtr of another coordinateSystem type.
Definition at line 67 of file cartesianCS.C.
|
explicit |
Copy construct from rotation with origin=0.
Definition at line 73 of file cartesianCS.C.
|
explicit |
Move construct from rotation with origin=0.
cartesian | ( | const point & | origin, |
const coordinateRotation & | crot | ||
) |
Construct from origin and rotation.
Definition at line 80 of file cartesianCS.C.
Construct from origin and 2 axes.
Definition at line 90 of file cartesianCS.C.
Construct from origin and 2 axes.
Definition at line 101 of file cartesianCS.C.
cartesian | ( | const word & | name, |
const dictionary & | dict | ||
) |
Construct from dictionary with a given name.
Definition at line 113 of file cartesianCS.C.
|
explicit |
Construct from dictionary without a name.
Definition at line 122 of file cartesianCS.C.
cartesian | ( | 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 129 of file cartesianCS.C.
|
virtualdefault |
Destructor.
TypeNameNoDebug | ( | "cartesian" | ) |
Runtime type information.
|
inlinevirtual |
void operator= |
Copy/move assignment from coordinateSystem, autoPtr.
Definition at line 468 of file coordinateSystem.C.
void operator= |
Copy/move assignment from coordinateSystem, autoPtr.
Definition at line 487 of file coordinateSystem.C.
void operator= |
Copy/move assignment from coordinateSystem, autoPtr.
Definition at line 497 of file coordinateSystem.C.
void operator= |
Copy/move assignment from coordinateSystem, autoPtr.
Definition at line 503 of file coordinateSystem.C.
|
static |
Global (identity) cartesian coordinate system.
Definition at line 82 of file cartesianCS.H.