searchableSurfaceToFaceZone.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) 2012-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::searchableSurfaceToFaceZone
26 
27 Description
28  A topoSetSource to select faces based on intersection (of cell-cell
29  vector) with a surface.
30 
31 SourceFiles
32  searchableSurfaceToFaceZone.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef searchableSurfaceToFaceZone_H
37 #define searchableSurfaceToFaceZone_H
38 
39 #include "topoSetSource.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class searchableSurface;
47 class faceZoneSet;
48 
49 /*---------------------------------------------------------------------------*\
50  Class searchableSurfaceToFaceZone Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public topoSetSource
56 {
57  // Private Data
58 
59 
60  //- Surface
61  autoPtr<searchableSurface> surfacePtr_;
62 
63  //- Tolerance with which to extend the cell-cell vectors
64  const scalar tol_;
65 
66 
67  // Private Member Functions
68 
69  void combine(faceZoneSet& set, const bool add) const;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("searchableSurfaceToFaceZone");
76 
77  // Constructors
78 
79  //- Construct from dictionary
81  (
82  const polyMesh& mesh,
83  const dictionary& dict
84  );
85 
86 
87  //- Destructor
89 
90 
91  // Member Functions
92 
93  virtual sourceType setType() const
94  {
95  return FACEZONESOURCE;
96  }
97 
98  virtual void applyToSet
99  (
100  const topoSetSource::setAction action,
101  topoSet&
102  ) const;
103 
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
dictionary dict
TypeName("searchableSurfaceToFaceZone")
Runtime type information.
searchableSurfaceToFaceZone(const polyMesh &mesh, const dictionary &dict)
Construct from dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
A topoSetSource to select faces based on intersection (of cell-cell vector) with a surface...
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)
Like faceSet but -reads data from faceZone -updates faceZone when writing.
Definition: faceZoneSet.H:49
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:76
Namespace for OpenFOAM.