File size: 7,535 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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2024-2025 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/>.

Namespace
    Foam::tracking

Description
    Functions for tracking locations through a mesh

SourceFiles
    tracking.C

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

#ifndef tracking_H
#define tracking_H

#include "polyMesh.H"
#include "barycentric.H"
#include "barycentricTensor.H"
#include "vector.H"

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

namespace Foam
{

class meshSearch;
class wedgePolyPatch;
class cyclicPolyPatch;
class processorPolyPatch;

namespace tracking
{

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

// Geometry

    //- Return the position given the coordinates and tet topology
    inline point position
    (
        const polyMesh& mesh,
        const barycentric& coordinates,
        const label celli,
        const label facei,
        const label faceTrii,
        const scalar stepFraction
    );

    //- Return the coordinates given the position and tet topology
    barycentric coordinates
    (
        const polyMesh& mesh,
        const point& position,
        const label celli,
        const label facei,
        const label faceTrii,
        const scalar stepFraction
    );

    //- Return the normal of the corresponding point on the associated face and
    //  the displacement of that point over the time-step
    Pair<vector> faceNormalAndDisplacement
    (
        const polyMesh& mesh,
        const barycentric& coordinates,
        const label celli,
        const label facei,
        const label faceTrii,
        const scalar stepFraction
    );


// Tracking

    //- Track along the displacement for a given fraction of the overall
    //  time-step. End when the track is complete or when a face is hit. Return
    //  whether or not a face was hit (true) or the track completed (false) and
    //  the proportion of the displacement still to be completed. Displacement
    //  can be a single vector, d, in which case the path is linear and equal
    //  to x0 + lambda*d, where x0 is the starting position and lambda is the
    //  local coordinate along the path. Or, displacement can be a pair of
    //  vectors, d1 and d2, in which case the path is parabolic and equal to
    //  x0 + lambda*d1 + lambda*lambda*d2.
    template<class Displacement>
    Tuple2<bool, scalar> toFace
    (
        const polyMesh& mesh,
        const Displacement& displacement,
        const scalar fraction,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii,
        scalar& stepFraction,
        scalar& stepFractionBehind,
        label& nTracksBehind,
        const string& debugPrefix = NullObjectRef<string>()
    );

    //- As toFace, except that if the track ends on an internal face then this
    //  face will be crossed
    template<class Displacement>
    Tuple2<bool, scalar> toCell
    (
        const polyMesh& mesh,
        const Displacement& displacement,
        const scalar fraction,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii,
        scalar& stepFraction,
        scalar& stepFractionBehind,
        label& nTracksBehind,
        const string& debugPrefix = NullObjectRef<string>()
    );

    //- As toFace, except that the track continues across multiple cells until
    //  it ends or until a boundary face is hit
    template<class Displacement>
    Tuple2<bool, scalar> toBoundary
    (
        const polyMesh& mesh,
        const Displacement& displacement,
        const scalar fraction,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii,
        scalar& stepFraction,
        scalar& stepFractionBehind,
        label& nTracksBehind,
        const string& debugPrefix = NullObjectRef<string>()
    );


// Initialisation

    //- Initialise the location at the given position. Returns whether or not a
    //  boundary was hit. The cell index must be valid.
    bool locate
    (
        const polyMesh& mesh,
        const point& position,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii,
        const scalar stepFraction,
        const string& debugPrefix = NullObjectRef<string>()
    );

    //- Initialise the location at the given position. Returns whether or not a
    //  boundary was hit. The cell index may be invalid, in which case a tree
    //  search is performed to find the cell containing the position.
    bool locate
    (
        const meshSearch& searchEngine,
        const point& position,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii,
        const scalar stepFraction,
        const string& debugPrefix = NullObjectRef<string>()
    );


// Topology Changes

    //- Cross an internal face
    void crossInternalFace
    (
        const polyMesh& mesh,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii
    );

    //- Cross a wedge patch
    void crossWedge
    (
        const wedgePolyPatch& inPatch,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii,
        const scalar stepFraction
    );

    //- Cross a cyclic patch
    void crossCyclic
    (
        const cyclicPolyPatch& inPatch,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii
    );

    //- Initialise crossing of a processor patch. Breaks the topology in order
    //  to store the destination patch face in advance of communication.
    void inProcessor
    (
        const processorPolyPatch& inPatch,
        label& celli,
        label& facei
    );

    //- Complete crossing of a processor patch. Restore the topology.
    void outProcessor
    (
        const processorPolyPatch& outPatch,
        barycentric& coordinates,
        label& celli,
        label& facei,
        label& faceTrii
    );

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

} // End namespace tracking
} // End namespace Foam

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

#include "trackingI.H"

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

#endif

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