PointEdgeWave.H 10.3 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
6 7 8 9 10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11 12 13 14
    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.
15 16 17 18 19 20 21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23 24 25 26 27 28

Class
    Foam::PointEdgeWave

Description
    Wave propagation of information through grid. Every iteration
29
    information goes through one layer of edges.
30 31

    Templated on information that is transferred.
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
    Handles parallel and cyclics. Only parallel reasonably tested. Cyclics
    hardly tested.

    Note: whether to propagate depends on the return value of Type::update
    which returns true (i.e. propagate) if the value changes by more than a
    certain tolerance.

    Note: parallel is done in two steps:
      -# transfer patch points in offset notation, i.e. every patch
         point is denoted by a patchface label and an index in this face.
         Receiving end uses that fact that f[0] is shared and order is
         reversed.
      -# do all non-local shared points by means of reduce of data on them.

    Note: cyclics is with offset in patchface as well. Patch is divided into
    two sub patches and the point-point addressing is never explicitly
    calculated but instead use is made of the face-face correspondence.
    (it probably is more efficient to calculate a point-point
    correspondence at the start and then reuse this; task to be done)

SourceFiles
    PointEdgeWave.C

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

#ifndef PointEdgeWave_H
#define PointEdgeWave_H

#include "boolList.H"
#include "scalarField.H"
63
#include "tensorField.H"
64 65 66 67 68 69 70

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

namespace Foam
{

// Forward declaration of classes
71
class polyMesh;
72
class polyPatch;
73 74 75 76 77 78 79 80 81 82 83 84

/*---------------------------------------------------------------------------*\
                        Class PointEdgeWaveName Declaration
\*---------------------------------------------------------------------------*/

TemplateName(PointEdgeWave);


/*---------------------------------------------------------------------------*\
                           Class PointEdgeWave Declaration
\*---------------------------------------------------------------------------*/

Henry's avatar
Henry committed
85
template<class Type, class TrackingData = int>
86 87 88 89 90 91 92 93 94 95 96
class PointEdgeWave
:
    public PointEdgeWaveName
{
  // Private static data

        //- Relative tolerance. Stop propagation if relative changes
        //  less than this tolerance (responsability for checking this is
        //  up to Type implementation)
        static scalar propagationTol_;

97 98
        //- Used as default trackdata value to satisfy default template
        //  argument.
mattijs's avatar
mattijs committed
99
        static int dummyTrackData_;
100

101 102 103 104

    // Private data

        //- Reference to mesh
105
        const polyMesh& mesh_;
106 107

        //- Wall information for all points
108
        UList<Type>& allPointInfo_;
109 110

        //- Information on all mesh edges
111 112 113 114
        UList<Type>& allEdgeInfo_;

        //- Additional data to be passed into container
        TrackingData& td_;
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130

        //- Has point changed
        boolList changedPoint_;

        //- List of changed points
        labelList changedPoints_;

        //- Number of changed points
        label nChangedPoints_;

        //- Edges that have changed
        boolList changedEdge_;
        labelList changedEdges_;
        label nChangedEdges_;

        //- Number of cyclic patches
131
        label nCyclicPatches_;
132 133 134 135 136 137 138 139 140 141 142 143 144 145

        //- Number of evaluations
        label nEvals_;

        //- Number of unvisited edges/points
        label nUnvisitedPoints_;
        label nUnvisitedEdges_;


    // Private Member Functions

        //- Adapt pointInfo for leaving domain
        void leaveDomain
        (
146
            const polyPatch&,
147 148 149 150 151 152 153
            const List<label>& patchPointLabels,
            List<Type>& pointInfo
        ) const;

        //- Adapt pointInfo for entering domain
        void enterDomain
        (
154
            const polyPatch&,
155 156 157 158 159 160 161
            const List<label>& patchPointLabels,
            List<Type>& pointInfo
        ) const;

        //- Transform. Implementation referred to Type
        void transform
        (
162
            const polyPatch& patch,
163 164 165 166 167 168 169 170
            const tensorField& rotTensor,
            List<Type>& pointInfo
        ) const;

        //- Updates pointInfo with information from neighbour. Updates all
        //  statistics.
        bool updatePoint
        (
171
            const label pointi,
172 173 174 175 176 177 178 179 180
            const label neighbourEdgeI,
            const Type& neighbourInfo,
            Type& pointInfo
        );

        //- Updates pointInfo with information from same point. Updates all
        //  statistics.
        bool updatePoint
        (
181
            const label pointi,
182 183 184 185 186 187 188 189 190
            const Type& neighbourInfo,
            Type& pointInfo
        );

        //- Updates edgeInfo with information from neighbour. Updates all
        //  statistics.
        bool updateEdge
        (
            const label edgeI,
191
            const label neighbourPointi,
192 193 194 195 196 197 198
            const Type& neighbourInfo,
            Type& edgeInfo
        );

        // Parallel, cyclic

            //- Has patches of certain type?
Henry's avatar
Henry committed
199
            template<class PatchType>
200 201 202 203 204 205 206 207
            label countPatchType() const;

            //- Merge data from across processor boundaries
            void handleProcPatches();

            //- Merge data from across cyclic boundaries
            void handleCyclicPatches();

208 209 210
            //- Explicitly sync all collocated points
            label handleCollocatedPoints();

211 212 213 214 215 216 217

        //- Disallow default bitwise copy construct
        PointEdgeWave(const PointEdgeWave&);

        //- Disallow default bitwise assignment
        void operator=(const PointEdgeWave&);

Andrew Heather's avatar
Andrew Heather committed
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
public:

    // Static Functions

        //- Access to tolerance
        static scalar propagationTol()
        {
            return propagationTol_;
        }

        //- Change tolerance
        static void setPropagationTol(const scalar tol)
        {
            propagationTol_ = tol;
        }


    // Constructors

        //- Construct from mesh, list of changed points with the Type
        //  for these points. Gets work arrays to operate on, one of size
        //  number of mesh points, the other number of mesh edges.
        //  Iterates until nothing changes or maxIter reached.
        //  (maxIter can be 0)
        PointEdgeWave
        (
245
            const polyMesh& mesh,
246 247
            const labelList& initialPoints,
            const List<Type>& initialPointsInfo,
248 249 250 251
            UList<Type>& allPointInfo,
            UList<Type>& allEdgeInfo,
            const label maxIter,
            TrackingData& td = dummyTrackData_
252 253
        );

254 255 256 257 258
        //- Construct from mesh. Use setPointInfo and iterate() to do
        //  actual calculation
        PointEdgeWave
        (
            const polyMesh& mesh,
259 260 261
            UList<Type>& allPointInfo,
            UList<Type>& allEdgeInfo,
            TrackingData& td = dummyTrackData_
262 263
        );

264

265 266
    //- Destructor
    ~PointEdgeWave();
267 268 269 270


    // Member Functions

271 272
        //- Access allPointInfo
        UList<Type>& allPointInfo() const
273 274 275 276
        {
            return allPointInfo_;
        }

277 278
        //- Access allEdgeInfo
        UList<Type>& allEdgeInfo() const
279 280 281 282
        {
            return allEdgeInfo_;
        }

283 284 285 286 287 288
        //- Additional data to be passed into container
        const TrackingData& data() const
        {
            return td_;
        }

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
        //- Get number of unvisited edges, i.e. edges that were not (yet)
        //  reached from walking across mesh. This can happen from
        //  - not enough iterations done
        //  - a disconnected mesh
        //  - a mesh without walls in it
        label getUnsetEdges() const;

        label getUnsetPoints() const;

        //- Copy initial data into allPointInfo_
        void setPointInfo
        (
            const labelList& changedPoints,
            const List<Type>& changedPointsInfo
        );

        //- Propagate from point to edge. Returns total number of edges
        //  (over all processors) changed.
        label pointToEdge();

        //- Propagate from edge to point. Returns total number of points
        //  (over all processors) changed.
        label edgeToPoint();

        //- Iterate until no changes or maxIter reached. Returns actual
        //  number of iterations.
        label iterate(const label maxIter);
};


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

/*---------------------------------------------------------------------------*\
                        Class listUpdateOp Declaration
\*---------------------------------------------------------------------------*/

//- List update operation
Henry's avatar
Henry committed
326
template<class Type, class TrackingData = int>
327 328
class listUpdateOp
{
329 330 331 332 333
    //- Additional data to be passed into container

    const scalar tol_;

    TrackingData& td_;
334 335

public:
336 337 338 339 340
    listUpdateOp(const scalar tol, TrackingData& td)
    :
        tol_(tol),
        td_(td)
    {}
341 342 343 344 345

    void operator()(List<Type>& x, const List<Type>& y) const
    {
        forAll(x, i)
        {
346
            if (y[i].valid(td_))
347
            {
348
                x[i].updatePoint(y[i], tol_, td_);
349
            }
mattijs's avatar
mattijs committed
350
        }
351 352 353 354 355 356 357 358 359
    }
};

} // End namespace Foam


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

#ifdef NoRepository
360
    #include "PointEdgeWave.C"
361 362 363 364 365 366 367
#endif

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

#endif

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