FreeFOAM The Cross-Platform CFD Toolkit
toroidalCS Class Reference

Toroidal coordinate system, always in degrees. More...

#include <meshTools/toroidalCS.H>


Detailed Description

Toroidal coordinate system, always in degrees.

Note:
The maintenance of this class may lag that of the main types.
Source files

Definition at line 53 of file toroidalCS.H.

+ Inheritance diagram for toroidalCS:
+ Collaboration diagram for toroidalCS:

List of all members.

Public Member Functions

 TypeName ("toroidal")
 Runtime type information.
 toroidalCS (const word &name, const point &origin, const coordinateRotation &, const scalar radius)
 Construct from origin, rotation and radius.
 toroidalCS (const word &name, const dictionary &)
 Construct from dictionary.
scalar radius () const
 Return radius.
virtual void write (Ostream &) const
 Write.
virtual void writeDict (Ostream &, bool subDict=true) const
 Write dictionary.
- Public Member Functions inherited from coordinateSystem
 TypeName ("coordinateSystem")
 Runtime type information.
 coordinateSystem ()
 Construct null. This is equivalent to an identity coordinateSystem.
 coordinateSystem (const word &name, const coordinateSystem &)
 Construct copy with a different name.
 coordinateSystem (const word &name, const point &origin, const coordinateRotation &)
 Construct from origin and rotation.
 coordinateSystem (const word &name, const point &origin, const vector &axis, const vector &dirn)
 Construct from origin and 2 axes.
 coordinateSystem (const word &name, const dictionary &)
 Construct from dictionary with a given name.
 coordinateSystem (const dictionary &)
 Construct from dictionary with default name.
 coordinateSystem (const dictionary &, const objectRegistry &)
 Construct from dictionary (default name)
 coordinateSystem (Istream &)
 Construct from Istream.
autoPtr< coordinateSystemclone () const
 Return clone.
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const word &name, const dictionary &dict),(name, dict))
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, origRotation,(const word &name, const point &origin, const coordinateRotation &cr),(name, origin, cr))
virtual ~coordinateSystem ()
const wordname () const
 Return name.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
const pointorigin () const
 Return origin.
const coordinateRotationrotation () const
 Return coordinate rotation.
const tensorR () const
 Return local-to-global transformation tensor.
const vector e1 () const
 Return local Cartesian x-axis.
const vector e2 () const
 Return local Cartesian y-axis.
const vector e3 () const
 Return local Cartesian z-axis.
const vector axis () const
 Return axis (e3: local Cartesian z-axis)
const vector direction () const
 Return direction (e1: local Cartesian x-axis)
virtual dictionary dict (bool ignoreType=false) const
 Return as dictionary of entries.
virtual void rename (const word &newName)
 Rename.
pointorigin ()
 Edit access to origin.
point globalPosition (const point &local) const
 Convert from position in local coordinate system to global Cartesian position.
tmp< pointFieldglobalPosition (const pointField &local) const
 Convert from position in local coordinate system to global Cartesian position.
vector globalVector (const vector &local) const
 Convert from vector components in local coordinate system to global Cartesian vector.
tmp< vectorFieldglobalVector (const vectorField &local) const
 Convert from vector components in local coordinate system to global Cartesian vector.
point localPosition (const point &global) const
 Convert from global Cartesian position to position in local coordinate system.
tmp< pointFieldlocalPosition (const pointField &global) const
 Convert from global Cartesian position to position in local coordinate system.
vector localVector (const vector &global) const
 Convert from global Cartesian vector to components in local coordinate system.
tmp< vectorFieldlocalVector (const vectorField &global) const
 Convert from global Cartesian vector to components in local coordinate system.
void operator= (const dictionary &)
 assign from dictionary

Additional Inherited Members

- Static Public Member Functions inherited from coordinateSystem
static autoPtr< coordinateSystemNew (const word &name, const dictionary &)
 Select constructed from dictionary.
static autoPtr< coordinateSystemNew (const word &coordType, const word &name, const point &origin, const coordinateRotation &)
 Select constructed from origin and rotation.
static autoPtr< coordinateSystemNew (Istream &is)
 Select constructed from Istream.

Constructor & Destructor Documentation

toroidalCS ( const word name,
const point origin,
const coordinateRotation cr,
const scalar  radius 
)

Construct from origin, rotation and radius.

Definition at line 42 of file toroidalCS.C.

toroidalCS ( const word name,
const dictionary dict 
)

Construct from dictionary.

Definition at line 55 of file toroidalCS.C.


Member Function Documentation

TypeName ( "toroidal"  )

Runtime type information.

scalar radius ( ) const
inline

Return radius.

Definition at line 113 of file toroidalCS.H.

void write ( Ostream os) const
virtual

Write.

Reimplemented from coordinateSystem.

Definition at line 149 of file toroidalCS.C.

References Foam::endl(), and coordinateSystem::write().

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

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