intersection.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 | Copyright (C) 2011 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 private:
53 
54  // Static data
55 
56  //- Relative tolerance for point in a plane.
57  // The tolerance is relative to the object size.
58  // Used to determine if a half-ray from a point in plane of triangle
59  // intersects the triangle or not.
60  static scalar planarTol_;
61 
62 public:
63 
64  enum direction
65  {
68  };
69 
70  enum algorithm
71  {
72  FULL_RAY, // Intersecting with full ray
73  HALF_RAY, // Intersecting with half ray
74  VISIBLE // Intersecting with the visible side
75  };
76 
77  // Static Member Functions
78 
79  //- Direction names
81 
82  //- Projection algorithm names
84 
85  //- Return planar tolerance
86  static scalar planarTol()
87  {
88  return planarTol_;
89  }
90 
91  //- Set the planar tolerance, returning the previous value
92  static scalar setPlanarTol(const scalar t)
93  {
94  if (t < -VSMALL)
95  {
97  (
98  "scalar intersection::setPlanarTol(const scalar t)"
99  ) << "Negative planar tolerance. This is not allowed."
100  << abort(FatalError);
101  }
102 
103  scalar oldTol = planarTol_;
104  planarTol_ = t;
105 
106  return oldTol;
107  }
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
static const NamedEnum< algorithm, 3 > algorithmNames_
Projection algorithm names.
Definition: intersection.H:82
Namespace for OpenFOAM.
static scalar setPlanarTol(const scalar t)
Set the planar tolerance, returning the previous value.
Definition: intersection.H:91
static const NamedEnum< direction, 2 > directionNames_
Direction names.
Definition: intersection.H:79
errorManip< error > abort(error &err)
Definition: errorManip.H:131
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
static scalar planarTol()
Return planar tolerance.
Definition: intersection.H:85
error FatalError
Foam::intersection.
Definition: intersection.H:49