nbrToCell.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2018-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "nbrToCell.H"
30 #include "polyMesh.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(nbrToCell, 0);
38  addToRunTimeSelectionTable(topoSetSource, nbrToCell, word);
39  addToRunTimeSelectionTable(topoSetSource, nbrToCell, istream);
40  addToRunTimeSelectionTable(topoSetCellSource, nbrToCell, word);
41  addToRunTimeSelectionTable(topoSetCellSource, nbrToCell, istream);
43  (
44  topoSetCellSource,
45  nbrToCell,
46  word,
47  nbr
48  );
50  (
51  topoSetCellSource,
52  nbrToCell,
53  istream,
54  nbr
55  );
56 }
57 
58 
59 Foam::topoSetSource::addToUsageTable Foam::nbrToCell::usage_
60 (
61  nbrToCell::typeName,
62  "\n Usage: nbrToCell <nNeighbours>\n\n"
63  " Select all cells with <= nNeighbours neighbouring cells\n\n"
64 );
65 
66 
67 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
68 
69 void Foam::nbrToCell::combine(topoSet& set, const bool add) const
70 {
71  if (minNbrs_ < 1)
72  {
73  return; // Nothing to do
74  }
75 
76  const cellList& cells = mesh().cells();
77  const polyBoundaryMesh& patches = mesh_.boundaryMesh();
78 
79  boolList isCoupled(mesh_.nBoundaryFaces(), false);
80 
81  for (const polyPatch& pp : patches)
82  {
83  if (pp.coupled())
84  {
85  label facei = pp.start();
86  forAll(pp, i)
87  {
88  isCoupled[facei-mesh_.nInternalFaces()] = true;
89  ++facei;
90  }
91  }
92  }
93 
94  forAll(cells, celli)
95  {
96  const cell& cFaces = cells[celli];
97 
98  label nNbrCells = 0;
99 
100  for (const label facei : cFaces)
101  {
102  if (mesh_.isInternalFace(facei))
103  {
104  ++nNbrCells;
105  }
106  else if (isCoupled[facei-mesh_.nInternalFaces()])
107  {
108  ++nNbrCells;
109  }
110  }
111 
112  if (nNbrCells <= minNbrs_)
113  {
114  addOrDelete(set, celli, add);
115  }
116  }
117 }
118 
119 
120 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
121 
123 (
124  const polyMesh& mesh,
125  const label minNbrs
126 )
127 :
129  minNbrs_(minNbrs)
130 {}
131 
132 
134 (
135  const polyMesh& mesh,
136  const dictionary& dict
137 )
138 :
139  nbrToCell(mesh, dict.getCheck<label>("neighbours", labelMinMax::ge(1)))
140 {}
141 
142 
144 (
145  const polyMesh& mesh,
146  Istream& is
147 )
148 :
150  minNbrs_(readLabel(checkIs(is)))
151 {}
152 
153 
154 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
155 
157 (
158  const topoSetSource::setAction action,
159  topoSet& set
160 ) const
161 {
162  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
163  {
164  if (verbose_)
165  {
166  Info<< " Adding cells with only " << minNbrs_
167  << " or fewer neighbouring cells" << " ..." << endl;
168  }
169 
170  combine(set, true);
171  }
172  else if (action == topoSetSource::SUBTRACT)
173  {
174  if (verbose_)
175  {
176  Info<< " Removing cells with only " << minNbrs_
177  << " or fewer neighbouring cells" << " ..." << endl;
178  }
179 
180  combine(set, false);
181  }
182 }
183 
184 
185 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::topoSetSource::ADD
Add elements to current set.
Definition: topoSetSource.H:103
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
Foam::nbrToCell::nbrToCell
nbrToCell(const polyMesh &mesh, const label minNbrs)
Construct from components.
Definition: nbrToCell.C:123
Foam::nbrToCell::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: nbrToCell.C:157
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:129
Foam::primitiveMesh::cells
const cellList & cells() const
Definition: primitiveMeshCells.C:138
Foam::boolList
List< bool > boolList
A List of bools.
Definition: List.H:65
Foam::polyMesh::boundaryMesh
const polyBoundaryMesh & boundaryMesh() const
Return boundary mesh.
Definition: polyMesh.H:444
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:100
Foam::topoSetSource::NEW
Create a new set and ADD elements to it.
Definition: topoSetSource.H:104
polyMesh.H
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::ListListOps::combine
AccessType combine(const UList< T > &lists, AccessOp aop=accessOp< T >())
Combines sub-lists into a single list.
Definition: ListListOps.C:69
Foam::addNamedToRunTimeSelectionTable
addNamedToRunTimeSelectionTable(topoSetCellSource, badQualityToCell, word, badQuality)
Foam::cellList
List< cell > cellList
A List of cells.
Definition: cellListFwd.H:47
Foam::primitiveMesh::nBoundaryFaces
label nBoundaryFaces() const noexcept
Number of boundary faces (== nFaces - nInternalFaces)
Definition: primitiveMeshI.H:84
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:63
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::add
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:939
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::topoSetSource::SUBTRACT
Subtract elements from current set.
Definition: topoSetSource.H:105
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::primitiveMesh::isInternalFace
bool isInternalFace(const label faceIndex) const noexcept
Return true if given face label is internal to the mesh.
Definition: primitiveMeshI.H:103
Foam::nbrToCell
A topoSetCellSource to select cells with N or less number of neighbouring cells (i....
Definition: nbrToCell.H:139
Foam::MinMax::ge
static MinMax< T > ge(const T &minVal)
A semi-infinite range from minVal to the type max.
Definition: MinMaxI.H:31
Foam::readLabel
label readLabel(const char *buf)
Parse entire buffer as a label, skipping leading/trailing whitespace.
Definition: label.H:66
Foam::primitiveMesh::nInternalFaces
label nInternalFaces() const noexcept
Number of internal faces.
Definition: primitiveMeshI.H:78
Foam::topoSetCellSource
The topoSetCellSource is a intermediate class for handling topoSet sources for selecting cells.
Definition: topoSetCellSource.H:54
patches
const polyBoundaryMesh & patches
Definition: convertProcessorPatches.H:65
Foam::dictionary::getCheck
T getCheck(const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:120
Foam::topoSetSource::mesh
const polyMesh & mesh() const noexcept
Reference to the mesh.
Definition: topoSetSource.H:342
nbrToCell.H
Foam::topoSetSource::addOrDelete
void addOrDelete(topoSet &set, const label id, const bool add) const
Add or delete id from set. Add when 'add' is true.
Definition: topoSetSource.C:171
cells
const cellShapeList & cells
Definition: gmvOutputHeader.H:3
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Reference to the mesh.
Definition: topoSetSource.H:156
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)