src/foam/coordinateSystems/sphericalCS.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::sphericalCS
  26
  27 Description
  28     Spherical coordinate system
  29
  30 SourceFiles
  31     sphericalCS.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef sphericalCS_H
  36 #define sphericalCS_H
  37
  38 #include "coordinateSystem.H"
  39 #include "Switch.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                          Class sphericalCS Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class sphericalCS
  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 public:
  89
  90     //- Runtime type information
  91     TypeName("spherical");
  92
  93
  94     // Constructors
  95
  96         //- Construct null
  97         sphericalCS(const bool inDegrees = true);
  98
  99         //- Construct copy
 100         sphericalCS
 101         (
 102             const coordinateSystem&,
 103             const bool inDegrees = true
 104         );
 105
 106         //- Construct copy with a different name
 107         sphericalCS
 108         (
 109             const word& name,
 110             const coordinateSystem&,
 111             const bool inDegrees = true
 112         );
 113
 114         //- Construct from origin and rotation
 115         sphericalCS
 116         (
 117             const word& name,
 118             const point& origin,
 119             const coordinateRotation&,
 120             const bool inDegrees = true
 121         );
 122
 123         //- Construct from origin and 2 axes
 124         sphericalCS
 125         (
 126             const word& name,
 127             const point& origin,
 128             const vector& axis,
 129             const vector& dirn,
 130             const bool inDegrees = true
 131         );
 132
 133         //- Construct from dictionary
 134         sphericalCS(const word& name, const dictionary&);
 135
 136         //- Return clone
 137         virtual autoPtr<coordinateSystem> clone() const
 138         {
 139             return autoPtr<coordinateSystem>(new sphericalCS(*this));
 140         }
 141
 142
 143     // Member Functions
 144
 145         // Global information about the coordinate system
 146
 147             //- Directions in which the span is limited
 148             virtual spanInfo spanLimited() const;
 149
 150             //- Span bounds
 151             virtual boundBox spanBounds() const;
 152
 153
 154         //- Are angles in degrees?
 155         bool inDegrees() const;
 156
 157         //- Non-const access to inDegrees
 158         Switch& inDegrees();
 159
 160
 161         // Write
 162
 163             //- Write
 164             virtual void write(Ostream&) const;
 165
 166             //- Write dictionary
 167             virtual void writeDict(Ostream&, bool subDict = true) const;
 168 };
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #endif
 177
 178 // ************************************************************************* //