OpenFOAM logo
Open Source CFD Toolkit

cylindricalCS.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     cylindricalCS
00027 
00028 Description
00029     Cylindrical coordinate system: axis is the local z-axis, direction the
00030     local x-axis
00031 
00032 SourceFiles
00033     cylindricalCS.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef cylindricalCS_H
00038 #define cylindricalCS_H
00039 
00040 #include "cartesianCS.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class cylindricalCS Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class cylindricalCS
00052 :
00053     public cartesianCS
00054 {
00055 
00056 public:
00057 
00058     //- Runtime type information
00059     TypeName("cylindrical");
00060 
00061 
00062     // Constructors
00063 
00064         //- Construct from components
00065         cylindricalCS
00066         (
00067             const word& name,
00068             const vector& origin,
00069             const vector& axis,
00070             const vector& direction
00071         );
00072 
00073         //- Construct from origin and rotation angles
00074         cylindricalCS
00075         (
00076             const word& name,
00077             const vector& origin,
00078             const coordinateRotation& cr
00079         );
00080 
00081         //- Construct from dictionary
00082         cylindricalCS(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 coordinate system to the local 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