applications/utilities/mesh/advanced/refinementLevel/refinementLevel.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     Tries to figure out what the refinement level is on refined cartesian
  26     meshes. Run BEFORE snapping.
  27
  28     Writes
  29     - volScalarField 'refinementLevel' with current refinement level.
  30     - cellSet 'refCells' which are the cells that need to be refined to satisfy
  31       2:1 refinement.
  32
  33     Works by dividing cells into volume bins.
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #include "argList.H"
  38 #include "objectRegistry.H"
  39 #include "Time.H"
  40 #include "polyMesh.H"
  41 #include "cellSet.H"
  42 #include "SortableList.H"
  43 #include "labelIOList.H"
  44 #include "fvMesh.H"
  45 #include "volFields.H"
  46
  47 using namespace Foam;
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 // Return true if any cells had to be split to keep a difference between
  52 // neighbouring refinement levels < limitDiff. Puts cells into refCells and
  53 // update refLevel to account for refinement.
  54 bool limitRefinementLevel
  55 (
  56     const primitiveMesh& mesh,
  57     labelList& refLevel,
  58     cellSet& refCells
  59 )
  60 {
  61     const labelListList& cellCells = mesh.cellCells();
  62
  63     label oldNCells = refCells.size();
  64
  65     forAll(cellCells, cellI)
  66     {
  67         const labelList& cCells = cellCells[cellI];
  68
  69         forAll(cCells, i)
  70         {
  71             if (refLevel[cCells[i]] > (refLevel[cellI]+1))
  72             {
  73                 // Found neighbour with >=2 difference in refLevel.
  74                 refCells.insert(cellI);
  75                 refLevel[cellI]++;
  76                 break;
  77             }
  78         }
  79     }
  80
  81     if (refCells.size() > oldNCells)
  82     {
  83         Info<< "Added an additional " << refCells.size() - oldNCells
  84             << " cells to satisfy 1:2 refinement level"
  85             << endl;
  86
  87         return true;
  88     }
  89     else
  90     {
  91         return false;
  92     }
  93 }
  94
  95
  96 // Main program:
  97
  98 int main(int argc, char *argv[])
  99 {
 100     argList::validOptions.insert("readLevel", "");
 101
 102 #   include "setRootCase.H"
 103 #   include "createTime.H"
 104 #   include "createPolyMesh.H"
 105
 106     Info<< "Dividing cells into bins depending on cell volume.\nThis will"
 107         << " correspond to refinement levels for a mesh with only 2x2x2"
 108         << " refinement\n"
 109         << "The upper range for every bin is always 1.1 times the lower range"
 110         << " to allow for some truncation error."
 111         << nl << endl;
 112
 113     bool readLevel = args.optionFound("readLevel");
 114
 115     const scalarField& vols = mesh.cellVolumes();
 116
 117     SortableList<scalar> sortedVols(vols);
 118
 119     // All cell labels, sorted per bin.
 120     DynamicList<DynamicList<label> > bins;
 121
 122     // Lower/upper limits
 123     DynamicList<scalar> lowerLimits;
 124     DynamicList<scalar> upperLimits;
 125
 126     // Create bin0. Have upperlimit as factor times lowerlimit.
 127     bins.append(DynamicList<label>());
 128     lowerLimits.append(sortedVols[0]);
 129     upperLimits.append(1.1*lowerLimits[lowerLimits.size()-1]);
 130
 131     forAll(sortedVols, i)
 132     {
 133         if (sortedVols[i] > upperLimits[upperLimits.size()-1])
 134         {
 135             // New value outside of current bin
 136
 137             // Shrink old bin.
 138             DynamicList<label>& bin = bins[bins.size()-1];
 139
 140             bin.shrink();
 141
 142             Info<< "Collected " << bin.size() << " elements in bin "
 143                 << lowerLimits[lowerLimits.size()-1] << " .. "
 144                 << upperLimits[upperLimits.size()-1] << endl;
 145
 146             // Create new bin.
 147             bins.append(DynamicList<label>());
 148             lowerLimits.append(sortedVols[i]);
 149             upperLimits.append(1.1*lowerLimits[lowerLimits.size()-1]);
 150
 151             Info<< "Creating new bin " << lowerLimits[lowerLimits.size()-1]
 152                 << " .. " << upperLimits[upperLimits.size()-1]
 153                 << endl;
 154         }
 155
 156         // Append to current bin.
 157         DynamicList<label>& bin = bins[bins.size()-1];
 158
 159         bin.append(sortedVols.indices()[i]);
 160     }
 161     Info<< endl;
 162
 163     bins[bins.size()-1].shrink();
 164     bins.shrink();
 165     lowerLimits.shrink();
 166     upperLimits.shrink();
 167
 168
 169     //
 170     // Write to cellSets.
 171     //
 172
 173     Info<< "Volume bins:" << nl;
 174     forAll(bins, binI)
 175     {
 176         const DynamicList<label>& bin = bins[binI];
 177
 178         cellSet cells(mesh, "vol" + name(binI), bin.size());
 179
 180         forAll(bin, i)
 181         {
 182             cells.insert(bin[i]);
 183         }
 184
 185         Info<< "    " << lowerLimits[binI] << " .. " << upperLimits[binI]
 186             << "  : writing " << bin.size() << " cells to cellSet "
 187             << cells.name() << endl;
 188
 189         cells.write();
 190     }
 191
 192
 193
 194     //
 195     // Convert bins into refinement level.
 196     //
 197
 198
 199     // Construct fvMesh to be able to construct volScalarField
 200
 201     fvMesh fMesh
 202     (
 203         IOobject
 204         (
 205             fvMesh::defaultRegion,
 206             runTime.timeName(),
 207             runTime
 208         ),
 209         xferCopy(mesh.points()),   // could we safely re-use the data?
 210         xferCopy(mesh.faces()),
 211         xferCopy(mesh.cells())
 212     );
 213
 214     // Add the boundary patches
 215     const polyBoundaryMesh& patches = mesh.boundaryMesh();
 216
 217     List<polyPatch*> p(patches.size());
 218
 219     forAll (p, patchI)
 220     {
 221         p[patchI] = patches[patchI].clone(fMesh.boundaryMesh()).ptr();
 222     }
 223
 224     fMesh.addFvPatches(p);
 225
 226
 227     // Refinement level
 228     IOobject refHeader
 229     (
 230         "refinementLevel",
 231         runTime.timeName(),
 232         polyMesh::defaultRegion,
 233         runTime
 234     );
 235
 236     if (!readLevel && refHeader.headerOk())
 237     {
 238         WarningIn(args.executable())
 239             << "Detected " << refHeader.name() << " file in "
 240             << polyMesh::defaultRegion <<  " directory. Please remove to"
 241             << " recreate it or use the -readLevel option to use it"
 242             << endl;
 243         return 1;
 244     }
 245
 246
 247     labelIOList refLevel
 248     (
 249         IOobject
 250         (
 251             "refinementLevel",
 252             runTime.timeName(),
 253             mesh,
 254             IOobject::NO_READ,
 255             IOobject::AUTO_WRITE
 256         ),
 257         labelList(mesh.nCells(), 0)
 258     );
 259
 260     if (readLevel)
 261     {
 262         refLevel = labelIOList(refHeader);
 263     }
 264
 265     // Construct volScalarField with same info for post processing
 266     volScalarField postRefLevel
 267     (
 268         IOobject
 269         (
 270             "refinementLevel",
 271             runTime.timeName(),
 272             mesh,
 273             IOobject::NO_READ,
 274             IOobject::NO_WRITE
 275         ),
 276         fMesh,
 277         dimensionedScalar("zero", dimless/dimTime, 0)
 278     );
 279
 280     // Set cell values
 281     forAll(bins, binI)
 282     {
 283         const DynamicList<label>& bin = bins[binI];
 284
 285         forAll(bin, i)
 286         {
 287             refLevel[bin[i]] = bins.size() - binI - 1;
 288             postRefLevel[bin[i]] = refLevel[bin[i]];
 289         }
 290     }
 291
 292
 293     // For volScalarField: set boundary values to same as cell.
 294     // Note: could also put
 295     // zeroGradient b.c. on postRefLevel and do evaluate.
 296     forAll(postRefLevel.boundaryField(), patchI)
 297     {
 298         const polyPatch& pp = patches[patchI];
 299
 300         fvPatchScalarField& bField = postRefLevel.boundaryField()[patchI];
 301
 302         Info<< "Setting field for patch "<< endl;
 303
 304         forAll(bField, faceI)
 305         {
 306             label own = mesh.faceOwner()[pp.start() + faceI];
 307
 308             bField[faceI] = postRefLevel[own];
 309         }
 310     }
 311
 312     Info<< "Determined current refinement level and writing to "
 313         << postRefLevel.name() << " (as volScalarField; for post processing)"
 314         << nl
 315         << polyMesh::defaultRegion/refLevel.name()
 316         << " (as labelIOList; for meshing)" << nl
 317         << endl;
 318
 319     refLevel.write();
 320     postRefLevel.write();
 321
 322
 323     // Find out cells to refine to keep to 2:1 refinement level restriction
 324
 325     // Cells to refine
 326     cellSet refCells(mesh, "refCells", 100);
 327
 328     while
 329     (
 330         limitRefinementLevel
 331         (
 332             mesh,
 333             refLevel,       // current refinement level
 334             refCells        // cells to refine
 335         )
 336     )
 337     {}
 338
 339     if (refCells.size())
 340     {
 341         Info<< "Collected " << refCells.size() << " cells that need to be"
 342             << " refined to get closer to overall 2:1 refinement level limit"
 343             << nl
 344             << "Written cells to be refined to cellSet " << refCells.name()
 345             << nl << endl;
 346
 347         refCells.write();
 348
 349         Info<< "After refinement this tool can be run again to see if the 2:1"
 350             << " limit is observed all over the mesh" << nl << endl;
 351     }
 352     else
 353     {
 354         Info<< "All cells in the mesh observe the 2:1 refinement level limit"
 355             << nl << endl;
 356     }
 357
 358     Info << nl << "End" << endl;
 359
 360     return 0;
 361 }
 362
 363
 364 // ************************************************************************* //