cellToPoint.H
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 Class
25  Foam::cellToPoint
26 
27 Description
28  A topoSetSource to select points based on usage in cells.
29 
30 SourceFiles
31  cellToPoint.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cellToPoint_H
36 #define cellToPoint_H
37 
38 #include "topoSetSource.H"
39 #include "NamedEnum.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cellToPoint Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class cellToPoint
51 :
52  public topoSetSource
53 {
54 
55 public:
56  //- Enumeration defining the valid options
57  enum cellAction
58  {
59  ALL
60  };
61 
62 private:
63 
64  //- Add usage string
65  static addToUsageTable usage_;
66 
67  static const NamedEnum<cellAction, 1> cellActionNames_;
68 
69  //- Name of set to use
70  word setName_;
71 
72  //- Option
73  cellAction option_;
74 
75 
76  // Private Member Functions
77 
78  //- Depending on face to cell option add to or delete from cellSet.
79  void combine(topoSet& set, const bool add) const;
80 
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("cellToPoint");
86 
87  // Constructors
88 
89  //- Construct from components
91  (
92  const polyMesh& mesh,
93  const word& setName,
94  const cellAction option
95  );
96 
97  //- Construct from dictionary
99  (
100  const polyMesh& mesh,
101  const dictionary& dict
102  );
103 
104  //- Construct from Istream
106  (
107  const polyMesh& mesh,
108  Istream&
109  );
110 
111 
112  //- Destructor
113  virtual ~cellToPoint();
114 
115 
116  // Member Functions
118  virtual sourceType setType() const
119  {
120  return POINTSETSOURCE;
121  }
122 
123  virtual void applyToSet
124  (
125  const topoSetSource::setAction action,
126  topoSet&
127  ) const;
128 
129 };
130 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #endif
139 
140 // ************************************************************************* //
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A class for handling words, derived from string.
Definition: word.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
dictionary dict
Combine operator for AMIInterpolation.
Definition: FaceCellWave.C:54
cellAction
Enumeration defining the valid options.
Definition: cellToPoint.H:56
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
A topoSetSource to select points based on usage in cells.
Definition: cellToPoint.H:49
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & mesh() const
TypeName("cellToPoint")
Runtime type information.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: cellToPoint.C:140
virtual ~cellToPoint()
Destructor.
Definition: cellToPoint.C:133
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
cellToPoint(const polyMesh &mesh, const word &setName, const cellAction option)
Construct from components.
Definition: cellToPoint.C:93
Class with constructor to add usage string to table.
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
virtual sourceType setType() const
Definition: cellToPoint.H:117