labelToCell.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 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 "labelToCell.H"
27 #include "polyMesh.H"
28 
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 
36 defineTypeNameAndDebug(labelToCell, 0);
37 
38 addToRunTimeSelectionTable(topoSetSource, labelToCell, word);
39 
40 addToRunTimeSelectionTable(topoSetSource, labelToCell, istream);
41 
42 }
43 
44 
46 (
47  labelToCell::typeName,
48  "\n Usage: labelToCell (i0 i1 .. in)\n\n"
49  " Select cells by cellLabel\n\n"
50 );
51 
52 
53 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
54 
55 void Foam::labelToCell::combine(topoSet& set, const bool add) const
56 {
58  {
59  addOrDelete(set, labels_[labelI], add);
60  }
61 }
62 
63 
64 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
65 
66 // Construct from components
68 (
69  const polyMesh& mesh,
70  const labelList& labels
71 )
72 :
74  labels_(labels)
75 {}
76 
77 
78 // Construct from dictionary
80 (
81  const polyMesh& mesh,
82  const dictionary& dict
83 )
84 :
86  labels_(dict.lookup("value"))
87 {}
88 
89 
90 // Construct from Istream
92 (
93  const polyMesh& mesh,
94  Istream& is
95 )
96 :
98  labels_(checkIs(is))
99 {}
100 
101 
102 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
103 
105 {}
106 
107 
108 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
109 
111 (
112  const topoSetSource::setAction action,
113  topoSet& set
114 ) const
115 {
116  if ((action == topoSetSource::NEW) || (action == topoSetSource::ADD))
117  {
118  Info<< " Adding cells mentioned in dictionary" << " ..." << endl;
119 
120  combine(set, true);
121  }
122  else if (action == topoSetSource::DELETE)
123  {
124  Info<< " Removing cells mentioned in dictionary" << " ..." << endl;
125 
126  combine(set, false);
127  }
128 }
129 
130 
131 // ************************************************************************* //
Foam::labelToCell::~labelToCell
virtual ~labelToCell()
Destructor.
Definition: labelToCell.C:104
Foam::topoSetSource::ADD
@ ADD
Definition: topoSetSource.H:87
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:406
Foam::labelToCell::labels_
labelList labels_
Cell labels read from dictionary.
Definition: labelToCell.H:59
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
labelToCell.H
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::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::labelToCell::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: labelToCell.C:111
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
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
Foam::labelToCell::usage_
static addToUsageTable usage_
Add usage string.
Definition: labelToCell.H:56
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::labelToCell::labelToCell
labelToCell(const polyMesh &mesh, const labelList &labels)
Construct from components.
Definition: labelToCell.C:68
Foam::labelToCell::combine
void combine(topoSet &set, const bool add) const
Definition: labelToCell.C:55
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::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
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
Foam::labelI
static const labelSphericalTensor labelI(1)
Identity labelTensor.