treeDataTriSurface.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::treeDataTriSurface
28 
29 Description
30  Encapsulates data for (indexedOc)tree searches on a triSurface.
31 
32 SourceFiles
33  treeDataTriSurface.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef treeDataTriSurface_H
38 #define treeDataTriSurface_H
39 
40 #include "treeDataPrimitivePatch.H"
41 #include "triSurface.H"
42 #include "point.H"
43 #include "indexedOctree.H"
44 #include "volumeType.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
51 
52  //- Template specialisation of getVolumeType for treeDataTriSurface
53  template<>
55  (
57  const point& sample
58  ) const;
59 }
60 
61 
62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
63 
64 #endif
65 
66 // ************************************************************************* //
Foam::treeDataPrimitivePatch::getVolumeType
volumeType getVolumeType(const indexedOctree< treeDataPrimitivePatch< PatchType >> &, const point &) const
Get type (inside,outside,mixed,unknown) of point w.r.t. surface.
Definition: treeDataPrimitivePatch.C:133
point.H
indexedOctree.H
triSurface.H
volumeType.H
Foam::volumeType
An enumeration wrapper for classification of a location as being inside/outside of a volume.
Definition: volumeType.H:60
Foam::indexedOctree
Non-pointer based hierarchical recursive searching.
Definition: treeDataEdge.H:50
treeDataPrimitivePatch.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::treeDataTriSurface
treeDataPrimitivePatch< triSurface > treeDataTriSurface
Definition: treeDataTriSurface.H:49
Foam::Vector< scalar >
Foam::treeDataPrimitivePatch
Encapsulation of data needed to search on PrimitivePatches.
Definition: treeDataPrimitivePatch.H:63
sample
Minimal example by using system/controlDict.functions: