polyPatchIntersection.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::polyPatchIntersection
26 
27 Description
28  Intersection between two polyPatches
29 
30 SourceFiles
31  polyPatchIntersection.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef polyPatchIntersection_H
36 #define polyPatchIntersection_H
37 
38 #include "PatchIntersection.H"
39 #include "polyPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class polyPatchIntersection Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public PatchIntersection<polyPatch, polyPatch>
53 {
54 public:
55 
56  // Runtime type information
57 
58  virtual word type() const
59  {
60  return "primitive" + patchIntersection::typeName.capitalise();
61  }
62 
63 
64  // Constructors
65 
66  //- Construct from a source and a target patch
68  (
69  const polyPatch& srcPatch,
70  const polyPatch& tgtPatch,
71  const scalar snapTol
72  );
73 };
74 
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 } // End namespace Foam
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 #endif
83 
84 // ************************************************************************* //
Base class for patch intersections. Provides storage and access to the intersection points and faces ...
const polyPatch & srcPatch() const
The source patch.
const polyPatch & tgtPatch() const
The target patch.
Intersection between two polyPatches.
polyPatchIntersection(const polyPatch &srcPatch, const polyPatch &tgtPatch, const scalar snapTol)
Construct from a source and a target patch.
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:70
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.