partitioner.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 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_PARTITIONER_H
#define LIBMESH_PARTITIONER_H

// Local Includes -----------------------------------
#include "libmesh/libmesh.h"
#include "libmesh/auto_ptr.h"
#include "libmesh/id_types.h"

// C++ Includes   -----------------------------------
#include <cstddef>

namespace libMesh
{

// Forward Declarations
class MeshBase;
class ErrorVector;


// ------------------------------------------------------------
// Partitioner class definition
class Partitioner
{
public:

  Partitioner ():_weights(NULL) {}

  virtual ~Partitioner() {}

  virtual UniquePtr<Partitioner> clone () const = 0;


  void partition (MeshBase& mesh,
                  const unsigned int n);

  void partition (MeshBase& mesh);

  void repartition (MeshBase& mesh,
                    const unsigned int n);

  void repartition (MeshBase& mesh);

  static void partition_unpartitioned_elements (MeshBase &mesh);

  static void partition_unpartitioned_elements (MeshBase &mesh,
                                                const unsigned int n);

  static void set_parent_processor_ids(MeshBase& mesh);

  static void set_node_processor_ids(MeshBase& mesh);

  virtual void attach_weights(ErrorVector * /*weights*/) { libmesh_not_implemented(); }

protected:

  void single_partition (MeshBase& mesh);

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

  virtual void _do_repartition (MeshBase& mesh,
                                const unsigned int n) { this->_do_partition (mesh, n); }

  static const dof_id_type communication_blocksize;

  ErrorVector * _weights;
};


} // namespace libMesh



#endif // LIBMESH_PARTITIONER_H