FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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.

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: