multiBlockManagement3D.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_3D_H
#define MULTI_BLOCK_MANAGEMENT_3D_H

#include "core/globalDefs.h"
#include "core/geometry3D.h"
#include "multiBlock/threadAttribution.h"
#include "multiBlock/sparseBlockStructure3D.h"
#include "multiBlock/localMultiBlockInfo3D.h"
#include "multiGrid/multiScale.h"
#include <vector>


namespace plb {

class MultiBlockManagement3D {
public:
    MultiBlockManagement3D( SparseBlockStructure3D const& sparseBlock_,
                            ThreadAttribution* threadAttribution_,
                            plint envelopeWidth_,
                            plint refinementLevel_ =0 );
    MultiBlockManagement3D(MultiBlockManagement3D const& rhs);
    MultiBlockManagement3D& operator=(MultiBlockManagement3D const& rhs);
    void swap(MultiBlockManagement3D& rhs);
    ~MultiBlockManagement3D();
    plint getEnvelopeWidth() const;
    Box3D getBoundingBox() const;
    Box3D getBulk(plint blockId) const;
    Box3D getUniqueBulk(plint blockId) const;
    Box3D getEnvelope(plint blockId) const;
    SparseBlockStructure3D const& getSparseBlockStructure() const;
    LocalMultiBlockInfo3D const& getLocalInfo() const;
    ThreadAttribution const& getThreadAttribution() const;
    void setCoProcessors(std::map<plint,int> const& coProcessors);
    bool findInLocalBulk (
            plint iX, plint iY, plint iZ, plint& foundId,
            plint& localX, plint& localY, plint& localZ ) const;
    bool findAllLocalRepresentations (
            plint iX, plint iY, plint iZ, std::vector<plint>& foundId,
            std::vector<plint>& foundX, std::vector<plint>& foundY,
            std::vector<plint>& foundZ ) const;
    plint getRefinementLevel() const;
    void setRefinementLevel(plint newLevel);
private:
    plint                  envelopeWidth;
    SparseBlockStructure3D sparseBlock;
    ThreadAttribution*     threadAttribution;
    LocalMultiBlockInfo3D  localInfo;
    plint                  refinementLevel;
};

MultiBlockManagement3D scale(MultiBlockManagement3D const& originalManagement, plint relativeLevel);


MultiBlockManagement3D intersect (
        MultiBlockManagement3D const& originalManagement,
        Box3D subDomain, bool crop );

MultiBlockManagement3D intersect (
        MultiBlockManagement3D const& originalManagement,
        Box3D subDomain, Box3D newBoundingBox );


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


MultiBlockManagement3D extend( MultiBlockManagement3D const& management,
                               Box3D addedBulk, Box3D addedUniqueBulk );

MultiBlockManagement3D except( MultiBlockManagement3D const& management,
                               Box3D exceptedBlock );


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

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


MultiBlockManagement3D reparallelize(MultiBlockManagement3D const& management,
                                     plint blockLx, plint blockLy, plint blockLz);


class SmartBulk3D {
public:
    SmartBulk3D( MultiBlockManagement3D const& management,
                 plint blockId );
    SmartBulk3D( SparseBlockStructure3D const& sparseBlock_,
                 plint envelopeWidth_, plint blockId );
    SmartBulk3D( SparseBlockStructure3D const& sparseBlock_,
                 plint envelopeWidth_, Box3D const& bulk_ );
    Box3D getBulk() const;
    Box3D computeEnvelope() const;
    Box3D computeNonPeriodicEnvelope() const;
    Box3D toLocal(Box3D const& coord) const;
    plint toLocalX(plint iX) const;
    plint toLocalY(plint iY) const;
    plint toLocalZ(plint iZ) const;
private:
    SparseBlockStructure3D const& sparseBlock;
    plint envelopeWidth;
    Box3D bulk;
};

}  // namespace plb

#endif  // MULTI_BLOCK_MANAGEMENT_3D_H