/home/brandes/workspace/LAMA/src/lama/distribution/CyclicDistribution.hpp

Go to the documentation of this file.

#ifndef LAMA_CYCLIC_DISTRIBUTION_HPP_
#define LAMA_CYCLIC_DISTRIBUTION_HPP_

// for dll_import
#include <lama/config.hpp>

// base classes
#include <lama/distribution/Distribution.hpp>

namespace lama
{

class LAMA_DLL_IMPORTEXPORT CyclicDistribution: public Distribution
{
public:

    CyclicDistribution(const IndexType globalSize, const IndexType chunkSize,
                      const CommunicatorPtr communicator);

    virtual ~CyclicDistribution();

    virtual bool isLocal(const IndexType index) const;

    virtual PartitionId getOwner( const IndexType globalIndex ) const;

    virtual IndexType getLocalSize() const;

    inline IndexType chunkSize() const;

    IndexType getNumLocalChunks() const;

    IndexType getNumChunks( const PartitionId partition) const;

    IndexType getNumTotalChunks() const;

    IndexType getPartitionSize( const PartitionId partition) const;

    virtual IndexType local2global(const IndexType localIndex) const;

    virtual IndexType global2local(const IndexType globalIndex) const;

    virtual bool isEqual(const Distribution& other) const;

    virtual void writeAt(std::ostream& stream) const;

    virtual void computeOwners(
        const std::vector<IndexType>& requiredIndexes,
        std::vector<PartitionId>& owners) const;

    void printDistributionVector( std::string problem ) const;

private:

    CyclicDistribution(); // disable default constructor as it has no global size

    IndexType allGlobal2local(const IndexType globalIndex) const;

    void getChunkInfo( IndexType& localChunks, IndexType& extra, const PartitionId rank) const;

    IndexType mChunkSize; // chunk size of each partition

    LAMA_LOG_DECL_STATIC_LOGGER( logger );
};

IndexType CyclicDistribution::chunkSize() const
{
    return mChunkSize;
}

}

#endif // LAMA_CYCLIC_DISTRIBUTION_HPP_