patchToFace.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 "patchToFace.H"
27 #include "polyMesh.H"
28 
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 
36 defineTypeNameAndDebug(patchToFace, 0);
37 
38 addToRunTimeSelectionTable(topoSetSource, patchToFace, word);
39 
40 addToRunTimeSelectionTable(topoSetSource, patchToFace, istream);
41 
42 }
43 
44 
46 (
47  patchToFace::typeName,
48  "\n Usage: patchToFace patch\n\n"
49  " Select all faces in the patch. Note:accepts wildcards for patch.\n\n"
50 );
51 
52 
53 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
54 
55 void Foam::patchToFace::combine(topoSet& set, const bool add) const
56 {
58  (
60  true, // warn if not found
61  true // use patch groups if available
62  );
63 
64  forAllConstIter(labelHashSet, patchIDs, iter)
65  {
66  label patchI = iter.key();
67 
68  const polyPatch& pp = mesh_.boundaryMesh()[patchI];
69 
70  Info<< " Found matching patch " << pp.name()
71  << " with " << pp.size() << " faces." << endl;
72 
73  for
74  (
75  label faceI = pp.start();
76  faceI < pp.start() + pp.size();
77  faceI++
78  )
79  {
80  addOrDelete(set, faceI, add);
81  }
82  }
83 
84  if (patchIDs.empty())
85  {
87  << "Cannot find any patch named " << patchName_ << endl
88  << "Valid names are " << mesh_.boundaryMesh().names() << endl;
89  }
90 }
91 
92 
93 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
94 
95 // Construct from components
97 (
98  const polyMesh& mesh,
99  const word& patchName
100 )
101 :
103  patchName_(patchName)
104 {}
105 
106 
107 // Construct from dictionary
109 (
110  const polyMesh& mesh,
111  const dictionary& dict
112 )
113 :
115  patchName_(dict.lookup("name"))
116 {}
117 
118 
119 // Construct from Istream
121 (
122  const polyMesh& mesh,
123  Istream& is
124 )
125 :
127  patchName_(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 faces of patch " << patchName_ << " ..." << endl;
148 
149  combine(set, true);
150  }
151  else if (action == topoSetSource::DELETE)
152  {
153  Info<< " Removing all faces of patch " << patchName_ << " ..."
154  << endl;
155 
156  combine(set, false);
157  }
158 }
159 
160 
161 // ************************************************************************* //
Foam::topoSetSource::ADD
@ ADD
Definition: topoSetSource.H:87
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
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::patchToFace::patchName_
wordRe patchName_
Name/regular expression of patch.
Definition: patchToFace.H:60
Foam::polyMesh::boundaryMesh
const polyBoundaryMesh & boundaryMesh() const
Return boundary mesh.
Definition: polyMesh.H:421
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::topoSetSource::NEW
@ NEW
Definition: topoSetSource.H:85
polyMesh.H
Foam::HashSet< label, Hash< label > >
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Foam::polyBoundaryMesh::names
wordList names() const
Return a list of patch names.
Definition: polyBoundaryMesh.C:527
forAllConstIter
forAllConstIter(PtrDictionary< phaseModel >, mixture.phases(), phase)
Definition: pEqn.H:39
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:57
Foam::HashTable::empty
bool empty() const
Return true if the hash table is empty.
Definition: HashTableI.H:72
Foam::Info
messageStream Info
Foam::polyPatch
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:66
Foam::topoSetSource::DELETE
@ DELETE
Definition: topoSetSource.H:88
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
patchToFace.H
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::patchToFace::usage_
static addToUsageTable usage_
Add usage string.
Definition: patchToFace.H:57
Foam::polyPatch::start
label start() const
Return start label of this patch in the polyMesh face list.
Definition: polyPatch.H:312
Foam::patchToFace::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: patchToFace.C:140
Foam::patchToFace::combine
void combine(topoSet &set, const bool add) const
Definition: patchToFace.C:55
Foam::List< wordRe >
Foam::patchToFace::~patchToFace
virtual ~patchToFace()
Destructor.
Definition: patchToFace.C:133
Foam::polyBoundaryMesh::patchSet
labelHashSet patchSet(const UList< wordRe > &patchNames, const bool warnNotFound=true, const bool usePatchGroups=true) const
Return the set of patch IDs corresponding to the given names.
Definition: polyBoundaryMesh.C:750
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Definition: topoSetSource.H:126
Foam::patchToFace::patchToFace
patchToFace(const polyMesh &mesh, const word &patchName)
Construct from components.
Definition: patchToFace.C:97
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::patchIdentifier::name
const word & name() const
Return name.
Definition: patchIdentifier.H:109
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