src/OpenFOAM/coordinateSystems/cylindricalCS.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::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     // Private data members
  56
  57         //- Are angles in degrees? (default = true)
  58         bool inDegrees_;
  59
  60
  61 protected:
  62
  63     // Protected Member Functions
  64
  65         //- Convert from local coordinate system to the global Cartesian system
  66         //  with optional translation for the origin
  67         virtual vector localToGlobal(const vector&, bool translate) const;
  68
  69         //- Convert from local coordinate system to the global Cartesian system
  70         //  with optional translation for the origin
  71         virtual tmp<vectorField> localToGlobal
  72         (
  73             const vectorField&,
  74             bool translate
  75         ) const;
  76
  77         //- Convert from global Cartesian system to the local coordinate system
  78         //  with optional translation for the origin
  79         virtual vector globalToLocal(const vector&, bool translate) const;
  80
  81         //- Convert from global Cartesian system to the local coordinate system
  82         //  with optional translation for the origin
  83         virtual tmp<vectorField> globalToLocal
  84         (
  85             const vectorField&,
  86             bool translate
  87         ) const;
  88
  89 public:
  90
  91     //- Runtime type information
  92     TypeName("cylindrical");
  93
  94
  95     // Constructors
  96
  97         //- Construct null
  98         cylindricalCS(const bool inDegrees = true);
  99
 100         //- Construct copy
 101         cylindricalCS
 102         (
 103             const coordinateSystem&,
 104             const bool inDegrees = true
 105         );
 106
 107         //- Construct copy with a different name
 108         cylindricalCS
 109         (
 110             const word& name,
 111             const coordinateSystem&,
 112             const bool inDegrees = true
 113         );
 114
 115         //- Construct from origin and rotation
 116         cylindricalCS
 117         (
 118             const word& name,
 119             const point& origin,
 120             const coordinateRotation&,
 121             const bool inDegrees = true
 122         );
 123
 124         //- Construct from origin and 2 axes
 125         cylindricalCS
 126         (
 127             const word& name,
 128             const point& origin,
 129             const vector& axis,
 130             const vector& dirn,
 131             const bool inDegrees = true
 132         );
 133
 134         //- Construct from dictionary
 135         cylindricalCS(const word& name, const dictionary&);
 136
 137
 138     // Member Functions
 139
 140         //- Are angles in degrees?
 141         bool  inDegrees() const;
 142
 143         //- Non-const access to inDegrees
 144         bool& inDegrees();
 145
 146 };
 147
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //