Partitioner.h

/*
 * (C) Copyright 2013 ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation
 * nor does it submit to any jurisdiction.
 */

#pragma once

#include <string>


#include "atlas/library/config.h"
#include "atlas/util/ObjectHandle.h"

namespace eckit {
class Parametrisation;
}

namespace atlas {
class Grid;
class Mesh;
class FunctionSpace;
namespace grid {
class Distribution;
class DistributionImpl;

namespace detail {
namespace partitioner {
class Partitioner;
}  // namespace partitioner
}  // namespace detail
}  // namespace grid
}  // namespace atlas

namespace atlas {
namespace mesh {
namespace detail {
class MeshImpl;
}
}  // namespace mesh
}  // namespace atlas

namespace atlas {
namespace functionspace {
class FunctionSpaceImpl;
}  // namespace functionspace
}  // namespace atlas

namespace atlas {
namespace grid {
namespace detail {
namespace grid {
class Grid;
}  // namespace grid
}  // namespace detail
}  // namespace grid
}  // namespace atlas

namespace atlas {
namespace grid {

// ------------------------------------------------------------------

class Partitioner : DOXYGEN_HIDE( public util::ObjectHandle<detail::partitioner::Partitioner> ) {
public:
    using Config         = eckit::Parametrisation;
    using Implementation = detail::partitioner::Partitioner;

public:
    static bool exists( const std::string& type );

public:
    using Handle::Handle;
    Partitioner() = default;
    Partitioner( const std::string& type );
    Partitioner( const std::string& type, const idx_t nb_partitions );
    Partitioner( const Config& );
    Partitioner( const std::string& type, const Config& );

    void partition( const Grid& grid, int part[] ) const;

    Distribution partition( const Grid& grid ) const;

    idx_t nb_partitions() const;

    std::string type() const;
};

// ------------------------------------------------------------------

class MatchingPartitioner : public Partitioner {
public:
    using Config = eckit::Parametrisation;

public:
    static bool exists( const std::string& type );

public:
    MatchingPartitioner();
    MatchingPartitioner( const Mesh& );
    MatchingPartitioner( const Mesh&, const Config& );
    MatchingPartitioner( const FunctionSpace& );
    MatchingPartitioner( const FunctionSpace&, const Config& );
};

// ------------------------------------------------------------------

class MatchingMeshPartitioner : public MatchingPartitioner {
public:
    using MatchingPartitioner::MatchingPartitioner;
};

// ------------------------------------------------------------------

#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GridImpl = detail::grid::Grid;

extern "C" {
Partitioner::Implementation* atlas__grid__Partitioner__new( const Partitioner::Config* config );

Partitioner::Implementation* atlas__grid__Partitioner__new_type( const char* type );

Partitioner::Implementation* atlas__grid__MatchingMeshPartitioner__new( const mesh::detail::MeshImpl* mesh,
                                                                        const Partitioner::Config* config );
Partitioner::Implementation* atlas__grid__MatchingFunctionSpacePartitioner__new(
    const functionspace::FunctionSpaceImpl* functionspace, const Partitioner::Config* config );
void atlas__grid__Partitioner__delete( Partitioner::Implementation* This );
DistributionImpl* atlas__grid__Partitioner__partition( const Partitioner::Implementation* This, const GridImpl* grid );
}
#endif

}  // namespace grid
}  // namespace atlas