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