defaultMultiBlockPolicy3D.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 DEFAULT_MULTI_BLOCK_POLICY_3D_H
#define DEFAULT_MULTI_BLOCK_POLICY_3D_H

#include "core/globalDefs.h"
#include "parallelism/mpiManager.h"
#include "multiBlock/serialBlockCommunicator3D.h"
#include "parallelism/parallelBlockCommunicator3D.h"
#include "multiBlock/combinedStatistics.h"
#include "parallelism/parallelStatistics.h"
#include "multiBlock/serialMultiBlockLattice3D.h"
#include "parallelism/parallelMultiBlockLattice3D.h"
#include "multiBlock/serialMultiDataField3D.h"
#include "parallelism/parallelMultiDataField3D.h"
#include "multiBlock/threadAttribution.h"
#include "multiBlock/staticRepartitions3D.h"
#include "multiBlock/multiBlockManagement3D.h"
#include <cmath>

namespace plb {

class DefaultMultiBlockPolicy3D {
public:
    void toggleBlockingCommunication(bool useBlockingCommunication_) {
        useBlockingCommunication = useBlockingCommunication_;
    }

    BlockCommunicator3D* getBlockCommunicator() {
#ifdef PLB_MPI_PARALLEL
        if (useBlockingCommunication) {
            return new ParallelBlockCommunicator3D();
        }
        else {
            return new ParallelBlockCommunicator3D();
        }
#else
        return new SerialBlockCommunicator3D();
#endif
    }

    CombinedStatistics* getCombinedStatistics() {
#ifdef PLB_MPI_PARALLEL
        return new ParallelCombinedStatistics();
#else
        return new SerialCombinedStatistics();
#endif
    }

    template<typename T, template<typename U> class Descriptor>
    MultiCellAccess3D<T,Descriptor>* getMultiCellAccess() {
#ifdef PLB_MPI_PARALLEL
        return new ParallelCellAccess3D<T,Descriptor>();
#else
        return new SerialCellAccess3D<T,Descriptor>();
#endif
    }

    template<typename T>
    MultiScalarAccess3D<T>* getMultiScalarAccess() {
#ifdef PLB_MPI_PARALLEL
        return new ParallelScalarAccess3D<T>();
#else
        return new SerialScalarAccess3D<T>();
#endif
    }

    template<typename T, int nDim>
    MultiTensorAccess3D<T,nDim>* getMultiTensorAccess() {
#ifdef PLB_MPI_PARALLEL
        return new ParallelTensorAccess3D<T,nDim>();
#else
        return new SerialTensorAccess3D<T,nDim>();
#endif
    }

    template<typename T>
    MultiNTensorAccess3D<T>* getMultiNTensorAccess() {
#ifdef PLB_MPI_PARALLEL
        return new ParallelNTensorAccess3D<T>();
#else
        return new SerialNTensorAccess3D<T>();
#endif
    }

    ThreadAttribution* getThreadAttribution() {
#ifdef PLB_MPI_PARALLEL
        return new OneToOneThreadAttribution();
#else
        return new SerialThreadAttribution();
#endif
    }

    MultiBlockManagement3D getMultiBlockManagement(Box3D const& domain, plint envelopeWidth) {
        return MultiBlockManagement3D (
                createRegularDistribution3D(domain, numProcesses),
                getThreadAttribution(),
                envelopeWidth );
    }

    MultiBlockManagement3D getMultiBlockManagement(plint nx, plint ny, plint nz, plint envelopeWidth) {
        return MultiBlockManagement3D (
                createRegularDistribution3D(nx,ny,nz, numProcesses),
                getThreadAttribution(),
                envelopeWidth );
    }

    void setNumGridPoints(plint numGridPoints_) {
        numGridPoints = numGridPoints_;
        numGridPointsSpecified = true;
    }

    plint getNumGridPoints() const {
        return numGridPoints;
    }

    void setNumProcesses(int numProcesses_) {
        numProcesses = numProcesses_;
        if (!numGridPointsSpecified) {
            numGridPoints = numProcesses;
        }
    }

    int getNumProcesses() const {
        return numProcesses;
    }
private:
    DefaultMultiBlockPolicy3D()
        : numProcesses(global::mpi().getSize()),
          numGridPointsSpecified(false),
          useBlockingCommunication(false)
    {
        numGridPoints = numProcesses;
    }
    friend DefaultMultiBlockPolicy3D& defaultMultiBlockPolicy3D();
private:
    int numProcesses;
    plint numGridPoints;
    bool numGridPointsSpecified;
    bool useBlockingCommunication;
};

inline DefaultMultiBlockPolicy3D& defaultMultiBlockPolicy3D() {
    static DefaultMultiBlockPolicy3D singleton;
    return singleton;
}

}  // namespace plb

#endif  //DEFAULT_MULTI_BLOCK_POLICY_3D_H