parmetis_partitioner.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_PARMETIS_PARTITIONER_H
#define LIBMESH_PARMETIS_PARTITIONER_H

// Local Includes
#include "libmesh/id_types.h"
#include "libmesh/partitioner.h"

// C++ Includes
#include <cstddef>
#include <memory>
#include <unordered_map>
#include <vector>

namespace libMesh
{

// Forward declarations
class ParmetisHelper;

class ParmetisPartitioner : public Partitioner
{
public:

  ParmetisPartitioner ();
  ParmetisPartitioner (const ParmetisPartitioner & other);

  ParmetisPartitioner & operator= (const ParmetisPartitioner &) = delete;

  ParmetisPartitioner (ParmetisPartitioner &&) = default;
  ParmetisPartitioner & operator= (ParmetisPartitioner &&) = default;

  virtual ~ParmetisPartitioner();

  virtual PartitionerType type () const override;

  virtual std::unique_ptr<Partitioner> clone () const override
  {
    return std::make_unique<ParmetisPartitioner>(*this);
  }


protected:

  virtual void _do_repartition (MeshBase & mesh,
                                const unsigned int n) override;

  virtual void _do_partition (MeshBase & mesh,
                              const unsigned int n) override;

#ifdef LIBMESH_HAVE_PARMETIS

  virtual void build_graph (const MeshBase & mesh) override;

private:

  // These methods and data only need to be available if the
  // ParMETIS library is available.

  void initialize (const MeshBase & mesh, const unsigned int n_sbdmns);

  std::unique_ptr<ParmetisHelper> _pmetis;

#endif
};

} // namespace libMesh

#endif // LIBMESH_PARMETIS_PARTITIONER_H