File size: 5,589 Bytes
5a600cf
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2021-2022 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Description
    Class to encapsulate the topology of a point within a triangle intersection

SourceFiles
    triIntersectLocationI.H
    triIntersectLocationIO.C

\*---------------------------------------------------------------------------*/

#ifndef triIntersectLocation_H
#define triIntersectLocation_H

#include "labelPair.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

// Forward declaration of classes
class Ostream;

namespace triIntersect
{

// Forward declaration of friend functions and operators
class location;
bool operator==(const location& a, const location& b);
bool operator!=(const location& a, const location& b);
Ostream& operator<<(Ostream&, const location&);

/*---------------------------------------------------------------------------*\
                          Class location Declaration
\*---------------------------------------------------------------------------*/

class location
:
    private labelPair
{
    private:

        // Private Static Member Functions

            //- Return the null index
            inline static label noi();


        // Private Constructors

            //- Construct from a source index and a target index
            inline location(const label srci, const label tgti);


    public:

        // Static Member Functions

            //- Construct a source point location
            inline static location srcPoint(const label srcPi);

            //- Construct a target point location
            inline static location tgtPoint(const label tgtPi);

            //- Construct a source and target point location
            inline static location srcTgtPoint
            (
                const label srcPi,
                const label tgtPi
            );

            //- Construct an intersection location between a source and a
            //  target edge
            inline static location intersection
            (
                const label srcEi,
                const label tgtEi
            );


        // Constructors

            //- Construct null
            inline location();


        // Member Functions

            //- Return whether the location is null
            inline bool isNull() const;

            //- Return whether the location is a source point
            inline bool isSrcPoint() const;

            //- Return whether the location is a target point
            inline bool isTgtPoint() const;

            //- Return whether the location is a source point and not a target
            //  point
            inline bool isSrcNotTgtPoint() const;

            //- Return whether the location is a target point and not a source
            //  point
            inline bool isTgtNotSrcPoint() const;

            //- Return whether the location is a source point and a target point
            inline bool isSrcAndTgtPoint() const;

            //- Return whether the location is an intersection
            inline bool isIntersection() const;

            //- Return the source point index
            inline label srcPointi() const;

            //- Return the target point index
            inline label tgtPointi() const;

            //- Return the source edge index
            inline label srcEdgei() const;

            //- Return the target edge index
            inline label tgtEdgei() const;


        // Friend Operators

            //- Test if locations are the same
            inline friend bool operator==(const location& a, const location& b);

            //- Test if locations are not the same
            inline friend bool operator!=(const location& a, const location& b);


        // IOstream Operators

            //- Output the location to a stream
            friend Ostream& operator<<(Ostream& os, const location& l);
};

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace triIntersect

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

template<>
inline bool contiguous<triIntersect::location>()
{
    return true;
}

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "triIntersectLocationI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //