zoneToCell.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
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 "zoneToCell.H"
27 #include "polyMesh.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34  defineTypeNameAndDebug(zoneToCell, 0);
35  addToRunTimeSelectionTable(topoSetSource, zoneToCell, word);
36  addToRunTimeSelectionTable(topoSetSource, zoneToCell, istream);
37 }
38 
39 
40 Foam::topoSetSource::addToUsageTable Foam::zoneToCell::usage_
41 (
42  zoneToCell::typeName,
43  "\n Usage: zoneToCell zone\n\n"
44  " Select all cells in the cellZone."
45  " Note:accepts wildcards for zone.\n\n"
46 );
47 
48 
49 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
50 
51 void Foam::zoneToCell::combine(topoSet& set, const bool add) const
52 {
53  bool hasMatched = false;
54 
55  forAll(mesh_.cellZones(), i)
56  {
57  const cellZone& zone = mesh_.cellZones()[i];
58 
59  if (zoneName_.match(zone.name()))
60  {
61  const labelList& cellLabels = mesh_.cellZones()[i];
62 
63  Info<< " Found matching zone " << zone.name()
64  << " with " << returnReduce(cellLabels.size(), sumOp<label>())
65  << " cells." << endl;
66 
67  hasMatched = true;
68 
69  forAll(cellLabels, i)
70  {
71  // Only do active cells
72  if (cellLabels[i] < mesh_.nCells())
73  {
74  addOrDelete(set, cellLabels[i], add);
75  }
76  }
77  }
78  }
79 
80  if (!hasMatched)
81  {
83  << "Cannot find any cellZone named " << zoneName_ << endl
84  << "Valid names are " << mesh_.cellZones().names() << endl;
85  }
86 }
87 
88 
89 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
90 
92 (
93  const polyMesh& mesh,
94  const word& zoneName
95 )
96 :
97  topoSetSource(mesh),
98  zoneName_(zoneName)
99 {}
100 
101 
103 (
104  const polyMesh& mesh,
105  const dictionary& dict
106 )
107 :
108  topoSetSource(mesh),
109  zoneName_(dict.lookup("name"))
110 {}
111 
112 
114 (
115  const polyMesh& mesh,
116  Istream& is
117 )
118 :
119  topoSetSource(mesh),
120  zoneName_(checkIs(is))
121 {}
122 
123 
124 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
125 
127 {}
128 
129 
130 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
131 
133 (
134  const topoSetSource::setAction action,
135  topoSet& set
136 ) const
137 {
138  if ((action == topoSetSource::NEW) || (action == topoSetSource::ADD))
139  {
140  Info<< " Adding all cells of cellZone " << zoneName_ << " ..."
141  << endl;
142 
143  combine(set, true);
144  }
145  else if (action == topoSetSource::DELETE)
146  {
147  Info<< " Removing all cells of cellZone " << zoneName_ << " ..."
148  << endl;
149 
150  combine(set, false);
151  }
152 }
153 
154 
155 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
AccessType combine(const List< T > &, AccessOp aop=accessOp< T >())
Combines sublists into one big list.
Definition: ListListOps.C:34
virtual ~zoneToCell()
Destructor.
Definition: zoneToCell.C:126
Macros for easy insertion into run-time selection tables.
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
A class for handling words, derived from string.
Definition: word.H:59
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
List< label > labelList
A List of labels.
Definition: labelList.H:56
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: zoneToCell.C:133
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
defineTypeNameAndDebug(combustionModel, 0)
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
#define WarningInFunction
Report a warning using Foam::Warning.
Class with constructor to add usage string to table.
messageStream Info
zoneToCell(const polyMesh &mesh, const word &zoneName)
Construct from components.
Definition: zoneToCell.C:92
T returnReduce(const T &Value, const BinaryOp &bop, const int tag=Pstream::msgType(), const label comm=UPstream::worldComm)
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:844