FSubOctree.hpp 24.9 KB
Newer Older
1
// ===================================================================================
2
3
4
5
6
// Copyright ScalFmm 2011 INRIA, Olivier Coulaud, Bérenger Bramas, Matthias Messner
// olivier.coulaud@inria.fr, berenger.bramas@inria.fr
// This software is a computer program whose purpose is to compute the FMM.
//
// This software is governed by the CeCILL-C and LGPL licenses and
7
8
// abiding by the rules of distribution of free software.
//
9
10
11
12
// This program 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 and CeCILL-C Licenses for more details.
13
// "http://www.cecill.info".
14
// "http://www.gnu.org/licenses".
15
// ===================================================================================
16
17
#ifndef FSUBOCTREE_HPP
#define FSUBOCTREE_HPP
18

19
20

#include "../Utils/FGlobal.hpp"
BRAMAS Berenger's avatar
BRAMAS Berenger committed
21
#include "../Utils/FPoint.hpp"
22
23
24
25
26
27
28
29
30
31
32
33
34
#include "../Utils/FAssertable.hpp"
#include "../Utils/FMath.hpp"

#include "FTreeCoordinate.hpp"


/**
 * @author Berenger Bramas (berenger.bramas@inria.fr)
 * @class FAbstractSubOctree
 * Please read the license
 *
 * This class is a sub-octree container.
 * This class is the main component of the octree.
35
 *
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 * This class does not have a main root. In fact, the root
 * is contained in the parent sub-octree.
 *
 * If the sub-octree is a middle suboctree, the leaf level is pointers
 * on other suboctrees.
 *
 * If the sub-octree is a bottom subtree then the leaf level is pointers on
 * lists<particle>
 *
 * This two situations are implemented in two different classes that inherite of FAbstractSubOctree.
 *
 * Please refere to testOctree.cpp to see an example
 * @warning Give the particleClass & cellClass
 */
50
template< class CellClass , class ContainerClass, class LeafClass>
51
52
53
54
55
56
class FAbstractSubOctree : protected FAssertable{
protected:

    CellClass*** cells;		            //< Potential cells, cells are allocated only if needed
    FAbstractSubOctree* const parent;       //< Parent suboctree (null for root)

57
    const int indexInParent;                //< This is the index of the current octree in the parent's array
58

59
60
    int leftLeafIndex;                      //< The leaf at the left position (this is the array index to start when iterate)
    int rightLeafIndex;                     //< The leaf at the right position (this is the last array index when iterate)
61
62
63
64

    const int subOctreeHeight;              //< Height of this suboctree
    const int subOctreePosition;	    //< Level of the current suboctree in the global tree (0 if node)

65
66
    const bool isLeafSubtree;               //< To know if a subtree is leaf or not (we prefere that to a virtual method)

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

    /**
     * This function compute the morton index for the last level of this suboctree.
     * suppose we have an index like : 000.010.111.001.101.110
     * and now considere that suboctree's height is 2, the morton index have to be cut as :
     * [000.010].[111.001].[101.110] each part correspond to a morton index a leaf level for the
     * different suboctrees.
     * This is why depending on the level of the octree we need to remove extra part on the left and
     * on the right.
     */
    MortonIndex getLeafIndex(const MortonIndex index, const int inTreeHeight) const {
        // Remove right useless part - used by child
        const MortonIndex fullIndex = index >> (3 * (inTreeHeight - (this->subOctreeHeight + this->subOctreePosition) ) );
        // Remove left extra data part - used by parent
        const MortonIndex treeLeafMask = ~(~0x00LL << (3 *  this->subOctreeHeight ));
        return treeLeafMask & fullIndex;
    }

    /**
     * This function creats all the intermediates cells between
     * a leaf and the root.
     * It is used after inserting a new leaf to have cells from leaf to root
     * when computing
     * @param arrayIndex the index at the leaf index of the new element
     */
92
    void createPreviousCells(MortonIndex arrayIndex, MortonIndex inLeafCellIndex, const FTreeCoordinate& treePosition){
93
        int indexLevel = this->subOctreeHeight - 1;
94
        int bottomToTop = 0;
95
        while(indexLevel >= 0 && !this->cells[indexLevel][arrayIndex]){
96
97
            CellClass* const newNode = new CellClass();
            newNode->setMortonIndex(inLeafCellIndex);
98

99
            newNode->setCoordinate(treePosition.getX() >> bottomToTop,
100
101
                                   treePosition.getY() >> bottomToTop,
                                   treePosition.getZ() >> bottomToTop);
102

103
104
            this->cells[indexLevel][arrayIndex] = newNode;

105
            --indexLevel;
106
            ++bottomToTop;
107
108
109
110
111
112
113
114
115
116
117

            arrayIndex >>= 3;
            inLeafCellIndex >>= 3;
        }
    }

    /**
      * This function is initializing variables when a new leaf is inserted in the tree
      * for example it updates the leaf array marges and calls createPreviousCells()
      * @param arrayIndex the position of the new leaf in the leafs array
      */
118
119
    void newLeafInserted(const int arrayIndex, const MortonIndex inLeafCellIndex,  const FTreeCoordinate& host){
        createPreviousCells(arrayIndex,inLeafCellIndex, host);
120
121
122
123
124
        // Update if this is the bottom left
        if(arrayIndex < this->leftLeafIndex) this->leftLeafIndex = arrayIndex;
        if(arrayIndex > this->rightLeafIndex) this->rightLeafIndex = arrayIndex;
    }

125
126
127
128
129
130
    /** Remove every cells from the array index
      * the leaf cell is removed, then we go upper and test,
      * does the upper cell do no have any more child, if tree remove
      * this cell too and go upper, etc.
      * @return true if there is no more cells in this tree
      */
131
    bool removeCellsFromLeaf( int arrayIndex ){
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
        // last array index
        int indexLevel = this->subOctreeHeight - 1;

        // Manage border limits
        if(arrayIndex == this->leftLeafIndex && arrayIndex == this->rightLeafIndex){
            // only one cells, return true
            return true;
        }
        else if(arrayIndex == this->leftLeafIndex){
            while( !this->cells[indexLevel][++this->leftLeafIndex] );
        }
        else if(arrayIndex == this->rightLeafIndex){
            while( !this->cells[indexLevel][--this->rightLeafIndex] );
        }

        // remove the last cells
        delete this->cells[indexLevel][arrayIndex];
        this->cells[indexLevel][arrayIndex] = 0;
        // progress upper
        --indexLevel;
        arrayIndex >>= 3;

        // to test if 8 child are empty
        CellClass* emptyArray[8];
        memset(emptyArray , 0, sizeof(CellClass*) * 8);

        // continue while we are not in the last level and our child are empty
        while(indexLevel >= 0 && memcmp(&this->cells[indexLevel+1][arrayIndex<<3], emptyArray, 8 * sizeof(CellClass*)) == 0 ){
            delete this->cells[indexLevel][arrayIndex];
            this->cells[indexLevel][arrayIndex] = 0;

            --indexLevel;
            arrayIndex >>= 3;
        }
        // return true if there is no more child == 0 cell at level 0
        return memcmp(this->cells[0], emptyArray, 8 * sizeof(CellClass*)) == 0;
    }

170
171
172
173
174
175
176
177
178
179
180
181
182
    /** Disable copy */
private:
    FAbstractSubOctree(const FAbstractSubOctree&){}
    FAbstractSubOctree& operator=(const FAbstractSubOctree&){return *this;}

public:
    /**
    * Constructor
    * Allocate the cells arrays to be able to create every potential cells
    * @param inParent the SubOctree parent (0 if node)
    * @param inSubOctreeHeight Height of this suboctree
    * @param inSubOctreePosition Level of the current suboctree in the global tree (1 if upper tree)
    */
183
    FAbstractSubOctree(FAbstractSubOctree* const inParent, const int inIndexInParent,
184
                       const int inSubOctreeHeight, const int inSubOctreePosition, const bool inIsLeafSubtree) :
185
                        cells(0), parent( inParent ), indexInParent(inIndexInParent), leftLeafIndex(1 << (3 * inSubOctreeHeight)), rightLeafIndex(-1),
186
                        subOctreeHeight( inSubOctreeHeight ), subOctreePosition( inSubOctreePosition ), isLeafSubtree(inIsLeafSubtree) {
187
188

        this->cells = new CellClass**[this->subOctreeHeight];
189
        fassert(this->cells, "Allocation failled", __LINE__, __FILE__);
190

berenger-bramas's avatar
berenger-bramas committed
191
192
        memset(this->cells, 0, sizeof(CellClass**) * subOctreeHeight);

193
        // We start at a sub-level - 8^1
194
        int cellsAtlevel = 8;
195
196
        for( int indexLevel = 0 ; indexLevel < this->subOctreeHeight ; ++indexLevel ){
            this->cells[indexLevel] = new CellClass*[cellsAtlevel];
197
            fassert(this->cells[indexLevel], "Allocation failled", __LINE__, __FILE__);
198

berenger-bramas's avatar
berenger-bramas committed
199
            memset(this->cells[indexLevel], 0, sizeof(CellClass*) * cellsAtlevel);
200
201
202
203
204
205
206
207
208
209

            cellsAtlevel <<= 3; // => * 8 >> 8^indexLevel
        }
    }

    /**
    * Destructor
    * Delete cells arrays and allocated cells
    */
    virtual ~FAbstractSubOctree(){
210
211
        int mostRight = rightLeafIndex;
        int mostLeft = leftLeafIndex;
212
213

        for( int indexLevel = this->subOctreeHeight - 1 ; indexLevel >= 0 ; --indexLevel ){
214
            for( int indexCells = mostLeft ; indexCells <= mostRight ; ++indexCells ){
215
                if(this->cells[indexLevel][indexCells]){
216
                    delete this->cells[indexLevel][indexCells];
217
218
219
220
                }
            }

            delete [] this->cells[indexLevel];
221
222
            mostLeft  >>= 3;
            mostRight >>= 3;
223
224
225
226
227
228
229
230
231
232
233
234
        }

        delete [] this->cells;
    }


    /**
    * Insert a particle on the subtree
    * @param index the morton index of the particle to insert
    * @param inParticle the particle to insert (must inherite from FAbstractParticle)
    * @param inParticle the inTreeHeight the height of the tree
    */
235
236
237
238
    /*template<typename... Args>
    void insert(const MortonIndex index, const FTreeCoordinate& host, const int inTreeHeight, const FPoint& inParticlePosition,
                        Args... args){
    }*/
239

240
241
242
243
244
245
    /**
      * Remove a leaf and every cells if needed
      * @return true if the subtree does not contains any more cells
      */
    virtual bool removeLeaf(const MortonIndex index, const int inTreeHeight) = 0;

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
    ///////////////////////////////////////
    // This is the FOctree::Iterator Part
    ///////////////////////////////////////

    /** Suboctree height accessor (leaf level + 1)
      * @return subOctreeHeight */
    int getSubOctreeHeight() const{
        return subOctreeHeight;
    }

    /** Suboctree position in the real tree
      * @return subOctreePosition */
    int getSubOctreePosition() const {
        return subOctreePosition;
    }

    /** Return the more left leaf index
      * the smallest index on the leafs array
      * @return leftLeafIndex */
265
    int getLeftLeafIndex() const {
266
267
268
269
270
271
        return leftLeafIndex;
    }

    /** Return the more right leaf index
      * the biggest index on the leafs array
      * @return rightLeafIndex */
272
    int getRightLeafIndex() const {
273
274
275
276
277
278
279
        return rightLeafIndex;
    }

    /** Return the array of cells at a specious index
      * @param level the level to access cells array (must be < subOctreeHeight)
      * @return cells[level] */
    CellClass** cellsAt(const int level) const{
280
        fassert(level < subOctreeHeight, "Level out of memory", __LINE__, __FILE__);
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
        return cells[level];
    }

    /** To know if it is the root suboctree
      * @return true if has parent otherwise return false */
    bool hasParent() const {
        return parent;
    }

    /** To get access to the parent suboctree
      * @return parent */
    FAbstractSubOctree* getParent(){
        return parent;
    }

    /** To get access to the parent suboctree (const version)
      * @return parent */
    const FAbstractSubOctree* getParent() const{
        return parent;
    }

    /** To get the index of the current suboctree in the parent leafs array
      * This index can is part of the morton index of the cells contains
      * in this suboctree
      * @return indexInParent */
306
    int getIndexInParent() const{
307
308
        return indexInParent;
    }
309
310
311
312
313
314
315
316

    /** To know if this class has been inherited by a leaf subtree or middle subtree
      * Of course we can do a virtual method to do that but virtual method are slower
      * if we point to parent class to call the method
      */
    bool isLeafPart() const{
        return this->isLeafSubtree;
    }
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
};



/////////////////////////////////////////////////////////////////////////////////////
// Last level sub octree
/////////////////////////////////////////////////////////////////////////////////////

/**
 * @author Berenger Bramas (berenger.bramas@inria.fr)
 * @class FSubOctreeWithLeafs
 * Please read the license
 *
 * This class is an sub-octree container.
 * But this is the specialized bottom part, in fact the last level is composed by
 * a cells array (managing by abstract class) and lists of particles.
 *
 * Please refere to testOctree.cpp to see an example.
 * @warning Give the particleClass & cellClass
 */
337
338
template< class CellClass , class ContainerClass, class LeafClass>
class FSubOctreeWithLeafs : public FAbstractSubOctree<CellClass,ContainerClass,LeafClass> {
339
private:
340
    typedef FAbstractSubOctree<CellClass,ContainerClass,LeafClass> Parent;
341

berenger-bramas's avatar
berenger-bramas committed
342
    LeafClass** leafs;            //< Leafs array
343

344
345
346
public:
    FSubOctreeWithLeafs(const FSubOctreeWithLeafs&) = delete;
    FSubOctreeWithLeafs& operator=(const FSubOctreeWithLeafs&) = delete;
347
348
349
350
351
352
353
354

    /**
    * Constructor
    * Allocate the leafs array
    * @param inParent the SubOctree parent (0 if node)
    * @param inSubOctreeHeight Height of this suboctree
    * @param inSubOctreePosition Level of the current suboctree in the global tree (1 if upper tree)
    */
355
    FSubOctreeWithLeafs(FAbstractSubOctree<CellClass,ContainerClass,LeafClass>* const inParent, const int inIndexInParent,
356
                        const int inSubOctreeHeight, const int inSubOctreePosition) :
357
                        FAbstractSubOctree<CellClass,ContainerClass,LeafClass>(inParent, inIndexInParent, inSubOctreeHeight, inSubOctreePosition, true) {
358

359
        const int cellsAtLeafLevel = 1 << (3 * inSubOctreeHeight);
360

berenger-bramas's avatar
berenger-bramas committed
361
        this->leafs = new LeafClass*[cellsAtLeafLevel];
362
        Parent::fassert(this->leafs, "Allocation failled", __LINE__, __FILE__);
363

berenger-bramas's avatar
berenger-bramas committed
364
        memset(leafs, 0, sizeof(LeafClass*) * cellsAtLeafLevel);
365
366
367
368
369
370
    }

    /**
    * Destructor dealloc all leafs & the leaf array
    */
    virtual ~FSubOctreeWithLeafs(){
berenger-bramas's avatar
berenger-bramas committed
371
        for( int indexLeaf = Parent::leftLeafIndex ; indexLeaf <= Parent::rightLeafIndex ; ++indexLeaf ){
372
373
374
375
376
377
378
379
380
381
            if(this->leafs[indexLeaf]){
                delete this->leafs[indexLeaf];
            }
        }
        delete [] this->leafs;
    }

    /**
    * Refer to FAbstractSubOctree::insert
    */
382
383
384
    template<typename... Args>
    void insert(const MortonIndex index, const FTreeCoordinate& host, const int inTreeHeight, const FPoint& inParticlePosition,
                        Args... args){
385
        // Get the morton index for the leaf level
berenger-bramas's avatar
berenger-bramas committed
386
        const MortonIndex arrayIndex = Parent::getLeafIndex(index,inTreeHeight);
387
388
        // is there already a leaf?
        if( !this->leafs[arrayIndex] ){
berenger-bramas's avatar
berenger-bramas committed
389
            this->leafs[arrayIndex] = new LeafClass();
390

berenger-bramas's avatar
berenger-bramas committed
391
            Parent::newLeafInserted( int(arrayIndex) , index, host);
392
393
        }
        // add particle to leaf list
394
395
396
397
398
399
400
401
402
403
404
405
406
407
        this->leafs[arrayIndex]->push(inParticlePosition, args... );
    }

    LeafClass* createLeaf(const MortonIndex index, const FTreeCoordinate& host, const int inTreeHeight){
        // Get the morton index for the leaf level
        const MortonIndex arrayIndex = Parent::getLeafIndex(index,inTreeHeight);
        // is there already a leaf?
        if( !this->leafs[arrayIndex] ){
            this->leafs[arrayIndex] = new LeafClass();

            Parent::newLeafInserted( int(arrayIndex) , index, host);
        }
        // add particle to leaf list
        return this->leafs[arrayIndex];
408
409
    }

410
411
412
413
414
    /**
      * Remove a leaf and every cells if needed
      */
    bool removeLeaf(const MortonIndex index, const int inTreeHeight) {
        // Get the morton index for the leaf level
berenger-bramas's avatar
berenger-bramas committed
415
        const MortonIndex arrayIndex = Parent::getLeafIndex(index,inTreeHeight);
416
417
418
419
420
        if( this->leafs[arrayIndex] ){
            // remove container
            delete this->leafs[arrayIndex];
            this->leafs[arrayIndex] = 0;

berenger-bramas's avatar
berenger-bramas committed
421
            return Parent::removeCellsFromLeaf( int(arrayIndex) );
422
423
424
425
        }
        return false;
    }

426
427
428
    /** To get access to leafs elements
      * @param index the position of the leaf
      * @return the list of particles at this index */
berenger-bramas's avatar
berenger-bramas committed
429
430
    ContainerClass* getLeafSrc(const int index){
        LeafClass* const leaf = this->leafs[index];
431
432
433
434
435
436
        return (leaf ? leaf->getSrc(): 0);
    }

    /** To get access to leafs elements
      * @param index the position of the leaf
      * @return the list of particles at this index */
berenger-bramas's avatar
berenger-bramas committed
437
438
    ContainerClass* getLeafTargets(const int index){
        LeafClass* const leaf = this->leafs[index];
439
440
441
442
443
444
        return (leaf ? leaf->getTargets(): 0);
    }

    /** To get access to leafs elements
      * @param index the position of the leaf
      * @return the list of particles at this index */
berenger-bramas's avatar
berenger-bramas committed
445
446
    const ContainerClass* getLeafSrc(const int index) const {
        LeafClass* const leaf = this->leafs[index];
447
448
449
450
451
452
        return (leaf ? leaf->getSrc(): 0);
    }

    /** To get access to leafs elements
      * @param index the position of the leaf
      * @return the list of particles at this index */
berenger-bramas's avatar
berenger-bramas committed
453
454
    const ContainerClass* getLeafTargets(const int index) const {
        LeafClass* const leaf = this->leafs[index];
455
456
457
        return (leaf ? leaf->getTargets() : 0);
    }

458
459
460
    LeafClass* getLeaf(const int index){
        return this->leafs[index];
    }
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
};



/////////////////////////////////////////////////////////////////////////////////////
// Middle level sub octree
/////////////////////////////////////////////////////////////////////////////////////

/**
 * @author Berenger Bramas (berenger.bramas@inria.fr)
 * @class FSubOctree
 * Please read the license
 *
 * This class is an sub-octree container.
 * This is the middle level specialized suboctree, it means that it does not contain
 * leaf but pointers to other suboctree.
 * These suboctrees at the last level can be FSubOctree of FSubOctreeWithLeafs depending
 * if they are at the bottom of the tree or not
 *
 * @warning Give the particleClass & cellClass
 */
482
483
template< class CellClass , class ContainerClass, class LeafClass>
class FSubOctree : public FAbstractSubOctree<CellClass,ContainerClass,LeafClass> {
484
private:
485
486
    typedef FAbstractSubOctree<CellClass,ContainerClass,LeafClass> Parent;
    typedef FSubOctreeWithLeafs<CellClass,ContainerClass,LeafClass> SubOctreeWithLeaf;
berenger-bramas's avatar
berenger-bramas committed
487
488

    Parent** subleafs;    //< Last levels is composed of suboctree
489

490
491
492
493
public:

    FSubOctree(const FSubOctree&) = delete;
    FSubOctree& operator=(const FSubOctree&) = delete;
494
495
496
497
498
499
500
501

    /**
    * Constructor
    * Allocate the subleafs array
    * @param inParent the SubOctree parent (0 if node)
    * @param inSubOctreeHeight Height of this suboctree
    * @param inSubOctreePosition Level of the current suboctree in the global tree (0 if upper tree)
    */
502
    FSubOctree(FAbstractSubOctree<CellClass,ContainerClass,LeafClass>* const inParent,  const int inIndexInParent,
503
               const int inSubOctreeHeight, const int inSubOctreePosition) :
504
            FAbstractSubOctree<CellClass,ContainerClass,LeafClass>(inParent, inIndexInParent, inSubOctreeHeight, inSubOctreePosition, false) {
505

506
        const int cellsAtLeafLevel = 1 << (3 * inSubOctreeHeight);
berenger-bramas's avatar
berenger-bramas committed
507
508

        this->subleafs = new Parent*[cellsAtLeafLevel];
509
        Parent::fassert(this->subleafs, "Allocation failled", __LINE__, __FILE__);
510

berenger-bramas's avatar
berenger-bramas committed
511
        memset(subleafs, 0, sizeof(Parent**) * cellsAtLeafLevel);
512
513
514
515
516
517
    }

    /**
    * Destructor dealloc all suboctrees leafs & leafs array
    */
    virtual ~FSubOctree(){
berenger-bramas's avatar
berenger-bramas committed
518
        for( int indexLeaf = Parent::leftLeafIndex ; indexLeaf <= Parent::rightLeafIndex ; ++indexLeaf ){
519
520
521
522
523
            if(this->subleafs[indexLeaf]) delete this->subleafs[indexLeaf];
        }
        delete [] this->subleafs;
    }

524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563

    template<typename... Args>
    void insert(const MortonIndex index, const FTreeCoordinate& host, const int inTreeHeight, const FPoint& inParticlePosition,
                        Args... args){
        // We need the morton index at the bottom level of this sub octree
        // so we remove the right side
        const MortonIndex arrayIndex = Parent::getLeafIndex(index,inTreeHeight);
        // Is there already a leaf?
        if( !this->subleafs[arrayIndex] ){
            // We need to create leaf sub octree
            const int nextSubOctreePosition = this->subOctreePosition + this->subOctreeHeight;
            const int nextSubOctreeHeight = FMath::Min(inTreeHeight - nextSubOctreePosition, this->subOctreeHeight);

            // Next suboctree is a middle suboctree
            if(inTreeHeight > nextSubOctreeHeight + nextSubOctreePosition){
                this->subleafs[arrayIndex] = new FSubOctree(this,int(arrayIndex),nextSubOctreeHeight,nextSubOctreePosition);
            }
            // Or next suboctree contains the reail leaf!
            else{
                this->subleafs[arrayIndex] = new SubOctreeWithLeaf(this,int(arrayIndex),nextSubOctreeHeight,nextSubOctreePosition);
            }

            const FTreeCoordinate hostAtLevel(
                        host.getX() >> (inTreeHeight - nextSubOctreePosition ),
                        host.getY() >> (inTreeHeight - nextSubOctreePosition ),
                        host.getZ() >> (inTreeHeight - nextSubOctreePosition ));

            // We need to inform parent class
            Parent::newLeafInserted( int(arrayIndex), index >> (3 * (inTreeHeight-nextSubOctreePosition) ), hostAtLevel);
        }
        // Ask next suboctree to insert the particle
        if(this->subleafs[arrayIndex]->isLeafPart()){
            ((SubOctreeWithLeaf*)this->subleafs[arrayIndex])->insert( index, host, inTreeHeight, inParticlePosition, args... );
        }
        else{
            ((FSubOctree*)this->subleafs[arrayIndex])->insert( index, host, inTreeHeight, inParticlePosition, args... );
        }
    }

    LeafClass* createLeaf(const MortonIndex index, const FTreeCoordinate& host, const int inTreeHeight){
564
565
        // We need the morton index at the bottom level of this sub octree
        // so we remove the right side
berenger-bramas's avatar
berenger-bramas committed
566
        const MortonIndex arrayIndex = Parent::getLeafIndex(index,inTreeHeight);
567
568
569
570
571
572
573
574
        // Is there already a leaf?
        if( !this->subleafs[arrayIndex] ){
            // We need to create leaf sub octree
            const int nextSubOctreePosition = this->subOctreePosition + this->subOctreeHeight;
            const int nextSubOctreeHeight = FMath::Min(inTreeHeight - nextSubOctreePosition, this->subOctreeHeight);

            // Next suboctree is a middle suboctree
            if(inTreeHeight > nextSubOctreeHeight + nextSubOctreePosition){
575
                this->subleafs[arrayIndex] = new FSubOctree(this,int(arrayIndex),nextSubOctreeHeight,nextSubOctreePosition);
576
577
578
            }
            // Or next suboctree contains the reail leaf!
            else{
579
                this->subleafs[arrayIndex] = new SubOctreeWithLeaf(this,int(arrayIndex),nextSubOctreeHeight,nextSubOctreePosition);
580
581
            }

582
583
584
585
586
            const FTreeCoordinate hostAtLevel(
                        host.getX() >> (inTreeHeight - nextSubOctreePosition ),
                        host.getY() >> (inTreeHeight - nextSubOctreePosition ),
                        host.getZ() >> (inTreeHeight - nextSubOctreePosition ));

587
            // We need to inform parent class
berenger-bramas's avatar
berenger-bramas committed
588
            Parent::newLeafInserted( int(arrayIndex), index >> (3 * (inTreeHeight-nextSubOctreePosition) ), hostAtLevel);
589
590
        }
        // Ask next suboctree to insert the particle
591
592
593
594
595
596
        if(this->subleafs[arrayIndex]->isLeafPart()){
            return ((SubOctreeWithLeaf*)this->subleafs[arrayIndex])->createLeaf( index, host, inTreeHeight );
        }
        else{
            return ((FSubOctree*)this->subleafs[arrayIndex])->createLeaf( index, host, inTreeHeight );
        }
597
598
    }

599
600
601
602
603
    /**
      * Remove a leaf and every cells if needed
      */
    bool removeLeaf(const MortonIndex index, const int inTreeHeight) {
        // Get the morton index for the leaf level
berenger-bramas's avatar
berenger-bramas committed
604
        const MortonIndex arrayIndex = Parent::getLeafIndex(index,inTreeHeight);
605
606
607
608
609
        if( this->subleafs[arrayIndex]->removeLeaf(index, inTreeHeight) ){
            // remove container
            delete this->subleafs[arrayIndex];
            this->subleafs[arrayIndex] = 0;

berenger-bramas's avatar
berenger-bramas committed
610
            return Parent::removeCellsFromLeaf( int(arrayIndex) );
611
612
613
614
        }
        return false;
    }

615
616
617
    /** To get access to leafs elements (child suboctree)
      * @param index the position of the leaf/child suboctree
      * @return child at this index */
618
    FAbstractSubOctree<CellClass,ContainerClass,LeafClass>* leafs(const int index) {
619
620
621
622
623
624
        return this->subleafs[index];
    }

    /** To get access to leafs elements (child suboctree)
      * @param index the position of the leaf/child suboctree
      * @return child at this index */
625
    const FAbstractSubOctree<CellClass,ContainerClass,LeafClass>* leafs(const int index) const {
626
627
628
629
630
631
        return this->subleafs[index];
    }
};


#endif //FSUBOCTREE_HPP
632