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 
57  //- List of patches
58  wordReList patches_;
59 
60  //- Patch distance below which cells are included into the set
61  scalar distance_;
62 
63 
64  // Private Member Functions
65 
66  //- Depending on face to cell option add to or delete from cellSet.
67  void combine(topoSet& set, const bool add) const;
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("patchDistanceToCell");
74 
75 
76  // Constructors
77 
78  //- Construct from dictionary
80  (
81  const polyMesh& mesh,
82  const dictionary& dict
83  );
84 
85 
86  //- Destructor
87  virtual ~patchDistanceToCell();
88 
89 
90  // Member Functions
91 
92  virtual sourceType setType() const
93  {
94  return CELLSETSOURCE;
95  }
96 
97  virtual void applyToSet
98  (
99  const topoSetSource::setAction action,
100  topoSet&
101  ) const;
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
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
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
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:76
patchDistanceToCell(const polyMesh &mesh, const dictionary &dict)
Construct from dictionary.
virtual sourceType setType() const
Namespace for OpenFOAM.