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