src/OpenFOAM/coordinateSystems/parabolicCylindricalCS.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::parabolicCylindricalCS
  27
  28 Description
  29     Parabolic cylindrical coordinate system.
  30
  31     Notation: u = a.x() v = a.y() z = a.z();
  32
  33 Note
  34     The maintenance of this class may lag that of the main types.
  35
  36 SourceFiles
  37     parabolicCylindricalCS.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef parabolicCylindricalCS_H
  42 #define parabolicCylindricalCS_H
  43
  44 #include "coordinateSystem.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                    Class parabolicCylindricalCS Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class parabolicCylindricalCS
  56 :
  57     public coordinateSystem
  58 {
  59
  60 protected:
  61
  62     // Protected Member Functions
  63
  64         //- Convert from local coordinate system to the global Cartesian system
  65         //  with optional translation for the origin
  66         virtual vector localToGlobal(const vector&, bool translate) const;
  67
  68         //- Convert from local coordinate system to the global Cartesian system
  69         //  with optional translation for the origin
  70         virtual tmp<vectorField> localToGlobal
  71         (
  72             const vectorField&,
  73             bool translate
  74         ) const;
  75
  76         //- Convert from global Cartesian system to the local coordinate system
  77         //  with optional translation for the origin
  78         virtual vector globalToLocal(const vector&, bool translate) const;
  79
  80         //- Convert from global Cartesian system to the local coordinate system
  81         //  with optional translation for the origin
  82         virtual tmp<vectorField> globalToLocal
  83         (
  84             const vectorField&,
  85             bool translate
  86         ) const;
  87
  88 public:
  89
  90     //- Runtime type information
  91     TypeName("parabolicCylindrical");
  92
  93
  94     // Constructors
  95
  96         //- Construct null
  97         parabolicCylindricalCS();
  98
  99         //- Construct from origin and rotation
 100         parabolicCylindricalCS
 101         (
 102             const word& name,
 103             const point& origin,
 104             const coordinateRotation&
 105         );
 106
 107         //- Construct from dictionary
 108         parabolicCylindricalCS(const word&, const dictionary&);
 109
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //