src/foam/coordinateSystems/toroidalCS.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::toroidalCS
  26
  27 Description
  28     Toroidal coordinate system, always in degrees
  29
  30 Note
  31     The maintenance of this class may lag that of the main types.
  32
  33 SourceFiles
  34     toroidalCS.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef toroidalCS_H
  39 #define toroidalCS_H
  40
  41 #include "coordinateSystem.H"
  42 #include "Switch.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49
  50 /*---------------------------------------------------------------------------*\
  51                         Class toroidalCS Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class toroidalCS
  55 :
  56     public coordinateSystem
  57 {
  58     // Private data
  59
  60         //- Radius of the torus
  61         scalar radius_;
  62
  63         //- Are angles in degrees? (default = true)
  64         Switch inDegrees_;
  65
  66
  67     // Private 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("toroidal");
  97
  98
  99     // Constructors
 100
 101         //- Construct from origin, rotation and radius
 102         toroidalCS
 103         (
 104             const word& name,
 105             const point& origin,
 106             const coordinateRotation&,
 107             const scalar radius,
 108             const bool inDegrees = true
 109         );
 110
 111
 112         //- Construct from dictionary
 113         toroidalCS(const word& name, const dictionary&);
 114
 115         //- Return clone
 116         virtual autoPtr<coordinateSystem> clone() const
 117         {
 118             return autoPtr<coordinateSystem>(new toroidalCS(*this));
 119         }
 120
 121
 122     // Member Functions
 123
 124         // Global information about the coordinate system
 125
 126             //- Directions in which the span is limited
 127             virtual spanInfo spanLimited() const;
 128
 129             //- Span bounds
 130             virtual boundBox spanBounds() const;
 131
 132
 133         //- Are angles in degrees?
 134         bool inDegrees() const;
 135
 136         //- Non-const access to inDegrees
 137         Switch& inDegrees();
 138
 139         //- Return radius
 140         scalar radius() const
 141         {
 142             return radius_;
 143         }
 144
 145         //- Write
 146         virtual void write(Ostream&) const;
 147
 148         //- Write dictionary
 149         virtual void writeDict(Ostream&, bool subDict = true) const;
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //