src/foam/meshes/polyMesh/zones/cellZone/cellZone.C

   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 Description
  25     A subset of mesh cells.
  26
  27 \*---------------------------------------------------------------------------*/
  28
  29 #include "cellZone.H"
  30 #include "addToRunTimeSelectionTable.H"
  31 #include "cellZoneMesh.H"
  32 #include "polyMesh.H"
  33 #include "primitiveMesh.H"
  34 #include "IOstream.H"
  35 #include "demandDrivenData.H"
  36
  37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  38
  39 namespace Foam
  40 {
  41     defineTypeNameAndDebug(cellZone, 0);
  42
  43     defineRunTimeSelectionTable(cellZone, dictionary);
  44     addToRunTimeSelectionTable(cellZone, cellZone, dictionary);
  45 }
  46
  47 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  48
  49 const Foam::Map<Foam::label>& Foam::cellZone::cellLookupMap() const
  50 {
  51     if (!cellLookupMapPtr_)
  52     {
  53         calcCellLookupMap();
  54     }
  55
  56     return *cellLookupMapPtr_;
  57 }
  58
  59
  60 void Foam::cellZone::calcCellLookupMap() const
  61 {
  62     if (debug)
  63     {
  64         Info<< "void cellZone::calcCellLookupMap() const : "
  65             << "Calculating cell lookup map"
  66             << endl;
  67     }
  68
  69     if (cellLookupMapPtr_)
  70     {
  71         FatalErrorIn
  72         (
  73             "void cellZone::calcCellLookupMap() const"
  74         )   << "cell lookup map already calculated"
  75             << abort(FatalError);
  76     }
  77
  78     const labelList& addr = *this;
  79
  80     cellLookupMapPtr_ = new Map<label>(2*addr.size());
  81     Map<label>& clm = *cellLookupMapPtr_;
  82
  83     forAll (addr, cellI)
  84     {
  85         clm.insert(addr[cellI], cellI);
  86     }
  87
  88     if (debug)
  89     {
  90         Info<< "void cellZone::calcCellLookupMap() const : "
  91             << "Finished calculating cell lookup map"
  92             << endl;
  93     }
  94 }
  95
  96
  97 void Foam::cellZone::clearAddressing()
  98 {
  99     deleteDemandDrivenData(cellLookupMapPtr_);
 100 }
 101
 102
 103 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 104
 105 // Construct from components
 106 Foam::cellZone::cellZone
 107 (
 108     const word& name,
 109     const labelList& addr,
 110     const label index,
 111     const cellZoneMesh& zm
 112 )
 113 :
 114     labelList(addr),
 115     name_(name),
 116     index_(index),
 117     zoneMesh_(zm),
 118     cellLookupMapPtr_(NULL)
 119 {}
 120
 121
 122 Foam::cellZone::cellZone
 123 (
 124     const word& name,
 125     const Xfer<labelList>& addr,
 126     const label index,
 127     const cellZoneMesh& zm
 128 )
 129 :
 130     labelList(addr),
 131     name_(name),
 132     index_(index),
 133     zoneMesh_(zm),
 134     cellLookupMapPtr_(NULL)
 135 {}
 136
 137
 138 // Construct from dictionary
 139 Foam::cellZone::cellZone
 140 (
 141     const word& name,
 142     const dictionary& dict,
 143     const label index,
 144     const cellZoneMesh& zm
 145 )
 146 :
 147     labelList(dict.lookup("cellLabels")),
 148     name_(name),
 149     index_(index),
 150     zoneMesh_(zm),
 151     cellLookupMapPtr_(NULL)
 152 {}
 153
 154
 155 // Construct given the original zone and resetting the
 156 //  cell list and zone mesh information
 157 Foam::cellZone::cellZone
 158 (
 159     const cellZone& cz,
 160     const labelList& addr,
 161     const label index,
 162     const cellZoneMesh& zm
 163 )
 164 :
 165     labelList(addr),
 166     name_(cz.name()),
 167     index_(index),
 168     zoneMesh_(zm),
 169     cellLookupMapPtr_(NULL)
 170 {}
 171
 172 Foam::cellZone::cellZone
 173 (
 174     const cellZone& cz,
 175     const Xfer<labelList>& addr,
 176     const label index,
 177     const cellZoneMesh& zm
 178 )
 179 :
 180     labelList(addr),
 181     name_(cz.name()),
 182     index_(index),
 183     zoneMesh_(zm),
 184     cellLookupMapPtr_(NULL)
 185 {}
 186
 187
 188 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 189
 190 Foam::cellZone::~cellZone()
 191 {
 192     clearAddressing();
 193 }
 194
 195
 196 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 197
 198 Foam::label Foam::cellZone::whichCell(const label globalCellID) const
 199 {
 200     const Map<label>& clm = cellLookupMap();
 201
 202     Map<label>::const_iterator clmIter = clm.find(globalCellID);
 203
 204     if (clmIter == clm.end())
 205     {
 206         return -1;
 207     }
 208     else
 209     {
 210         return clmIter();
 211     }
 212 }
 213
 214
 215 const Foam::cellZoneMesh& Foam::cellZone::zoneMesh() const
 216 {
 217     return zoneMesh_;
 218 }
 219
 220
 221 bool Foam::cellZone::checkDefinition(const bool report) const
 222 {
 223     const labelList& addr = *this;
 224
 225     bool boundaryError = false;
 226
 227     forAll(addr, i)
 228     {
 229         if (addr[i] < 0 || addr[i] >= zoneMesh_.mesh().nCells())
 230         {
 231             boundaryError = true;
 232
 233             if (report)
 234             {
 235                 SeriousErrorIn
 236                 (
 237                     "bool cellZone::checkDefinition("
 238                     "const bool report) const"
 239                 )   << "Zone " << name()
 240                     << " contains invalid cell label " << addr[i] << nl
 241                     << "Valid cell labels are 0.."
 242                     << zoneMesh_.mesh().nCells()-1 << endl;
 243             }
 244         }
 245     }
 246     return boundaryError;
 247 }
 248
 249
 250 void Foam::cellZone::updateMesh()
 251 {
 252     clearAddressing();
 253 }
 254
 255
 256 void Foam::cellZone::write(Ostream& os) const
 257 {
 258     os  << nl << name()
 259         << nl << static_cast<const labelList&>(*this);
 260 }
 261
 262
 263 void Foam::cellZone::writeDict(Ostream& os) const
 264 {
 265     os  << nl << name() << nl << token::BEGIN_BLOCK << incrIndent << nl
 266         << indent << "type " << type() << token::END_STATEMENT << nl;
 267
 268     writeEntry("cellLabels", os);
 269
 270     os  << decrIndent << token::END_BLOCK << endl;
 271 }
 272
 273
 274 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
 275
 276 void Foam::cellZone::operator=(const cellZone& cz)
 277 {
 278     clearAddressing();
 279     labelList::operator=(cz);
 280 }
 281
 282
 283 void Foam::cellZone::operator=(const labelList& addr)
 284 {
 285     clearAddressing();
 286     labelList::operator=(addr);
 287 }
 288
 289
 290 // * * * * * * * * * * * * * * * Ostream Operator  * * * * * * * * * * * * * //
 291
 292 Foam::Ostream& Foam::operator<<(Ostream& os, const cellZone& p)
 293 {
 294     p.write(os);
 295     os.check("Ostream& operator<<(Ostream& f, const cellZone& p");
 296     return os;
 297 }
 298
 299
 300 // ************************************************************************* //