src/foam/coordinateSystems/parabolicCylindricalCS.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::parabolicCylindricalCS
  26
  27 Description
  28     Parabolic cylindrical coordinate system.
  29
  30     Notation: u = a.x() v = a.y() z = a.z();
  31
  32 Note
  33     The maintenance of this class may lag that of the main types.
  34
  35 SourceFiles
  36     parabolicCylindricalCS.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef parabolicCylindricalCS_H
  41 #define parabolicCylindricalCS_H
  42
  43 #include "coordinateSystem.H"
  44 #include "Switch.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     // Private data members
  60
  61         //- Are angles in degrees? (default = true)
  62         Switch inDegrees_;
  63
  64
  65 protected:
  66
  67     // Protected Member Functions
  68
  69         //- Convert from local coordinate system to the global Cartesian system
  70         //  with optional translation for the origin
  71         virtual vector localToGlobal(const vector&, bool translate) const;
  72
  73         //- Convert from local coordinate system to the global Cartesian system
  74         //  with optional translation for the origin
  75         virtual tmp<vectorField> localToGlobal
  76         (
  77             const vectorField&,
  78             bool translate
  79         ) const;
  80
  81         //- Convert from global Cartesian system to the local coordinate system
  82         //  with optional translation for the origin
  83         virtual vector globalToLocal(const vector&, bool translate) const;
  84
  85         //- Convert from global Cartesian system to the local coordinate system
  86         //  with optional translation for the origin
  87         virtual tmp<vectorField> globalToLocal
  88         (
  89             const vectorField&,
  90             bool translate
  91         ) const;
  92
  93 public:
  94
  95     //- Runtime type information
  96     TypeName("parabolicCylindrical");
  97
  98
  99     // Constructors
 100
 101         //- Construct null
 102         parabolicCylindricalCS(const bool inDegrees = true);
 103
 104         //- Construct from origin and rotation
 105         parabolicCylindricalCS
 106         (
 107             const word& name,
 108             const point& origin,
 109             const coordinateRotation&,
 110             const bool inDegrees = true
 111         );
 112
 113         //- Construct from dictionary
 114         parabolicCylindricalCS(const word&, const dictionary&);
 115
 116         //- Return clone
 117         virtual autoPtr<coordinateSystem> clone() const
 118         {
 119             return autoPtr<coordinateSystem>(new parabolicCylindricalCS(*this));
 120         }
 121
 122
 123     // Member Functions
 124
 125         // Global information about the coordinate system
 126
 127             //- Directions in which the span is limited
 128             virtual spanInfo spanLimited() const;
 129
 130             //- Span bounds
 131             virtual boundBox spanBounds() const;
 132
 133
 134         //- Are angles in degrees?
 135         bool inDegrees() const;
 136
 137         //- Non-const access to inDegrees
 138         Switch& inDegrees();
 139
 140
 141         // Write
 142
 143             //- Write
 144             virtual void write(Ostream&) const;
 145
 146             //- Write dictionary
 147             virtual void writeDict(Ostream&, bool subDict = true) const;
 148 };
 149
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 } // End namespace Foam
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 #endif
 158
 159 // ************************************************************************* //