Zoltan2_PartitionMapping.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Karen Devine      (kddevin@sandia.gov)
//                    Erik Boman        (egboman@sandia.gov)
//                    Siva Rajamanickam (srajama@sandia.gov)
//
// ***********************************************************************
//
// @HEADER

#ifndef _ZOLTAN2_PARTITIONMAPPING_HPP_
#define _ZOLTAN2_PARTITIONMAPPING_HPP_
#include "Zoltan2_Model.hpp"
#include "Zoltan2_PartitioningSolution.hpp"
#include "Teuchos_Comm.hpp"
#include "Zoltan2_Environment.hpp"
#include "Zoltan2_MachineRepresentation.hpp"
#include "Zoltan2_Algorithm.hpp"

namespace Zoltan2 {

template <typename Adapter>
  class PartitionMapping :public Algorithm<Adapter>
{
public:

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef typename Adapter::gno_t gno_t;
  typedef typename Adapter::scalar_t scalar_t;
  typedef typename Adapter::scalar_t pcoord_t;
  typedef typename Adapter::lno_t lno_t;
  typedef typename Adapter::part_t part_t;
  typedef typename Adapter::user_t user_t;
#endif

  const Teuchos::RCP <const Teuchos::Comm<int> >comm;
  const Teuchos::RCP <const Zoltan2::MachineRepresentation <pcoord_t,part_t> > machine;
  const Teuchos::RCP <const Adapter > input_adapter;
  const Teuchos::RCP <const Zoltan2::PartitioningSolution<Adapter> >soln;
  const Teuchos::RCP <const Environment >env;
  const part_t num_parts;
  const part_t *solution_parts;


  PartitionMapping(
      const Teuchos::RCP <const Teuchos::Comm<int> >comm_,
      const Teuchos::RCP <const Zoltan2::MachineRepresentation<pcoord_t,part_t> >machine_, // If NULL, assume homogeneous
                                                    // Make optional
      const Teuchos::RCP <const Adapter> input_adapter_, // Needed to get information about
                                           // the application data (coords, graph)
      const Teuchos::RCP <const Zoltan2::PartitioningSolution<Adapter> >soln_, // Needed for mapping a partition
      const Teuchos::RCP <const Environment > envConst_  // Perhaps envConst should be optional
                                           // so applications can create a mapping
                                           // directly
    ):comm(comm_),
      machine(machine_),
      input_adapter(input_adapter_),
      soln(soln_),
      env(envConst_),num_parts(soln_->getActualGlobalNumberOfParts()),
      solution_parts(soln_->getPartListView())
          {} ;

  PartitionMapping(
      const Teuchos::RCP <const Teuchos::Comm<int> >comm_,
      const Teuchos::RCP <const Zoltan2::MachineRepresentation<pcoord_t,part_t> >machine_, // If NULL, assume homogeneous
                                                    // Make optional
      const Teuchos::RCP <const Adapter> input_adapter_, // Needed to get information about
                                           // the application data (coords, graph)
      const part_t num_parts_,
      const part_t *result_parts,
      const Teuchos::RCP <const Environment > envConst_  // Perhaps envConst should be optional
                                           // so applications can create a mapping
                                           // directly
    ):comm(comm_),
      machine(machine_),
      input_adapter(input_adapter_),
      soln(),
      env(envConst_),num_parts(num_parts_),
      solution_parts(result_parts)
          {} ;

  PartitionMapping(
      const Teuchos::RCP <const Teuchos::Comm<int> >comm_,
      const Teuchos::RCP <const Environment > envConst_  // Perhaps envConst should be optional
                                           // so applications can create a mapping
                                           // directly
    ):comm(comm_),
      machine(),
      input_adapter(),
      soln(),
      env(envConst_),num_parts(0),
      solution_parts(NULL)
          {} ;

  PartitionMapping():
          comm(0),
          machine(0),
          input_adapter(0),
          soln(0),
          env(0),
          solution_parts(NULL){};

  PartitionMapping(const Teuchos::RCP <const Environment >envConst_):
          comm(0),
          machine(0),
          input_adapter(0),
          soln(0),
          env(envConst_),num_parts(0),
          solution_parts(NULL){};

  PartitionMapping(
      const Teuchos::RCP <const Environment > envConst_,
      const Teuchos::RCP <const Teuchos::Comm<int> >comm_,
      const Teuchos::RCP <const MachineRepresentation<pcoord_t,part_t> >machine_
      ):
          comm(comm_),
          machine(machine_),
          input_adapter(0),
          soln(0),
          env(envConst_),num_parts(0),
          solution_parts(NULL){};


  virtual ~PartitionMapping(){}

  virtual size_t getLocalNumberOfParts() const = 0;

  // TODO:  KDDKDD Decide whether information should be avail for any process
  // TODO:  KDDKDD (requiring more storage or a directory) or only for the 
  // TODO:  KDDKDD local process.
  // TODO:  KDDKDD Could require O(nprocs) storage
  virtual void getPartsForProc(int procId, part_t &numParts, part_t *&parts)
    const = 0;

  // TODO:  KDDKDD Arguments should be count and array, not min and max.
  // TODO:  KDDKDD Could require O(nGlobalParts) storage
  virtual void getProcsForPart(part_t partId, part_t &numProcs, part_t *&procs) const = 0;

private:
};

}  // namespace Zoltan2

#endif