OpenFOAM logo
Open Source CFD Toolkit

toroidalCS.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     toroidalCS
00027 
00028 Description
00029     toroidal coordinates
00030 
00031 SourceFiles
00032     toroidalCS.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef toroidalCS_H
00037 #define toroidalCS_H
00038 
00039 #include "cartesianCS.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class toroidalCS Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class toroidalCS
00052 :
00053     public cartesianCS
00054 {
00055     // Private data
00056 
00057         //- Radius of the torus
00058         scalar radius_;
00059 
00060 
00061 public:
00062 
00063     //- Runtime type information
00064     TypeName("toroidal");
00065 
00066 
00067     // Constructors
00068 
00069         //- Construct from components
00070         toroidalCS
00071         (
00072             const word& name,
00073             const vector& origin,
00074             const vector& axis,
00075             const vector& direction,
00076             const scalar radius
00077         );
00078 
00079         //- Construct from origin and rotation angles
00080         toroidalCS
00081         (
00082             const word& name,
00083             const vector& origin,
00084             const coordinateRotation& cr,
00085             const scalar radius
00086         );
00087 
00088         //- Construct from dictionary
00089         toroidalCS(const word& name, const dictionary& dict);
00090 
00091 
00092     // Member Functions
00093 
00094         //- Return radius
00095         scalar radius() const
00096         {
00097             return radius_;
00098         }
00099 
00100         //- Convert from local coordinate system to the global Cartesian system
00101         virtual vector toGlobal(const vector& localV) const;
00102         virtual tmp<vectorField> toGlobal(const vectorField& localV) const;
00103 
00104         //- Convert from global Cartesian system to the local coordinate system 
00105         virtual vector toLocal(const vector& globalV) const;
00106         virtual tmp<vectorField> toLocal(const vectorField& globalV) const;
00107 
00108 
00109         //- Write
00110         virtual void write(Ostream&) const;
00111 
00112         //- Write dictionary
00113         virtual void writeDict(Ostream&) const;
00114 };
00115 
00116 
00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00118 
00119 } // End namespace Foam
00120 
00121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00122 
00123 #endif
00124 
00125 // ************************************************************************* //
For further information go to www.openfoam.org