All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
patchDistanceToCell.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) 2021 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::patchDistanceToCell
26 
27 Description
28  A topoSetSource to select cells based on distance to a set of patches.
29 
30 SourceFiles
31  patchDistanceToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef patchDistanceToCell_H
36 #define patchDistanceToCell_H
37 
38 #include "topoSetSource.H"
39 #include "NamedEnum.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class patchDistanceToCell Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public topoSetSource
53 {
54 private:
55 
56  //- Add usage string
57  static addToUsageTable usage_;
58 
59  //- List of patches
60  wordReList patches_;
61 
62  //- Patch distance below which cells are included into the set
63  scalar distance_;
64 
65 
66  // Private Member Functions
67 
68  //- Depending on face to cell option add to or delete from cellSet.
69  void combine(topoSet& set, const bool add) const;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("patchDistanceToCell");
76 
77 
78  // Constructors
79 
80  //- Construct from dictionary
82  (
83  const polyMesh& mesh,
84  const dictionary& dict
85  );
86 
87  //- Construct from Istream
89  (
90  const polyMesh& mesh,
91  Istream&
92  );
93 
94 
95  //- Destructor
96  virtual ~patchDistanceToCell();
97 
98 
99  // Member Functions
101  virtual sourceType setType() const
102  {
103  return CELLSETSOURCE;
104  }
105 
106  virtual void applyToSet
107  (
108  const topoSetSource::setAction action,
109  topoSet&
110  ) const;
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************************************************************* //
dictionary dict
virtual ~patchDistanceToCell()
Destructor.
TypeName("patchDistanceToCell")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A topoSetSource to select cells based on distance to a set of patches.
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
Class with constructor to add usage string to table.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
patchDistanceToCell(const polyMesh &mesh, const dictionary &dict)
Construct from dictionary.
virtual sourceType setType() const
Namespace for OpenFOAM.