cellToPoint.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-2020 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 "cellToPoint.H"
30 #include "polyMesh.H"
31 #include "cellSet.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38  defineTypeNameAndDebug(cellToPoint, 0);
39  addToRunTimeSelectionTable(topoSetSource, cellToPoint, word);
40  addToRunTimeSelectionTable(topoSetSource, cellToPoint, istream);
41  addToRunTimeSelectionTable(topoSetPointSource, cellToPoint, word);
42  addToRunTimeSelectionTable(topoSetPointSource, cellToPoint, istream);
43 }
44 
45 
46 Foam::topoSetSource::addToUsageTable Foam::cellToPoint::usage_
47 (
48  cellToPoint::typeName,
49  "\n Usage: cellToPoint <cellSet> all\n\n"
50  " Select all points of cells in the cellSet\n\n"
51 );
52 
53 const Foam::Enum
54 <
56 >
57 Foam::cellToPoint::cellActionNames_
58 ({
59  { cellAction::ALL, "all" },
60 });
61 
62 
63 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
64 
65 void Foam::cellToPoint::combine
66 (
67  topoSet& set,
68  const bool add,
69  const word& setName
70 ) const
71 {
72  // Load the set
73  cellSet loadedSet(mesh_, setName);
74  const labelHashSet& cellLabels = loadedSet;
75 
76  // Add all point from cells in loadedSet
77  for (const label celli : cellLabels)
78  {
79  const labelList& cFaces = mesh_.cells()[celli];
80 
81  for (const label facei : cFaces)
82  {
83  const face& f = mesh_.faces()[facei];
84 
85  addOrDelete(set, f, add);
86  }
87  }
88 }
89 
90 
91 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
92 
94 (
95  const polyMesh& mesh,
96  const word& setName,
97  const cellAction option
98 )
99 :
101  names_(one{}, setName),
102  option_(option)
103 {}
104 
105 
107 (
108  const polyMesh& mesh,
109  const dictionary& dict
110 )
111 :
113  names_(),
114  option_(cellActionNames_.get("option", dict))
115 {
116  // Look for 'sets' or 'set'
117  if (!dict.readIfPresent("sets", names_))
118  {
119  names_.resize(1);
120  dict.readEntry("set", names_.first());
121  }
122 }
123 
124 
126 (
127  const polyMesh& mesh,
128  Istream& is
129 )
130 :
132  names_(one{}, word(checkIs(is))),
133  option_(cellActionNames_.read(checkIs(is)))
134 {}
135 
136 
137 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
138 
140 (
141  const topoSetSource::setAction action,
142  topoSet& set
143 ) const
144 {
145  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
146  {
147  if (verbose_)
148  {
149  Info<< " Adding points in cellSet "
150  << flatOutput(names_) << nl;
151  }
152 
153  for (const word& setName : names_)
154  {
155  combine(set, true, setName);
156  }
157  }
158  else if (action == topoSetSource::SUBTRACT)
159  {
160  if (verbose_)
161  {
162  Info<< " Removing points in cellSet "
163  << flatOutput(names_) << nl;
164  }
165 
166  for (const word& setName : names_)
167  {
168  combine(set, false, setName);
169  }
170  }
171 }
172 
173 
174 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::labelList
List< label > labelList
A List of labels.
Definition: List.H:67
Foam::topoSetSource::ADD
Add elements to current set.
Definition: topoSetSource.H:103
Foam::Enum
Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values...
Definition: IOstreamOption.H:57
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
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::one
A class representing the concept of 1 (one) that can be used to avoid manipulating objects known to b...
Definition: one.H:61
Foam::cellToPoint::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: cellToPoint.C:140
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
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::cellToPoint::cellAction
cellAction
Enumeration defining the valid options.
Definition: cellToPoint.H:180
Foam::dictionary::readEntry
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
Definition: dictionaryTemplates.C:302
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:63
Foam::topoSetPointSource
The topoSetPointSource is a intermediate class for handling topoSet sources for selecting points.
Definition: topoSetPointSource.H:54
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::flatOutput
FlatOutput::OutputAdaptor< Container, Delimiters > flatOutput(const Container &obj, Delimiters delim)
Global flatOutput() function with specified output delimiters.
Definition: FlatOutput.H:216
Foam::polyMesh::faces
virtual const faceList & faces() const
Return raw faces.
Definition: polyMesh.C:1094
Foam::nl
constexpr char nl
Definition: Ostream.H:404
f
labelList f(nPoints)
cellToPoint.H
Foam::cellToPoint::cellToPoint
cellToPoint(const polyMesh &mesh, const word &setName, const cellAction option)
Construct from components.
Definition: cellToPoint.C:94
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
cellSet.H
Foam::labelHashSet
HashSet< label, Hash< label > > labelHashSet
A HashSet of labels, uses label hasher.
Definition: HashSet.H:85
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Reference to the mesh.
Definition: topoSetSource.H:156
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::dictionary::readIfPresent
bool readIfPresent(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:405