openfoam/applications/test/dynamicIndexedOctree/Test-dynamicIndexedOctree.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2012 OpenFOAM Foundation
    Copyright (C) 2023 OpenCFD Ltd.
-------------------------------------------------------------------------------
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
    Test the construction, insertion and removal of points from the dynamic
    indexed octree.

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

#include "argList.H"
#include "cpuTime.H"
#include "treeBoundBox.H"
#include "dynamicIndexedOctree.H"
#include "dynamicTreeDataPoint.H"
#include "indexedOctree.H"
#include "treeDataPoint.H"

using namespace Foam;

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Main program:

int main(int argc, char *argv[])
{
    cpuTime timer;

    treeBoundBox overallBb
    (
        point(0,0,0),
        point(1,1,1)
    );

    label size = 5e6;

    Info<< "Creating indexed octrees with " << size
        << " points in bounding box: " << overallBb << endl;


// Create the data

    DynamicList<point> pointList(size);
    pointField pointFieldList(size);

    for (label pI = size - 1; pI >= 0; --pI)
    {
        scalar factor = pI/scalar(size);

        pointList.push_back(0.99*point::uniform(factor));
        pointFieldList[pI] = 0.99*point::uniform(factor);
    }

    for (label i=0; i<5; ++i)
    {
        pointList.emplace_back(0.95, 0.95, 0.95);
        pointFieldList.emplace_back(0.95, 0.95, 0.95);
    }

    Info<< "Time to construct lists of points: "
        << timer.cpuTimeIncrement() << endl;


// Construct the trees

    dynamicIndexedOctree<dynamicTreeDataPoint> tree
    (
        dynamicTreeDataPoint(pointList),
        overallBb,  // overall search domain
        20,         // max levels
        100,        // maximum ratio of cubes v.s. cells
        100.0       // max. duplicity; n/a since no bounding boxes.
    );

    Info<< "Time to construct dynamic tree:    "
        << timer.cpuTimeIncrement() << endl;

    indexedOctree<treeDataPoint> tree2
    (
        treeDataPoint(pointFieldList),
        overallBb,  // overall search domain
        20,         // max levels
        100,       // maximum ratio of cubes v.s. cells
        100.0       // max. duplicity; n/a since no bounding boxes.
    );

    Info<< "Time to construct normal tree:     "
        << timer.cpuTimeIncrement() << endl;

    Info<< "Statistics of the dynamic tree:" << endl;
    tree.writeTreeInfo();


// Test calls to findNearest()

    point p(0.94,0.94,0.94);

    Info<< "Nearest point to " << p << " = "
        << tree.findNearest(p, 0.4) << endl;

    for (label i = 0; i < size; ++i)
    {
        tree.findNearest
        (
            point(scalar(i)/size, scalar(i)/size, scalar(i)/size),
            0.4
        );
    }

    Info<< "Time to perform " << size
        << " findNearest() calls on the dynamic tree: "
        << timer.cpuTimeIncrement() << endl;

    for (label i = 0; i < size; ++i)
    {
        tree2.findNearest
        (
            point(scalar(i)/size, scalar(i)/size, scalar(i)/size),
            0.4
        );
    }

    Info<< "Time to perform " << size
        << " findNearest() calls on the normal tree: "
        << timer.cpuTimeIncrement() << endl;


// Test point insertion

    label index = pointList.size();
    pointList.push_back(p);

    Info<< nl << "Inserting point " << p << " with index " << index << endl;

    // Now insert a point into the tree.
    tree.insert(index, pointList.size());

    Info<< "Nearest point to " << p << " = "
        << tree.findNearest(p, 0.4) << endl;

    index = pointList.size();
    pointList.push_back(p);

    Info<< "Inserting same point " << p << " with index " << index << endl;

    tree.insert(index, pointList.size());

    Info<< "Nearest point to " << p << " = "
        << tree.findNearest(p, 0.4) << endl;

    Info<< nl << "Tree after insertion:" << endl;
    tree.writeTreeInfo();


// Test point removal

    label nRemoved = 0;
    for (label pI = size - 5; pI >= 5; pI--)
    {
        tree.remove(pI);
        ++nRemoved;
    }

    Info<< "Time to remove " << nRemoved << " points from the tree: "
        << timer.cpuTimeIncrement() << endl;

    Info<< nl << "Tree after removal:" << endl;
    tree.writeTreeInfo();

    Info<< "Nearest point to " << p << " = "
        << tree.findNearest(p, 0.4) << endl;

    return 0;
}


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