zoneToCell.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 | Copyright (C) 2011-2015 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"
28 
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 
36 defineTypeNameAndDebug(zoneToCell, 0);
37 
38 addToRunTimeSelectionTable(topoSetSource, zoneToCell, word);
39 
40 addToRunTimeSelectionTable(topoSetSource, zoneToCell, istream);
41 
42 }
43 
44 
46 (
47  zoneToCell::typeName,
48  "\n Usage: zoneToCell zone\n\n"
49  " Select all cells in the cellZone."
50  " Note:accepts wildcards for zone.\n\n"
51 );
52 
53 
54 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
55 
56 void Foam::zoneToCell::combine(topoSet& set, const bool add) const
57 {
58  bool hasMatched = false;
59 
60  forAll(mesh_.cellZones(), i)
61  {
62  const cellZone& zone = mesh_.cellZones()[i];
63 
64  if (zoneName_.match(zone.name()))
65  {
66  const labelList& cellLabels = mesh_.cellZones()[i];
67 
68  Info<< " Found matching zone " << zone.name()
69  << " with " << cellLabels.size() << " cells." << endl;
70 
71  hasMatched = true;
72 
73  forAll(cellLabels, i)
74  {
75  // Only do active cells
76  if (cellLabels[i] < mesh_.nCells())
77  {
78  addOrDelete(set, cellLabels[i], add);
79  }
80  }
81  }
82  }
83 
84  if (!hasMatched)
85  {
87  << "Cannot find any cellZone named " << zoneName_ << endl
88  << "Valid names are " << mesh_.cellZones().names() << endl;
89  }
90 }
91 
92 
93 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
94 
95 // Construct from components
97 (
98  const polyMesh& mesh,
99  const word& zoneName
100 )
101 :
103  zoneName_(zoneName)
104 {}
105 
106 
107 // Construct from dictionary
109 (
110  const polyMesh& mesh,
111  const dictionary& dict
112 )
113 :
115  zoneName_(dict.lookup("name"))
116 {}
117 
118 
119 // Construct from Istream
121 (
122  const polyMesh& mesh,
123  Istream& is
124 )
125 :
127  zoneName_(checkIs(is))
128 {}
129 
130 
131 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
132 
134 {}
135 
136 
137 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
138 
140 (
141  const topoSetSource::setAction action,
142  topoSet& set
143 ) const
144 {
145  if ((action == topoSetSource::NEW) || (action == topoSetSource::ADD))
146  {
147  Info<< " Adding all cells of cellZone " << zoneName_ << " ..."
148  << endl;
149 
150  combine(set, true);
151  }
152  else if (action == topoSetSource::DELETE)
153  {
154  Info<< " Removing all cells of cellZone " << zoneName_ << " ..."
155  << endl;
156 
157  combine(set, false);
158  }
159 }
160 
161 
162 // ************************************************************************* //
Foam::topoSetSource::ADD
@ ADD
Definition: topoSetSource.H:87
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:406
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
Foam::zoneToCell::~zoneToCell
virtual ~zoneToCell()
Destructor.
Definition: zoneToCell.C:133
Foam::ListListOps::combine
AccessType combine(const List< T > &, AccessOp aop=accessOp< T >())
Combines sublists into one big list.
Definition: ListListOps.C:34
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:100
Foam::dictionary::lookup
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:449
Foam::zone
Base class for zones.
Definition: zone.H:57
Foam::polyMesh::cellZones
const cellZoneMesh & cellZones() const
Return cell zone mesh.
Definition: polyMesh.H:469
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
Foam::wordRe::match
bool match(const std::string &, bool literalMatch=false) const
Smart match as regular expression or as a string.
Definition: wordReI.H:202
Foam::topoSetSource::NEW
@ NEW
Definition: topoSetSource.H:85
polyMesh.H
Foam::zoneToCell::zoneName_
wordRe zoneName_
Name/regular expression of cellZone.
Definition: zoneToCell.H:60
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Foam::cellZone
A subset of mesh cells.
Definition: cellZone.H:61
Foam::zoneToCell::zoneToCell
zoneToCell(const polyMesh &mesh, const word &zoneName)
Construct from components.
Definition: zoneToCell.C:97
Foam::primitiveMesh::nCells
label nCells() const
Definition: primitiveMeshI.H:64
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:57
Foam::Info
messageStream Info
zoneToCell.H
Foam::topoSetSource::DELETE
@ DELETE
Definition: topoSetSource.H:88
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
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:870
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:18
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::topoSetSource
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
Foam::zone::name
const word & name() const
Return name.
Definition: zone.H:150
Foam::ZoneMesh::names
wordList names() const
Return a list of zone names.
Definition: ZoneMesh.C:263
Foam::zoneToCell::usage_
static addToUsageTable usage_
Add usage string.
Definition: zoneToCell.H:57
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::List::size
void size(const label)
Override size to be inconsistent with allocated storage.
Foam::zoneToCell::combine
void combine(topoSet &set, const bool add) const
Definition: zoneToCell.C:56
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Definition: topoSetSource.H:126
Foam::zoneToCell::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: zoneToCell.C:140
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
WarningInFunction
#define WarningInFunction
Report a warning using Foam::Warning.
Definition: messageStream.H:259
Foam::topoSetSource::addOrDelete
void addOrDelete(topoSet &set, const label cellI, const bool) const
Add (if bool) cellI to set or delete cellI from set.
Definition: topoSetSource.C:140