src/meshTools/coordinateSystems/toroidalCS.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "toroidalCS.H"
  27 #include "addToRunTimeSelectionTable.H"
  28 #include "unitConversion.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34     defineTypeNameAndDebug(toroidalCS, 0);
  35     addToRunTimeSelectionTable(coordinateSystem, toroidalCS, dictionary);
  36 }
  37
  38 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  39
  40
  41 Foam::toroidalCS::toroidalCS
  42 (
  43     const word& name,
  44     const point& origin,
  45     const coordinateRotation& cr,
  46     const scalar radius
  47 )
  48 :
  49     coordinateSystem(name, origin, cr),
  50     radius_(radius)
  51 {}
  52
  53
  54 Foam::toroidalCS::toroidalCS
  55 (
  56     const word& name,
  57     const dictionary& dict
  58 )
  59 :
  60     coordinateSystem(name, dict),
  61     radius_(readScalar(dict.lookup("radius")))
  62 {}
  63
  64
  65 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  66
  67 Foam::vector Foam::toroidalCS::localToGlobal
  68 (
  69     const vector& local,
  70     bool translate
  71 ) const
  72 {
  73     // Notation: r = local.x()
  74     scalar theta = degToRad(local.y());
  75     scalar phi = degToRad(local.z());
  76
  77     scalar rprime = radius_ + local.x()*sin(phi);
  78
  79     if ((local.x()*sin(phi)) > (radius_))
  80     {
  81         FatalErrorIn("toroidalCS::toGlobal(vector) const")
  82             << "Badly defined toroidal coordinates"
  83             << abort(FatalError);
  84     }
  85
  86     return coordinateSystem::localToGlobal
  87     (
  88         vector(rprime*cos(theta), rprime*sin(theta), local.x()*cos(phi)),
  89         translate
  90     );
  91 }
  92
  93
  94 Foam::tmp<Foam::vectorField> Foam::toroidalCS::localToGlobal
  95 (
  96     const vectorField& local,
  97     bool translate
  98 ) const
  99 {
 100     const scalarField r
 101     (
 102         local.component(vector::X)
 103     );
 104
 105     const scalarField theta
 106     (
 107         local.component(vector::Y)*constant::mathematical::pi/180.0
 108     );
 109
 110     const scalarField phi
 111     (
 112         local.component(vector::Z)*constant::mathematical::pi/180.0
 113     );
 114
 115     const scalarField rprime
 116     (
 117         radius_ + r*sin(phi)
 118     );
 119
 120     vectorField lc(local.size());
 121     lc.replace(vector::X, rprime*cos(theta));
 122     lc.replace(vector::Y, rprime*sin(theta));
 123     lc.replace(vector::Z, r*cos(phi));
 124
 125     return coordinateSystem::localToGlobal(lc, translate);
 126 }
 127
 128
 129 Foam::vector Foam::toroidalCS::globalToLocal
 130 (
 131     const vector& global,
 132     bool translate
 133 ) const
 134 {
 135     notImplemented
 136     (
 137         "toroidalCS::globalToLocal(const vector&, bool) const"
 138     );
 139
 140     return vector::zero;
 141 }
 142
 143
 144 Foam::tmp<Foam::vectorField> Foam::toroidalCS::globalToLocal
 145 (
 146     const vectorField& global,
 147     bool translate
 148 ) const
 149 {
 150     notImplemented
 151     (
 152         "toroidalCS::globalToLocal(const vectorField&, bool) const"
 153     );
 154
 155     return tmp<vectorField>(vectorField::null());
 156 }
 157
 158
 159 void Foam::toroidalCS::write(Ostream& os) const
 160 {
 161     coordinateSystem::write(os);
 162     os << "radius: " << radius() << endl;
 163 }
 164
 165
 166 void Foam::toroidalCS::writeDict(Ostream& os, bool subDict) const
 167 {
 168     if (subDict)
 169     {
 170         os  << indent << name() << nl
 171             << indent << token::BEGIN_BLOCK << incrIndent << nl;
 172     }
 173
 174     coordinateSystem::writeDict(os, false);
 175     os.writeKeyword("radius") << radius() << token::END_STATEMENT << nl;
 176
 177     if (subDict)
 178     {
 179         os << decrIndent << indent << token::END_BLOCK << endl;
 180     }
 181 }
 182
 183
 184 // ************************************************************************* //