src/meshTools/coordinateSystems/sphericalCS.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "sphericalCS.H"
  28
  29 #include "one.H"
  30 #include "Switch.H"
  31 #include "mathematicalConstants.H"
  32 #include "addToRunTimeSelectionTable.H"
  33
  34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  35
  36 namespace Foam
  37 {
  38     defineTypeNameAndDebug(sphericalCS, 0);
  39     addToRunTimeSelectionTable(coordinateSystem, sphericalCS, dictionary);
  40     addToRunTimeSelectionTable(coordinateSystem, sphericalCS, origRotation);
  41 }
  42
  43
  44 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  45
  46 Foam::sphericalCS::sphericalCS(const bool inDegrees)
  47 :
  48     coordinateSystem(),
  49     inDegrees_(inDegrees)
  50 {}
  51
  52
  53 Foam::sphericalCS::sphericalCS
  54 (
  55     const coordinateSystem& cs,
  56     const bool inDegrees
  57 )
  58 :
  59     coordinateSystem(cs),
  60     inDegrees_(inDegrees)
  61 {}
  62
  63
  64 Foam::sphericalCS::sphericalCS
  65 (
  66     const word& name,
  67     const coordinateSystem& cs,
  68     const bool inDegrees
  69 )
  70 :
  71     coordinateSystem(name, cs),
  72     inDegrees_(inDegrees)
  73 {}
  74
  75
  76 Foam::sphericalCS::sphericalCS
  77 (
  78     const word& name,
  79     const point& origin,
  80     const coordinateRotation& cr,
  81     const bool inDegrees
  82 )
  83 :
  84     coordinateSystem(name, origin, cr),
  85     inDegrees_(inDegrees)
  86 {}
  87
  88
  89 Foam::sphericalCS::sphericalCS
  90 (
  91     const word& name,
  92     const point& origin,
  93     const vector& axis,
  94     const vector& dirn,
  95     const bool inDegrees
  96 )
  97 :
  98     coordinateSystem(name, origin, axis, dirn),
  99     inDegrees_(inDegrees)
 100 {}
 101
 102
 103 Foam::sphericalCS::sphericalCS
 104 (
 105     const word& name,
 106     const dictionary& dict
 107 )
 108 :
 109     coordinateSystem(name, dict),
 110     inDegrees_(dict.lookupOrDefault<Switch>("degrees", true))
 111 {}
 112
 113
 114 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 115
 116 bool Foam::sphericalCS::inDegrees() const
 117 {
 118     return inDegrees_;
 119 }
 120
 121
 122 bool& Foam::sphericalCS::inDegrees()
 123 {
 124     return inDegrees_;
 125 }
 126
 127
 128 Foam::vector Foam::sphericalCS::localToGlobal
 129 (
 130     const vector& local,
 131     bool translate
 132 ) const
 133 {
 134     scalar r = local.x();
 135     const scalar theta
 136     (
 137         local.y()
 138       * ( inDegrees_ ? mathematicalConstant::pi/180.0 : 1.0 )
 139     );
 140     const scalar phi
 141     (
 142         local.z()
 143       * ( inDegrees_ ? mathematicalConstant::pi/180.0 : 1.0 )
 144     );
 145
 146     return coordinateSystem::localToGlobal
 147     (
 148         vector(r*cos(theta)*sin(phi), r*sin(theta)*sin(phi), r*cos(phi)),
 149         translate
 150     );
 151 }
 152
 153
 154 Foam::tmp<Foam::vectorField> Foam::sphericalCS::localToGlobal
 155 (
 156     const vectorField& local,
 157     bool translate
 158 ) const
 159 {
 160     const scalarField r = local.component(vector::X);
 161     const scalarField theta
 162     (
 163         local.component(vector::Y)
 164       * ( inDegrees_ ? mathematicalConstant::pi/180.0 : 1.0 )
 165     );
 166     const scalarField phi
 167     (
 168         local.component(vector::Z)
 169       * ( inDegrees_ ? mathematicalConstant::pi/180.0 : 1.0 )
 170     );
 171
 172     vectorField lc(local.size());
 173     lc.replace(vector::X, r*cos(theta)*sin(phi));
 174     lc.replace(vector::Y, r*sin(theta)*sin(phi));
 175     lc.replace(vector::Z, r*cos(phi));
 176
 177     return coordinateSystem::localToGlobal(lc, translate);
 178 }
 179
 180
 181 Foam::vector Foam::sphericalCS::globalToLocal
 182 (
 183     const vector& global,
 184     bool translate
 185 ) const
 186 {
 187     const vector lc = coordinateSystem::globalToLocal(global, translate);
 188     const scalar r = mag(lc);
 189
 190     return vector
 191     (
 192         r,
 193         atan2
 194         (
 195             lc.y(), lc.x()
 196         ) * ( inDegrees_ ? 180.0/mathematicalConstant::pi : 1.0 ),
 197         acos
 198         (
 199             lc.z()/(r + SMALL)
 200         ) * ( inDegrees_ ? 180.0/mathematicalConstant::pi : 1.0 )
 201     );
 202 }
 203
 204
 205 Foam::tmp<Foam::vectorField> Foam::sphericalCS::globalToLocal
 206 (
 207     const vectorField& global,
 208     bool translate
 209 ) const
 210 {
 211     const vectorField lc = coordinateSystem::globalToLocal(global, translate);
 212     const scalarField r = mag(lc);
 213
 214     tmp<vectorField> tresult(new vectorField(lc.size()));
 215     vectorField& result = tresult();
 216
 217     result.replace
 218     (
 219         vector::X, r
 220
 221     );
 222
 223     result.replace
 224     (
 225         vector::Y,
 226         atan2
 227         (
 228             lc.component(vector::Y),
 229             lc.component(vector::X)
 230         ) * ( inDegrees_ ? 180.0/mathematicalConstant::pi : 1.0 )
 231     );
 232
 233     result.replace
 234     (
 235         vector::Z,
 236         acos
 237         (
 238             lc.component(vector::Z)/(r + SMALL)
 239         ) * ( inDegrees_ ? 180.0/mathematicalConstant::pi : 1.0 )
 240     );
 241
 242     return tresult;
 243 }
 244
 245
 246 // ************************************************************************* //