src/meshTools/coordinateSystems/parabolicCylindricalCS.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::parabolicCylindricalCS
  26
  27 Description
  28     Parabolic cylindrical coordinate system.
  29
  30     Notation: u = a.x() v = a.y() z = a.z();
  31
  32 Note
  33     The maintenance of this class may lag that of the main types.
  34
  35 SourceFiles
  36     parabolicCylindricalCS.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef parabolicCylindricalCS_H
  41 #define parabolicCylindricalCS_H
  42
  43 #include "coordinateSystem.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                    Class parabolicCylindricalCS Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class parabolicCylindricalCS
  55 :
  56     public coordinateSystem
  57 {
  58
  59 protected:
  60
  61     // Protected Member Functions
  62
  63         //- Convert from local coordinate system to the global Cartesian system
  64         //  with optional translation for the origin
  65         virtual vector localToGlobal(const vector&, bool translate) const;
  66
  67         //- Convert from local coordinate system to the global Cartesian system
  68         //  with optional translation for the origin
  69         virtual tmp<vectorField> localToGlobal
  70         (
  71             const vectorField&,
  72             bool translate
  73         ) const;
  74
  75         //- Convert from global Cartesian system to the local coordinate system
  76         //  with optional translation for the origin
  77         virtual vector globalToLocal(const vector&, bool translate) const;
  78
  79         //- Convert from global Cartesian system to the local coordinate system
  80         //  with optional translation for the origin
  81         virtual tmp<vectorField> globalToLocal
  82         (
  83             const vectorField&,
  84             bool translate
  85         ) const;
  86
  87 public:
  88
  89     //- Runtime type information
  90     TypeName("parabolicCylindrical");
  91
  92
  93     // Constructors
  94
  95         //- Construct null
  96         parabolicCylindricalCS();
  97
  98         //- Construct from origin and rotation
  99         parabolicCylindricalCS
 100         (
 101             const word& name,
 102             const point& origin,
 103             const coordinateRotation&
 104         );
 105
 106         //- Construct from dictionary
 107         parabolicCylindricalCS(const word&, const dictionary&);
 108
 109 };
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //