FacePatchIntersection.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) 2023 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::FacePatchIntersection
26 
27 Description
28  Patch intersection based on polygonal faces. This triangulates the supplied
29  patches and passes them to TriPatchIntersection. It then re-combines the
30  triangles that TriPatchIntersection generates.
31 
32 SourceFiles
33  FacePatchIntersection.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef FacePatchIntersection_H
38 #define FacePatchIntersection_H
39 
40 #include "PatchIntersection.H"
41 #include "triFace.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class FacePatchIntersection Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class SrcPatchType, class TgtPatchType>
54 :
55  public PatchIntersection<SrcPatchType, TgtPatchType>
56 {
57 public:
58 
59  // Runtime type information
60 
61  virtual word type() const
62  {
63  return "face" + patchIntersection::typeName.capitalise();
64  }
65 
66 
67  // Constructors
68 
69  //- Construct from a source and a target patch
71  (
72  const SrcPatchType& srcPatch,
73  const TgtPatchType& tgtPatch,
74  const scalar snapTol
75  );
76 
77  //- Construct from a source and a target patch, and specified source
78  // point normals
80  (
81  const SrcPatchType& srcPatch,
82  const vectorField& srcPointNormals,
83  const TgtPatchType& tgtPatch,
84  const scalar snapTol
85  );
86 
87 
88  //- Destructor
89  virtual ~FacePatchIntersection();
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #ifdef NoRepository
100  #include "FacePatchIntersection.C"
101 #endif
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
Patch intersection based on polygonal faces. This triangulates the supplied patches and passes them t...
FacePatchIntersection(const SrcPatchType &srcPatch, const TgtPatchType &tgtPatch, const scalar snapTol)
Construct from a source and a target patch.
virtual ~FacePatchIntersection()
Destructor.
Base class for patch intersections. Provides storage and access to the intersection points and faces ...
const SrcPatchType & srcPatch() const
The source patch.
const TgtPatchType & tgtPatch() const
The target patch.
A class for handling words, derived from string.
Definition: word.H:62
word capitalise() const
Return the word with the first letter capitalised.
Definition: wordI.H:131
Namespace for OpenFOAM.