multiBlockManagement2D.h

Go to the documentation of this file.

/* This file is part of the Palabos library.
 *
 * Copyright (C) 2011 FlowKit Sarl
 * Avenue de Chailly 23
 * 1012 Lausanne, Switzerland
 * E-mail contact: contact@flowkit.com
 *
 * The most recent release of Palabos can be downloaded at 
 * <http://www.palabos.org/>
 *
 * The library Palabos is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * The library 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef MULTI_BLOCK_MANAGEMENT_2D_H
#define MULTI_BLOCK_MANAGEMENT_2D_H

#include "core/globalDefs.h"
#include "core/geometry2D.h"
#include "multiBlock/threadAttribution.h"
#include "multiBlock/sparseBlockStructure2D.h"
#include "multiBlock/localMultiBlockInfo2D.h"
#include <vector>


namespace plb {

class MultiBlockManagement2D {
public:
    MultiBlockManagement2D( SparseBlockStructure2D const& sparseBlock_,
                            ThreadAttribution* threadAttribution_,
                            plint envelopeWidth_,
                            plint refinementLevel_ =0 );
    MultiBlockManagement2D(MultiBlockManagement2D const& rhs);
    MultiBlockManagement2D& operator=(MultiBlockManagement2D const& rhs);
    void swap(MultiBlockManagement2D& rhs);
    ~MultiBlockManagement2D();
    plint getEnvelopeWidth() const;
    Box2D getBoundingBox() const;
    Box2D getBulk(plint blockId) const;
    Box2D getUniqueBulk(plint blockId) const;
    Box2D getEnvelope(plint blockId) const;
    SparseBlockStructure2D const& getSparseBlockStructure() const;
    LocalMultiBlockInfo2D const& getLocalInfo() const;
    ThreadAttribution const& getThreadAttribution() const;
    bool findInLocalBulk (
            plint iX, plint iY, plint& foundId,
            plint& localX, plint& localY ) const;
    bool findAllLocalRepresentations (
            plint iX, plint iY, std::vector<plint>& foundId,
            std::vector<plint>& foundX, std::vector<plint>& foundY ) const;
    plint getRefinementLevel() const;
    void setRefinementLevel(plint newLevel);
private:
    plint                  envelopeWidth;
    SparseBlockStructure2D sparseBlock;
    ThreadAttribution*     threadAttribution;
    LocalMultiBlockInfo2D  localInfo;
    plint                  refinementLevel;
};


MultiBlockManagement2D intersect (
        MultiBlockManagement2D const& originalManagement,
        Box2D subDomain, bool crop );

MultiBlockManagement2D intersect (
        MultiBlockManagement2D const& originalManagement,
        Box2D subDomain, Box2D newBoundingBox );


MultiBlockManagement2D intersect( MultiBlockManagement2D const& management1,
                                  MultiBlockManagement2D const& management2, bool crop );


MultiBlockManagement2D extend( MultiBlockManagement2D const& management,
                               Box2D addedBulk, Box2D addedUniqueBulk );

MultiBlockManagement2D except( MultiBlockManagement2D const& management,
                               Box2D exceptedBlock );


MultiBlockManagement2D block_union( MultiBlockManagement2D const& management1,
                                    MultiBlockManagement2D const& management2 );

MultiBlockManagement2D align( MultiBlockManagement2D const& originalManagement,
                              MultiBlockManagement2D const& partnerManagement );


MultiBlockManagement2D reparallelize(MultiBlockManagement2D const& management,
                                     plint blockLx, plint blockLy);

class SmartBulk2D {
public:
    SmartBulk2D( MultiBlockManagement2D const& management,
                 plint blockId );
    SmartBulk2D( SparseBlockStructure2D const& sparseBlock_,
                 plint envelopeWidth_, plint blockId );
    SmartBulk2D( SparseBlockStructure2D const& sparseBlock_,
                 plint envelopeWidth_, Box2D const& bulk_ );
    Box2D getBulk() const;
    Box2D computeEnvelope() const;
    Box2D computeNonPeriodicEnvelope() const;
    Box2D toLocal(Box2D const& coord) const;
    plint toLocalX(plint iX) const;
    plint toLocalY(plint iY) const;
private:
    SparseBlockStructure2D const& sparseBlock;
    plint envelopeWidth;
    Box2D bulk;
};

}  // namespace plb

#endif  // MULTI_BLOCK_MANAGEMENT_2D_H