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-2008 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 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 SourceFiles
  34     parabolicCylindricalCS.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef parabolicCylindricalCS_H
  39 #define parabolicCylindricalCS_H
  40
  41 #include "coordinateSystem.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                     Class parabolicCylindricalCS Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class parabolicCylindricalCS
  53 :
  54     public coordinateSystem
  55 {
  56
  57 protected:
  58
  59     // Protected Member Functions
  60
  61         //- Convert from local coordinate system to the global Cartesian system
  62         //  with optional translation for the origin
  63         virtual vector localToGlobal(const vector&, bool translate) const;
  64
  65         //- Convert from local coordinate system to the global Cartesian system
  66         //  with optional translation for the origin
  67         virtual tmp<vectorField> localToGlobal
  68         (
  69             const vectorField&,
  70             bool translate
  71         ) const;
  72
  73         //- Convert from global Cartesian system to the local coordinate system
  74         //  with optional translation for the origin
  75         virtual vector globalToLocal(const vector&, bool translate) const;
  76
  77         //- Convert from global Cartesian system to the local coordinate system
  78         //  with optional translation for the origin
  79         virtual tmp<vectorField> globalToLocal
  80         (
  81             const vectorField&,
  82             bool translate
  83         ) const;
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("parabolicCylindrical");
  89
  90
  91     // Constructors
  92
  93         //- Construct null
  94         parabolicCylindricalCS();
  95
  96         //- Construct from components
  97         parabolicCylindricalCS
  98         (
  99             const word& name,
 100             const point& origin,
 101             const vector& axis,
 102             const vector& direction
 103         );
 104
 105         //- Construct from origin and rotation angles
 106         parabolicCylindricalCS
 107         (
 108             const word& name,
 109             const point& origin,
 110             const coordinateRotation& cr
 111         );
 112
 113         //- Construct from dictionary
 114         parabolicCylindricalCS
 115         (
 116             const word& name,
 117             const dictionary& dict
 118         );
 119
 120
 121     // Member Functions
 122
 123 };
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //