ConfigurablePartitioner.h

#ifndef sensei_ConfigurablePartitioner_h
#define sensei_ConfigurablePartitioner_h

#include "Partitioner.h"

namespace pugi { class xml_node; }

namespace sensei
{

class ConfigurablePartitioner;
using ConfigurablePartitionerPtr = std::shared_ptr<sensei::ConfigurablePartitioner>;

/** An object the selects and configures a sensei::Partitioner from XML.
 * API calls are forwarded to the active intance at run time.
 */
class SENSEI_EXPORT ConfigurablePartitioner : public Partitioner
{
public:
  ~ConfigurablePartitioner();

  static sensei::ConfigurablePartitionerPtr New()
  { return ConfigurablePartitionerPtr(new ConfigurablePartitioner); }

  const char *GetClassName() override { return "ConfigurablePartitioner"; }

  /** given an existing partitioning of data passed in the first MeshMetadata
   * argument,return a new partitioning in the second MeshMetadata argument.
   */
  int GetPartition(MPI_Comm comm, const sensei::MeshMetadataPtr &in,
    sensei::MeshMetadataPtr &out) override;

  /** initialize the partitioner from the XML node.  recognizes the following
   * Partitioner's: block, cyclic, planar, and mapped. The XML schema is as
   * follows:
   *
   * ```xml
   * <partitioner type="..." ... >
   *   ...
   * </partitioner>
   * ```
   *
   * where type is one of block, cyclic, planar, or mapped. See sensei::Parititioner
   * sub-classes for documentation on the specific XML recognized by each.
   */
  virtual int Initialize(pugi::xml_node &) override;

protected:
  ConfigurablePartitioner();

private:
  struct InternalsType;
  InternalsType *Internals;
};

}

#endif