cylindrical Class Reference

Cylindrical coordinate system. More...

Inheritance diagram for cylindrical:
Collaboration diagram for cylindrical:

Public Member Functions

 TypeName ("cylindrical")
 Runtime type information. More...
 
 cylindrical (const word &name, const point &origin, const coordinateRotation &, const bool inDegrees=true)
 Construct from origin and rotation. More...
 
 cylindrical (const word &name, const point &origin, const vector &axis, const vector &dirn, const bool inDegrees=true)
 Construct from origin and 2 axes. More...
 
 cylindrical (const word &, const dictionary &)
 Construct from dictionary and name. More...
 
virtual autoPtr< coordinateSystemclone () const
 Construct and return a clone. More...
 
virtual ~cylindrical ()
 Destructor. More...
 
- Public Member Functions inherited from coordinateSystem
 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...
 
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from coordinateSystem
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...
 

Detailed Description

Cylindrical coordinate system.

Source files

Definition at line 50 of file cylindricalCS.H.

Constructor & Destructor Documentation

◆ cylindrical() [1/3]

cylindrical ( const word name,
const point origin,
const coordinateRotation cr,
const bool  inDegrees = true 
)

Construct from origin and rotation.

Definition at line 146 of file cylindricalCS.C.

Referenced by cylindrical::clone().

Here is the caller graph for this function:

◆ cylindrical() [2/3]

cylindrical ( const word name,
const point origin,
const vector axis,
const vector dirn,
const bool  inDegrees = true 
)

Construct from origin and 2 axes.

Definition at line 159 of file cylindricalCS.C.

◆ cylindrical() [3/3]

cylindrical ( const word name,
const dictionary dict 
)

Construct from dictionary and name.

Definition at line 173 of file cylindricalCS.C.

◆ ~cylindrical()

~cylindrical ( )
virtual

Destructor.

Definition at line 186 of file cylindricalCS.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cylindrical"  )

Runtime type information.

◆ clone()

virtual autoPtr<coordinateSystem> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from coordinateSystem.

Definition at line 119 of file cylindricalCS.H.

References cylindrical::cylindrical().

Here is the call graph for this function:

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