All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
intersection.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) 2011-2018 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::intersection
26 
27 Description
28  Foam::intersection
29 
30 SourceFiles
31  intersection.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef intersection_H
36 #define intersection_H
37 
38 #include "scalar.H"
39 #include "NamedEnum.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class intersection Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class intersection
51 {
52  // Static data
53 
54  //- Relative tolerance for point in a plane.
55  // The tolerance is relative to the object size.
56  // Used to determine if a half-ray from a point in plane of triangle
57  // intersects the triangle or not.
58  static scalar planarTol_;
59 
60 public:
61 
62  enum class direction
63  {
64  vector,
66  };
67 
68  enum class algorithm
69  {
70  fullRay, // Intersecting with full ray
71  halfRay, // Intersecting with half ray
72  visible // Intersecting with the visible side
73  };
74 
75  // Static Member Functions
76 
77  //- Direction names
79 
80  //- Projection algorithm names
82 
83  //- Return planar tolerance
84  static scalar planarTol()
85  {
86  return planarTol_;
87  }
88 
89  //- Set the planar tolerance, returning the previous value
90  static scalar setPlanarTol(const scalar t)
91  {
92  if (t < -vSmall)
93  {
95  }
96 
97  scalar oldTol = planarTol_;
98  planarTol_ = t;
99 
100  return oldTol;
101  }
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
error FatalError
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
static const NamedEnum< algorithm, 3 > algorithmNames_
Projection algorithm names.
Definition: intersection.H:80
static scalar setPlanarTol(const scalar t)
Set the planar tolerance, returning the previous value.
Definition: intersection.H:89
Foam::intersection.
Definition: intersection.H:49
static scalar planarTol()
Return planar tolerance.
Definition: intersection.H:83
errorManip< error > abort(error &err)
Definition: errorManip.H:131
static const NamedEnum< direction, 2 > directionNames_
Direction names.
Definition: intersection.H:77
Namespace for OpenFOAM.