coordinateSystem Class Reference

Base class for other coordinate system specifications. More...

Inheritance diagram for coordinateSystem:

Public Member Functions

 TypeName ("coordinateSystem")
 Runtime type information. More...
 
 coordinateSystem (const word &name, const point &origin)
 Construct from origin. More...
 
 coordinateSystem (const word &name, const point &origin, const coordinateRotation &)
 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 &)
 Construct from dictionary with a given name. More...
 
 coordinateSystem (const coordinateSystem &cs)
 Copy constructor. More...
 
virtual autoPtr< coordinateSystemclone () const
 Construct and return a clone. More...
 
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const word &name, const dictionary &dict),(name, dict))
 
virtual ~coordinateSystem ()
 Destructor. More...
 
const wordname () const
 Return name. More...
 
const wordkeyword () const
 Return keyword. More...
 
const pointorigin () const
 Return origin. More...
 
const coordinateRotationR () const
 Return const reference to co-ordinate rotation. More...
 
const coordinateRotationR (const UList< vector > &points) const
 Update and return the co-ordinate rotation for a list of points. More...
 
virtual void write (Ostream &) const
 Write. More...
 
void writeDict (Ostream &, bool subDict=true) const
 Write dictionary. More...
 
point globalPosition (const point &local) const
 Convert from position in local coordinate system to global. More...
 
tmp< pointFieldglobalPosition (const pointField &local) const
 Convert from position in local coordinate system to global. More...
 
vector globalVector (const vector &local) const
 Convert from vector components in local coordinate system to. More...
 
tmp< vectorFieldglobalVector (const vectorField &local) const
 Convert from vector components in local coordinate system to. More...
 
point localPosition (const point &global) const
 Convert from global Cartesian position to position in local. More...
 
tmp< pointFieldlocalPosition (const pointField &global) const
 Convert from global Cartesian position to position in local. More...
 
vector localVector (const vector &global) const
 Convert from global Cartesian vector to components in local. More...
 
tmp< vectorFieldlocalVector (const vectorField &global) const
 Convert from global Cartesian vector to components in local. More...
 
void operator= (const coordinateSystem &)
 Assignment operator. More...
 

Static Public Member Functions

static autoPtr< coordinateSystemNew (const objectRegistry &obr, const dictionary &dict)
 Select constructed from dictionary and objectRegistry. More...
 
static autoPtr< coordinateSystemNew (const word &name, const dictionary &dict)
 Select constructed from name and dictionary. More...
 

Protected Member Functions

virtual vector localToGlobal (const vector &, bool translate) const
 Convert from local coordinate system to the global Cartesian system. More...
 
virtual tmp< vectorFieldlocalToGlobal (const vectorField &, bool translate) const
 Convert from local coordinate system to the global Cartesian system. More...
 
virtual vector globalToLocal (const vector &, bool translate) const
 Convert from global Cartesian system to the local coordinate system. More...
 
virtual tmp< vectorFieldglobalToLocal (const vectorField &, bool translate) const
 Convert from global Cartesian system to the local coordinate system. More...
 

Friends

Ostreamoperator<< (Ostream &, const coordinateSystem &)
 

Detailed Description

Base class for other coordinate system specifications.

All systems are defined by an origin point and a co-ordinate rotation.

coordinateSystem
{
    type    cartesian;
    origin  (0 0 0);
    coordinateRotation
    {
        type        cylindrical;
        e3          (0 0 1);
    }
}

Types of coordinateRotation:

  1. axesRotation
  2. STARCDRotation
  3. cylindricalCS cylindrical
  4. EulerCoordinateRotation

Type of co-ordinates:

  1. cartesianCS cartesian
Source files

Definition at line 83 of file coordinateSystem.H.

Constructor & Destructor Documentation

◆ coordinateSystem() [1/5]

coordinateSystem ( const word name,
const point origin 
)

Construct from origin.

Definition at line 41 of file coordinateSystem.C.

Referenced by coordinateSystem::clone().

Here is the caller graph for this function:

◆ coordinateSystem() [2/5]

coordinateSystem ( const word name,
const point origin,
const coordinateRotation cr 
)

Construct from origin and rotation.

Definition at line 53 of file coordinateSystem.C.

◆ coordinateSystem() [3/5]

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

Construct from origin and 2 axes.

Definition at line 66 of file coordinateSystem.C.

◆ coordinateSystem() [4/5]

coordinateSystem ( const word name,
const dictionary dict 
)

Construct from dictionary with a given name.

Definition at line 80 of file coordinateSystem.C.

◆ coordinateSystem() [5/5]

Copy constructor.

Definition at line 92 of file coordinateSystem.C.

◆ ~coordinateSystem()

~coordinateSystem ( )
virtual

Destructor.

Definition at line 102 of file coordinateSystem.C.

Member Function Documentation

◆ localToGlobal() [1/2]

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

Convert from local coordinate system to the global Cartesian system.

with optional translation for the origin

Definition at line 108 of file coordinateSystem.C.

◆ localToGlobal() [2/2]

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

Convert from local coordinate system to the global Cartesian system.

with optional translation for the origin

Definition at line 125 of file coordinateSystem.C.

◆ globalToLocal() [1/2]

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

Convert from global Cartesian system to the local coordinate system.

with optional translation for the origin

Definition at line 142 of file coordinateSystem.C.

◆ 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

Definition at line 159 of file coordinateSystem.C.

◆ TypeName()

TypeName ( "coordinateSystem"  )

Runtime type information.

◆ clone()

virtual autoPtr<coordinateSystem> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented in cylindrical, and cartesian.

Definition at line 165 of file coordinateSystem.H.

References coordinateSystem::coordinateSystem().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
coordinateSystem  ,
dictionary  ,
(const word &name, const dictionary &dict ,
(name, dict  
)

◆ New() [1/2]

◆ New() [2/2]

Foam::autoPtr< Foam::coordinateSystem > New ( const word name,
const dictionary dict 
)
static

Select constructed from name and dictionary.

Definition at line 91 of file coordinateSystemNew.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookup(), Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ name()

const word& name ( ) const
inline

Return name.

Definition at line 211 of file coordinateSystem.H.

Referenced by coordinateSystem::New().

Here is the caller graph for this function:

◆ keyword()

const word& keyword ( ) const
inline

Return keyword.

Definition at line 217 of file coordinateSystem.H.

◆ origin()

const point& origin ( ) const
inline

Return origin.

Definition at line 223 of file coordinateSystem.H.

◆ R() [1/2]

const coordinateRotation& R ( ) const
inline

Return const reference to co-ordinate rotation.

Definition at line 229 of file coordinateSystem.H.

Referenced by fieldCoordinateSystemTransform::transformField().

Here is the caller graph for this function:

◆ R() [2/2]

const coordinateRotation& R ( const UList< vector > &  points) const
inline

Update and return the co-ordinate rotation for a list of points.

Definition at line 235 of file coordinateSystem.H.

References points.

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 176 of file coordinateSystem.C.

References Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ writeDict()

void writeDict ( Ostream os,
bool  subDict = true 
) const

Write dictionary.

Definition at line 183 of file coordinateSystem.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::nl, Foam::type(), and Foam::writeEntry().

Referenced by Foam::operator<<().

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

◆ globalPosition() [1/2]

point globalPosition ( const point local) const
inline

Convert from position in local coordinate system to global.

Cartesian position

Definition at line 255 of file coordinateSystem.H.

◆ globalPosition() [2/2]

tmp<pointField> globalPosition ( const pointField local) const
inline

Convert from position in local coordinate system to global.

Cartesian position

Definition at line 262 of file coordinateSystem.H.

◆ globalVector() [1/2]

vector globalVector ( const vector local) const
inline

Convert from vector components in local coordinate system to.

global Cartesian vector

Definition at line 269 of file coordinateSystem.H.

◆ globalVector() [2/2]

tmp<vectorField> globalVector ( const vectorField local) const
inline

Convert from vector components in local coordinate system to.

global Cartesian vector

Definition at line 276 of file coordinateSystem.H.

◆ localPosition() [1/2]

point localPosition ( const point global) const
inline

Convert from global Cartesian position to position in local.

coordinate system

Definition at line 283 of file coordinateSystem.H.

◆ localPosition() [2/2]

tmp<pointField> localPosition ( const pointField global) const
inline

Convert from global Cartesian position to position in local.

coordinate system

Definition at line 290 of file coordinateSystem.H.

◆ localVector() [1/2]

vector localVector ( const vector global) const
inline

Convert from global Cartesian vector to components in local.

coordinate system

Definition at line 297 of file coordinateSystem.H.

◆ localVector() [2/2]

tmp<vectorField> localVector ( const vectorField global) const
inline

Convert from global Cartesian vector to components in local.

coordinate system

Definition at line 304 of file coordinateSystem.H.

◆ operator=()

void operator= ( const coordinateSystem cs)

Assignment operator.

Definition at line 209 of file coordinateSystem.C.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const coordinateSystem  
)
friend

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