OpenFOAM logo
Open Source CFD Toolkit

coordinateSystem Class Reference

Inheritance diagram for coordinateSystem:

Inheritance graph
[legend]
Collaboration diagram for coordinateSystem:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("coordinateSystem")
 Runtime type information.
 coordinateSystem (const word &name, const vector &origin, const vector &axis, const vector &dir)
 Construct from origin and 2 axes.
 coordinateSystem (const word &name, const vector &origin, const coordinateRotation &cr)
 Construct from origin and rotation angles.
 coordinateSystem (const word &name, const dictionary &dict)
 Construct from dictionary.
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, origAxisDir,(const word &name, const vector &origin, const vector &axis, const vector &dir),(name, origin, axis, dir))
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, origRotation,(const word &name, const vector &origin, const coordinateRotation &cr),(name, origin, cr))
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const word &name, const dictionary &dict),(name, dict))
virtual ~coordinateSystem ()
const wordname () const
 Return name.
const vectororigin () const
 Return origin.
const vectoraxis () const
 Return axis.
const vectordirection () const
 Return direction.
virtual vector toGlobal (const vector &localV) const =0
 Convert from local coordinate system to the global Cartesian system.
virtual tmp< vectorFieldtoGlobal (const vectorField &localV) const =0
virtual vector toLocal (const vector &globalV) const =0
 Convert from global Cartesian system to the local coordinate system.
virtual tmp< vectorFieldtoLocal (const vectorField &globalV) const =0
virtual void write (Ostream &) const
 Write.
virtual void writeDict (Ostream &) const
 Write dictionary.

Static Public Member Functions

autoPtr< coordinateSystemNew (const word &coordType, const word &name, const vector &origin, const vector &axis, const vector &dir)
 Select constructed from origin and 2 axes.
autoPtr< coordinateSystemNew (const word &coordType, const word &name, const vector &origin, const coordinateRotation &cr)
 Select constructed from origin and rotation.
autoPtr< coordinateSystemNew (const word &name, const dictionary &dict)
 Select constructed from Istream.

Friends

Ostreamoperator<< (Ostream &, const coordinateSystem &)

Constructor & Destructor Documentation

coordinateSystem const word name,
const vector origin,
const vector axis,
const vector dir
 

Construct from origin and 2 axes.

coordinateSystem const word name,
const vector origin,
const coordinateRotation cr
 

Construct from origin and rotation angles.

coordinateSystem const word name,
const dictionary dict
 

Construct from dictionary.

virtual ~coordinateSystem  )  [virtual]
 


Member Function Documentation

const vector& axis  )  const [inline]
 

Return axis.

Definition at line 205 of file coordinateSystem.H.

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

declareRunTimeSelectionTable autoPtr  ,
coordinateSystem  ,
origRotation  ,
(const word &name, const vector &origin, const coordinateRotation &cr)  ,
(name, origin, cr) 
 

declareRunTimeSelectionTable autoPtr  ,
coordinateSystem  ,
origAxisDir  ,
(const word &name, const vector &origin, const vector &axis, const vector &dir)  ,
(name, origin, axis, dir) 
 

const vector& direction  )  const [inline]
 

Return direction.

Definition at line 211 of file coordinateSystem.H.

References Foam::vector, and Foam::vectorField.

const word& name  )  const [inline]
 

Return name.

Definition at line 193 of file coordinateSystem.H.

autoPtr<coordinateSystem> New const word name,
const dictionary dict
[static]
 

Select constructed from Istream.

autoPtr<coordinateSystem> New const word coordType,
const word name,
const vector origin,
const coordinateRotation cr
[static]
 

Select constructed from origin and rotation.

autoPtr<coordinateSystem> New const word coordType,
const word name,
const vector origin,
const vector axis,
const vector dir
[static]
 

Select constructed from origin and 2 axes.

const vector& origin  )  const [inline]
 

Return origin.

Definition at line 199 of file coordinateSystem.H.

virtual tmp<vectorField> toGlobal const vectorField localV  )  const [pure virtual]
 

Implemented in cartesianCS, cylindricalCS, parabolicCylindricalCS, sphericalCS, and toroidalCS.

virtual vector toGlobal const vector localV  )  const [pure virtual]
 

Convert from local coordinate system to the global Cartesian system.

Implemented in cartesianCS, cylindricalCS, parabolicCylindricalCS, sphericalCS, and toroidalCS.

virtual tmp<vectorField> toLocal const vectorField globalV  )  const [pure virtual]
 

Implemented in cartesianCS, cylindricalCS, parabolicCylindricalCS, sphericalCS, and toroidalCS.

virtual vector toLocal const vector globalV  )  const [pure virtual]
 

Convert from global Cartesian system to the local coordinate system.

Implemented in cartesianCS, cylindricalCS, parabolicCylindricalCS, sphericalCS, and toroidalCS.

TypeName "coordinateSystem"   ) 
 

Runtime type information.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented in toroidalCS.

virtual void writeDict Ostream  )  const [virtual]
 

Write dictionary.

Reimplemented in toroidalCS.


Friends And Related Function Documentation

Ostream& operator<< Ostream ,
const coordinateSystem
[friend]
 


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org