labelToPoint.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 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 "labelToPoint.H"
30 #include "polyMesh.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(labelToPoint, 0);
38  addToRunTimeSelectionTable(topoSetSource, labelToPoint, word);
39  addToRunTimeSelectionTable(topoSetSource, labelToPoint, istream);
40  addToRunTimeSelectionTable(topoSetPointSource, labelToPoint, word);
41  addToRunTimeSelectionTable(topoSetPointSource, labelToPoint, istream);
43  (
44  topoSetPointSource,
45  labelToPoint,
46  word,
47  label
48  );
50  (
51  topoSetPointSource,
52  labelToPoint,
53  istream,
54  label
55  );
56 }
57 
58 
59 Foam::topoSetSource::addToUsageTable Foam::labelToPoint::usage_
60 (
61  labelToPoint::typeName,
62  "\n Usage: labelToPoint (i0 i1 .. in)\n\n"
63  " Select points by label\n\n"
64 );
65 
66 
67 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
68 
70 (
71  const polyMesh& mesh,
72  const labelList& labels
73 )
74 :
76  labels_(labels)
77 {}
78 
79 
81 (
82  const polyMesh& mesh,
83  labelList&& labels
84 )
85 :
87  labels_(std::move(labels))
88 {}
89 
90 
92 (
93  const polyMesh& mesh,
94  const dictionary& dict
95 )
96 :
97  labelToPoint(mesh, dict.get<labelList>("value"))
98 {}
99 
100 
102 (
103  const polyMesh& mesh,
104  Istream& is
105 )
106 :
108  labels_(checkIs(is))
109 {
110  check(labels_, mesh.nPoints());
111 }
112 
113 
114 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
115 
117 (
118  const topoSetSource::setAction action,
119  topoSet& set
120 ) const
121 {
122  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
123  {
124  if (verbose_)
125  {
126  Info<< " Adding points mentioned in dictionary"
127  << " ..." << endl;
128  }
129 
130  addOrDelete(set, labels_, true);
131  }
132  else if (action == topoSetSource::SUBTRACT)
133  {
134  if (verbose_)
135  {
136  Info<< " Removing points mentioned in dictionary"
137  << " ..." << endl;
138  }
139 
140  addOrDelete(set, labels_, false);
141  }
142 }
143 
144 
145 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:129
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::labelToPoint::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: labelToPoint.C:117
Foam::labelToPoint
A topoSetPointSource to select points based on explicitly given point labels.
Definition: labelToPoint.H:143
polyMesh.H
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
labelToPoint.H
Foam::check
static void check(const int retVal, const char *what)
Definition: ptscotchDecomp.C:80
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::addNamedToRunTimeSelectionTable
addNamedToRunTimeSelectionTable(topoSetCellSource, badQualityToCell, word, badQuality)
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
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::labelToPoint::labelToPoint
labelToPoint(const polyMesh &mesh, const labelList &labels)
Construct from components, copying labels.
Definition: labelToPoint.C:70
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::List< label >
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)