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

Cylindrical coordinate system. More...

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

Public Member Functions

 cylindricalCS (const bool inDegrees=true)
 Construct null. More...
 
 cylindricalCS (const coordinateSystem &, const bool inDegrees=true)
 Construct copy. More...
 
 cylindricalCS (const word &name, const coordinateSystem &, const bool inDegrees=true)
 Construct copy with a different name. More...
 
 cylindricalCS (const word &name, const point &origin, const coordinateRotation &, const bool inDegrees=true)
 Construct from origin and rotation. More...
 
 cylindricalCS (const word &name, const point &origin, const vector &axis, const vector &dirn, const bool inDegrees=true)
 Construct from origin and 2 axes. More...
 
 cylindricalCS (const word &, const dictionary &)
 Construct from dictionary and name. More...
 
 cylindricalCS (const objectRegistry &, const dictionary &)
 Construct from dictionary and objectRegistry. More...
 
virtual ~cylindricalCS ()
 Destructor. More...
 
bool inDegrees () const
 Are angles in degrees? More...
 
bool & inDegrees ()
 Non-const access to inDegrees. More...
 
- Public Member Functions inherited from coordinateSystem
 TypeName ("coordinateSystem")
 Runtime type information. More...
 
 coordinateSystem ()
 Construct null. This is equivalent to an identity coordinateSystem. More...
 
 coordinateSystem (const word &name, const coordinateSystem &)
 Construct copy with a different name. 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 dictionary &)
 Construct from dictionary with default name. More...
 
 coordinateSystem (const objectRegistry &, const dictionary &)
 Construct from dictionary (default name) More...
 
 coordinateSystem (Istream &)
 Construct from Istream. More...
 
autoPtr< coordinateSystemclone () const
 Return clone. More...
 
 declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,( const objectRegistry &obr, const dictionary &dict ),(obr, dict))
 
virtual ~coordinateSystem ()
 Destructor. More...
 
const wordname () const
 Return name. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
const pointorigin () const
 Return origin. More...
 
const coordinateRotationR () const
 Return const reference to co-ordinate rotation. More...
 
coordinateRotationR ()
 Return non const reference to co-ordinate rotation. More...
 
const coordinateRotationR (const polyMesh &mesh, const labelList &cells)
 Update and return the co-ordinate roation for a list of cells. More...
 
virtual dictionary dict (bool ignoreType=false) const
 Return as dictionary of entries. More...
 
void rename (const word &newName)
 Rename. More...
 
pointorigin ()
 Edit access to origin. More...
 
virtual void clear ()
 Reset origin and rotation to an identity coordinateSystem. 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...
 

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...
 
- Protected Member Functions inherited from coordinateSystem
void init (const dictionary &)
 Init from dict and obr. More...
 
void init (const dictionary &, const objectRegistry &)
 Init from dictionary. 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 dictionary &dict)
 Select constructed from dictionary. More...
 
static autoPtr< coordinateSystemNew (Istream &is)
 Select constructed from Istream. More...
 

Detailed Description

Cylindrical coordinate system.

Source files

Definition at line 48 of file cylindricalCS.H.

Constructor & Destructor Documentation

cylindricalCS ( const bool  inDegrees = true)

Construct null.

Definition at line 35 of file cylindricalCS.C.

Referenced by cylindricalCS::cylindricalCS().

Here is the caller graph for this function:

cylindricalCS ( const coordinateSystem cs,
const bool  inDegrees = true 
)

Construct copy.

Definition at line 43 of file cylindricalCS.C.

References cylindricalCS::cylindricalCS().

Here is the call graph for this function:

cylindricalCS ( const word name,
const coordinateSystem cs,
const bool  inDegrees = true 
)

Construct copy with a different name.

Definition at line 54 of file cylindricalCS.C.

References cylindricalCS::cylindricalCS().

Here is the call graph for this function:

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

Construct from origin and rotation.

Definition at line 66 of file cylindricalCS.C.

References cylindricalCS::cylindricalCS().

Here is the call graph for this function:

cylindricalCS ( 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 79 of file cylindricalCS.C.

References cylindricalCS::cylindricalCS().

Here is the call graph for this function:

cylindricalCS ( const word name,
const dictionary dict 
)

Construct from dictionary and name.

Definition at line 93 of file cylindricalCS.C.

References cylindricalCS::cylindricalCS().

Here is the call graph for this function:

cylindricalCS ( const objectRegistry obr,
const dictionary dict 
)

Construct from dictionary and objectRegistry.

Definition at line 104 of file cylindricalCS.C.

~cylindricalCS ( )
virtual

Destructor.

Definition at line 116 of file cylindricalCS.C.

Member Function Documentation

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

Reimplemented from coordinateSystem.

Definition at line 135 of file cylindricalCS.C.

References Foam::cos(), coordinateSystem::localToGlobal(), Foam::constant::mathematical::pi(), Foam::sin(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by cylindricalCS::inDegrees().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Reimplemented from coordinateSystem.

Definition at line 154 of file cylindricalCS.C.

References Field< Type >::component(), Foam::cos(), cylindricalCS::globalToLocal(), coordinateSystem::localToGlobal(), Foam::constant::mathematical::pi(), Field< Type >::replace(), Foam::sin(), List< T >::size(), Vector< Cmpt >::X, Vector< Cmpt >::Y, and Vector< Cmpt >::Z.

Here is the call graph for this function:

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

Reimplemented from coordinateSystem.

Definition at line 176 of file cylindricalCS.C.

References Foam::atan2(), coordinateSystem::globalToLocal(), Foam::constant::mathematical::pi(), Foam::sqr(), Foam::sqrt(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Referenced by cylindricalCS::localToGlobal().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Reimplemented from coordinateSystem.

Definition at line 200 of file cylindricalCS.C.

References Foam::atan2(), Field< Type >::component(), coordinateSystem::globalToLocal(), Foam::constant::mathematical::pi(), Field< Type >::replace(), List< T >::size(), Foam::sqr(), Foam::sqrt(), Vector< Cmpt >::X, Vector< Cmpt >::Y, and Vector< Cmpt >::Z.

Here is the call graph for this function:

bool inDegrees ( ) const

Are angles in degrees?

Definition at line 122 of file cylindricalCS.C.

bool & inDegrees ( )

Non-const access to inDegrees.

Definition at line 128 of file cylindricalCS.C.

References cylindricalCS::localToGlobal().

Here is the call graph for this function:


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