Public Member Functions | Protected Member Functions | List of all members
indirect Class Reference

A coordinate system forward to a global coordinate system that is normally provided by the constant/coordinateSystems file. More...

Inheritance diagram for indirect:
Inheritance graph
[legend]
Collaboration diagram for indirect:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("indirect")
 
 indirect (const indirect &csys)
 
 indirect (indirect &&csys)
 
 indirect (const objectRegistry &obr, const word &name)
 
 indirect (const objectRegistry &obr, const dictionary &dict)
 
virtual autoPtr< coordinateSystemclone () const
 
virtual ~indirect ()=default
 
virtual const coordinateSystemcs () const
 
virtual bool valid () const
 
virtual bool uniform () const
 
virtual const coordinateRotationrotation () const
 
virtual const wordname () const
 
virtual const stringnote () const
 
virtual const pointorigin () const
 
virtual const tensorR () const
 
virtual const vector e1 () const
 
virtual const vector e2 () const
 
virtual const vector e3 () const
 
void rename (const word &newName)
 
stringnote ()
 
virtual pointorigin ()
 
virtual void clear ()
 
virtual void rotation (autoPtr< coordinateRotation > &&crot)
 
virtual void write (Ostream &os) const
 
virtual void writeEntry (const word &keyword, Ostream &os) const
 
void operator= (const coordinateSystem &csys)=delete
 
void operator= (coordinateSystem &&csys)=delete
 
virtual tensor R (const point &global) const
 
virtual tmp< tensorFieldR (const UList< point > &global) const
 
virtual tmp< tensorFieldR (const pointUIndList &global) const
 
- Public Member Functions inherited from coordinateSystem
 TypeName ("coordinateSystem")
 
 coordinateSystem ()
 
 coordinateSystem (const coordinateRotation &crot)
 
 coordinateSystem (coordinateRotation &&crot)
 
 coordinateSystem (const coordinateSystem &csys)
 
 coordinateSystem (coordinateSystem &&csys)
 
 coordinateSystem (autoPtr< coordinateSystem > &&csys)
 
 coordinateSystem (const word &name, const coordinateSystem &csys)
 
 coordinateSystem (const point &origin, const coordinateRotation &crot)
 
 coordinateSystem (const point &origin, const vector &axis, const vector &dirn)
 
 coordinateSystem (const word &name, const point &origin, const coordinateRotation &crot)
 
 coordinateSystem (const word &name, const point &origin, const vector &axis, const vector &dirn)
 
 coordinateSystem (const word &name, const dictionary &dict)
 
 coordinateSystem (const dictionary &dict)
 
 coordinateSystem (const dictionary &dict, const word &dictName)
 
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const dictionary &dict),(dict))
 
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, registry,(const objectRegistry &obr, const dictionary &dict),(obr, dict))
 
virtual ~coordinateSystem ()=default
 
void operator= (const coordinateSystem &csys)
 
void operator= (coordinateSystem &&csys)
 
void operator= (const autoPtr< coordinateSystem > &csys)
 
void operator= (autoPtr< coordinateSystem > &&csys)
 
point transformPoint (const point &localCart) const
 
tmp< pointFieldtransformPoint (const UList< point > &localCart) const
 
tmp< pointFieldtransformPoint (const pointUIndList &localCart) const
 
point invTransformPoint (const point &global) const
 
tmp< pointFieldinvTransformPoint (const UList< point > &global) const
 
tmp< pointFieldinvTransformPoint (const pointUIndList &global) const
 
point globalPosition (const point &local) const
 
tmp< pointFieldglobalPosition (const pointField &local) const
 
point localPosition (const point &global) const
 
tmp< pointFieldlocalPosition (const pointField &global) const
 
vector globalVector (const vector &local) const
 
tmp< vectorFieldglobalVector (const vectorField &local) const
 
vector localVector (const vector &global) const
 
tmp< vectorFieldlocalVector (const vectorField &global) const
 
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
 

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
 
template<class PointField >
tmp< pointFieldtransformPointImpl (const PointField &localCart) const
 
template<class PointField >
tmp< pointFieldinvTransformPointImpl (const PointField &global) const
 
template<class RetType , class PointField , class Type , class BinaryOp >
tmp< Field< RetType > > oneToOneImpl (const PointField &global, const UList< Type > &input, const BinaryOp &bop) const
 
template<class RetType , class PointField , class Type , class BinaryOp >
tmp< Field< RetType > > oneToManyImpl (const PointField &global, const Type &input, const BinaryOp &bop) const
 
void assign (const dictionary &dict)
 
 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)
 
static autoPtr< coordinateSystemNew (const objectRegistry &obr, const dictionary &dict, const word &dictName="")
 
static autoPtr< coordinateSystemNew (const dictionary &dict, const word &dictName="")
 
static autoPtr< coordinateSystemNew (Istream &is)
 
- 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)
 
- Protected Attributes inherited from coordinateSystem
autoPtr< coordinateRotationspec_
 
point origin_
 
tensor rot_
 
word name_
 
string note_
 
- Static Protected Attributes inherited from coordinateSystem
static coordinateSystem dummy_
 

Detailed Description

A coordinate system forward to a global coordinate system that is normally provided by the constant/coordinateSystems file.


Dictionary entries

Property Description Required Default
type Type name: indirect yes
name Name of the referenced system yes
Source files

Definition at line 71 of file indirectCS.H.

Constructor & Destructor Documentation

◆ indirect() [1/4]

indirect ( const indirect csys)

Definition at line 39 of file indirectCS.C.

◆ indirect() [2/4]

indirect ( indirect &&  csys)

Definition at line 46 of file indirectCS.C.

◆ indirect() [3/4]

indirect ( const objectRegistry obr,
const word name 
)

Definition at line 55 of file indirectCS.C.

◆ indirect() [4/4]

indirect ( const objectRegistry obr,
const dictionary dict 
)

Definition at line 66 of file indirectCS.C.

◆ ~indirect()

virtual ~indirect ( )
virtualdefault

Member Function Documentation

◆ localToGlobal() [1/2]

virtual vector localToGlobal ( const vector local,
bool  translate 
) const
inlineprotectedvirtual

Reimplemented from coordinateSystem.

Definition at line 94 of file indirectCS.H.

References coordinateSystem::localToGlobal().

Here is the call graph for this function:

◆ localToGlobal() [2/2]

virtual tmp<vectorField> localToGlobal ( const vectorField local,
bool  translate 
) const
inlineprotectedvirtual

Reimplemented from coordinateSystem.

Definition at line 105 of file indirectCS.H.

References coordinateSystem::localToGlobal().

Here is the call graph for this function:

◆ globalToLocal() [1/2]

virtual vector globalToLocal ( const vector global,
bool  translate 
) const
inlineprotectedvirtual

Reimplemented from coordinateSystem.

Definition at line 116 of file indirectCS.H.

References coordinateSystem::globalToLocal().

Here is the call graph for this function:

◆ globalToLocal() [2/2]

virtual tmp<vectorField> globalToLocal ( const vectorField global,
bool  translate 
) const
inlineprotectedvirtual

Reimplemented from coordinateSystem.

Definition at line 127 of file indirectCS.H.

References coordinateSystem::globalToLocal().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "indirect"  )

◆ clone()

virtual autoPtr<coordinateSystem> clone ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 157 of file indirectCS.H.

◆ cs()

virtual const coordinateSystem& cs ( ) const
inlinevirtual

Definition at line 172 of file indirectCS.H.

◆ valid()

virtual bool valid ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 178 of file indirectCS.H.

References coordinateSystem::valid().

Here is the call graph for this function:

◆ uniform()

virtual bool uniform ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 184 of file indirectCS.H.

References coordinateSystem::uniform().

Here is the call graph for this function:

◆ rotation() [1/2]

virtual const coordinateRotation& rotation ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 190 of file indirectCS.H.

References coordinateSystem::rotation().

Here is the call graph for this function:

◆ name()

virtual const word& name ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 196 of file indirectCS.H.

References coordinateSystem::name_.

◆ note() [1/2]

virtual const string& note ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 202 of file indirectCS.H.

References coordinateSystem::note().

Here is the call graph for this function:

◆ origin() [1/2]

virtual const point& origin ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 208 of file indirectCS.H.

References coordinateSystem::origin().

Here is the call graph for this function:

◆ R() [1/4]

virtual const tensor& R ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 214 of file indirectCS.H.

References coordinateSystem::R().

Here is the call graph for this function:

◆ e1()

virtual const vector e1 ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 220 of file indirectCS.H.

References coordinateSystem::e1().

Here is the call graph for this function:

◆ e2()

virtual const vector e2 ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 226 of file indirectCS.H.

References coordinateSystem::e2().

Here is the call graph for this function:

◆ e3()

virtual const vector e3 ( ) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 232 of file indirectCS.H.

References coordinateSystem::e3().

Here is the call graph for this function:

◆ rename()

void rename ( const word newName)
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 241 of file indirectCS.H.

◆ note() [2/2]

string& note ( )
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 244 of file indirectCS.H.

References coordinateSystem::dummy_, coordinateSystem::note(), and NotImplemented.

Here is the call graph for this function:

◆ origin() [2/2]

virtual point& origin ( )
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 251 of file indirectCS.H.

References coordinateSystem::dummy_, NotImplemented, and coordinateSystem::origin().

Here is the call graph for this function:

◆ clear()

virtual void clear ( )
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 258 of file indirectCS.H.

◆ rotation() [2/2]

virtual void rotation ( autoPtr< coordinateRotation > &&  crot)
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 261 of file indirectCS.H.

References NotImplemented.

◆ write()

void write ( Ostream os) const
virtual

Reimplemented from coordinateSystem.

Definition at line 77 of file indirectCS.C.

References os().

Here is the call graph for this function:

◆ writeEntry()

void writeEntry ( const word keyword,
Ostream os 
) const
virtual

Reimplemented from coordinateSystem.

Definition at line 84 of file indirectCS.C.

References Foam::name(), os(), and Foam::type().

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const coordinateSystem csys)
delete

◆ operator=() [2/2]

void operator= ( coordinateSystem &&  csys)
delete

◆ R() [2/4]

virtual tensor R ( const point global) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 288 of file indirectCS.H.

References coordinateSystem::R().

Here is the call graph for this function:

◆ R() [3/4]

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

Reimplemented from coordinateSystem.

Definition at line 294 of file indirectCS.H.

References coordinateSystem::R().

Here is the call graph for this function:

◆ R() [4/4]

virtual tmp<tensorField> R ( const pointUIndList global) const
inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 300 of file indirectCS.H.

References coordinateSystem::R().

Here is the call graph for this function:

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