OpenFOAM logo
Open Source CFD Toolkit

sphericalCS.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     sphericalCS
00027 
00028 Description
00029     Spherical polar coordinate system.
00030 
00031 SourceFiles
00032     sphericalCS.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef sphericalCS_H
00037 #define sphericalCS_H
00038 
00039 #include "cartesianCS.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class sphericalCS Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class sphericalCS
00051 :
00052     public cartesianCS
00053 {
00054 
00055 public:
00056 
00057     //- Runtime type information
00058     TypeName("spherical");
00059 
00060 
00061     // Constructors
00062 
00063         //- Construct from components
00064         sphericalCS
00065         (
00066             const word& name,
00067             const vector& origin,
00068             const vector& axis,
00069             const vector& direction
00070         );
00071 
00072         //- Construct from origin and rotation angles
00073         sphericalCS
00074         (
00075             const word& name,
00076             const vector& origin,
00077             const coordinateRotation& cr
00078         );
00079 
00080 
00081         //- Construct from dictionary
00082         sphericalCS(const word& name, const dictionary& dict);
00083 
00084 
00085     // Member Functions
00086 
00087         //- Convert from local coordinate system to the global Cartesian system
00088         virtual vector toGlobal(const vector& localV) const;
00089         virtual tmp<vectorField> toGlobal(const vectorField& localV) const;
00090 
00091         //- Convert from global Cartesian system to the local coordinate system 
00092         virtual vector toLocal(const vector& globalV) const;
00093         virtual tmp<vectorField> toLocal(const vectorField& globalV) const;
00094 };
00095 
00096 
00097 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00098 
00099 } // End namespace Foam
00100 
00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00102 
00103 #endif
00104 
00105 // ************************************************************************* //
For further information go to www.openfoam.org