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

parabolicCylindricalCS.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::parabolicCylindricalCS
00026 
00027 Description
00028     Parabolic cylindrical coordinate system.
00029 
00030     Notation: u = a.x() v = a.y() z = a.z();
00031 
00032 Note
00033     The maintenance of this class may lag that of the main types.
00034 
00035 SourceFiles
00036     parabolicCylindricalCS.C
00037 
00038 \*---------------------------------------------------------------------------*/
00039 
00040 #ifndef parabolicCylindricalCS_H
00041 #define parabolicCylindricalCS_H
00042 
00043 #include <meshTools/coordinateSystem.H>
00044 
00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00046 
00047 namespace Foam
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                    Class parabolicCylindricalCS Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 class parabolicCylindricalCS
00055 :
00056     public coordinateSystem
00057 {
00058 
00059 protected:
00060 
00061     // Protected Member Functions
00062 
00063         //- Convert from local coordinate system to the global Cartesian system
00064         //  with optional translation for the origin
00065         virtual vector localToGlobal(const vector&, bool translate) const;
00066 
00067         //- Convert from local coordinate system to the global Cartesian system
00068         //  with optional translation for the origin
00069         virtual tmp<vectorField> localToGlobal
00070         (
00071             const vectorField&,
00072             bool translate
00073         ) const;
00074 
00075         //- Convert from global Cartesian system to the local coordinate system
00076         //  with optional translation for the origin
00077         virtual vector globalToLocal(const vector&, bool translate) const;
00078 
00079         //- Convert from global Cartesian system to the local coordinate system
00080         //  with optional translation for the origin
00081         virtual tmp<vectorField> globalToLocal
00082         (
00083             const vectorField&,
00084             bool translate
00085         ) const;
00086 
00087 public:
00088 
00089     //- Runtime type information
00090     TypeName("parabolicCylindrical");
00091 
00092 
00093     // Constructors
00094 
00095         //- Construct null
00096         parabolicCylindricalCS();
00097 
00098         //- Construct from origin and rotation
00099         parabolicCylindricalCS
00100         (
00101             const word& name,
00102             const point& origin,
00103             const coordinateRotation&
00104         );
00105 
00106         //- Construct from dictionary
00107         parabolicCylindricalCS(const word&, const dictionary&);
00108 
00109 };
00110 
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 } // End namespace Foam
00115 
00116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00117 
00118 #endif
00119 
00120 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines