OpenFOAM logo
Open Source CFD Toolkit

toroidalCS Class Reference

Inheritance diagram for toroidalCS:

Inheritance graph
[legend]
Collaboration diagram for toroidalCS:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("toroidal")
 Runtime type information.
 toroidalCS (const word &name, const vector &origin, const vector &axis, const vector &direction, const scalar radius)
 Construct from components.
 toroidalCS (const word &name, const vector &origin, const coordinateRotation &cr, const scalar radius)
 Construct from origin and rotation angles.
 toroidalCS (const word &name, const dictionary &dict)
 Construct from dictionary.
scalar radius () const
 Return radius.
virtual vector toGlobal (const vector &localV) const
 Convert from local coordinate system to the global Cartesian system.
virtual tmp< vectorFieldtoGlobal (const vectorField &localV) const
virtual vector toLocal (const vector &globalV) const
 Convert from global Cartesian system to the local coordinate system.
virtual tmp< vectorFieldtoLocal (const vectorField &globalV) const
virtual void write (Ostream &) const
 Write.
virtual void writeDict (Ostream &) const
 Write dictionary.

Constructor & Destructor Documentation

toroidalCS const word name,
const vector origin,
const vector axis,
const vector direction,
const scalar  radius
 

Construct from components.

toroidalCS const word name,
const vector origin,
const coordinateRotation cr,
const scalar  radius
 

Construct from origin and rotation angles.

toroidalCS const word name,
const dictionary dict
 

Construct from dictionary.


Member Function Documentation

scalar radius  )  const [inline]
 

Return radius.

Definition at line 102 of file toroidalCS.H.

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

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

Reimplemented from cartesianCS.

virtual vector toGlobal const vector localV  )  const [virtual]
 

Convert from local coordinate system to the global Cartesian system.

Reimplemented from cartesianCS.

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

Reimplemented from cartesianCS.

virtual vector toLocal const vector globalV  )  const [virtual]
 

Convert from global Cartesian system to the local coordinate system.

Reimplemented from cartesianCS.

TypeName "toroidal"   ) 
 

Runtime type information.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented from coordinateSystem.

virtual void writeDict Ostream  )  const [virtual]
 

Write dictionary.

Reimplemented from coordinateSystem.


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