src/foam/coordinateSystems/cylindricalCS.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::cylindricalCS
  26
  27 Description
  28     Cylindrical coordinate system
  29
  30 SourceFiles
  31     cylindricalCS.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef cylindricalCS_H
  36 #define cylindricalCS_H
  37
  38 #include "coordinateSystem.H"
  39 #include "Switch.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                         Class cylindricalCS Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class cylindricalCS
  51 :
  52     public coordinateSystem
  53 {
  54     // Private data members
  55
  56         //- Are angles in degrees? (default = true)
  57         Switch inDegrees_;
  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
  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         //- Return clone
 138         virtual autoPtr<coordinateSystem> clone() const
 139         {
 140             return autoPtr<coordinateSystem>(new cylindricalCS(*this));
 141         }
 142
 143
 144     // Member Functions
 145
 146         // Global information about the coordinate system
 147
 148             //- Directions in which the span is limited
 149             virtual spanInfo spanLimited() const;
 150
 151             //- Span bounds
 152             virtual boundBox spanBounds() const;
 153
 154
 155         //- Are angles in degrees?
 156         bool inDegrees() const;
 157
 158         //- Non-const access to inDegrees
 159         Switch& inDegrees();
 160
 161
 162         // Write
 163
 164             //- Write
 165             virtual void write(Ostream&) const;
 166
 167             //- Write dictionary
 168             virtual void writeDict(Ostream&, bool subDict = true) const;
 169 };
 170
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 } // End namespace Foam
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 #endif
 179
 180 // ************************************************************************* //