Zoltan2::MappingProblem< Adapter, MachineRep > Class Template Reference

MappingProblem enables mapping of a partition (either computed or input) to MPI ranks. More...

#include <Zoltan2_MappingProblem.hpp>

Inheritance diagram for Zoltan2::MappingProblem< Adapter, MachineRep >:

Collaboration diagram for Zoltan2::MappingProblem< Adapter, MachineRep >:

Public Types
typedef Adapter::scalar_t	scalar_t
typedef Adapter::gno_t	gno_t
typedef Adapter::lno_t	lno_t
typedef Adapter::user_t	user_t
typedef Adapter::part_t	part_t
typedef Adapter::base_adapter_t	base_adapter_t
typedef PartitioningSolution < Adapter >	partsoln_t
typedef MappingSolution< Adapter >	mapsoln_t

Public Member Functions
virtual	~MappingProblem ()
	Destructor. More...
	MappingProblem (Adapter *A_, Teuchos::ParameterList *p_, const Teuchos::RCP< const Teuchos::Comm< int > > &ucomm_, partsoln_t *partition_=NULL, MachineRep *machine_=NULL)
	Constructor that takes an Teuchos communicator. More...
void	solve (bool updateInputData=true)
	Direct the problem to create a solution. More...
mapsoln_t *	getSolution ()
	Get the solution to the problem. More...
Teuchos::RCP< MachineRep >	getMachine ()
Public Member Functions inherited from Zoltan2::Problem< Adapter >
	Problem (const Adapter *input, ParameterList *params, const RCP< const Comm< int > > &comm)
	Constructor where Teuchos communicator is specified. More...
virtual	~Problem ()
	Destructor. More...
RCP< const Comm< int > >	getComm ()
	Return the communicator used by the problem. More...
void	resetParameters (ParameterList *params)
	Reset the list of parameters. More...
void	printTimers () const
	Return the communicator passed to the problem. More...
const RCP< const Environment > &	getEnvironment () const
	Get the current Environment. Useful for testing. More...
Public Member Functions inherited from Zoltan2::ProblemRoot
virtual	~ProblemRoot ()

Static Public Member Functions
static void	getValidParameters (ParameterList &pl)
	Set up validators specific to this Problem. More...
Static Public Member Functions inherited from Zoltan2::Problem< Adapter >
static void	getValidParameters (ParameterList &pl)

Additional Inherited Members
Protected Types inherited from Zoltan2::Problem< Adapter >
typedef Adapter::base_adapter_t	base_adapter_t
Protected Attributes inherited from Zoltan2::Problem< Adapter >
RCP< const Adapter >	inputAdapter_
RCP< const base_adapter_t >	baseInputAdapter_
RCP< Algorithm< Adapter > >	algorithm_
RCP< ParameterList >	params_
RCP< const Comm< int > >	comm_
RCP< Environment >	env_
RCP< const Environment >	envConst_
RCP< TimerManager >	timer_

Detailed Description

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>
class Zoltan2::MappingProblem< Adapter, MachineRep >

MappingProblem enables mapping of a partition (either computed or input) to MPI ranks.

The MappingProblem is the core of the Zoltan2 mappin API. Based on the the user's input and parameters, the MappingProblem sets up a computational Model, and a Solution object. When the user calls the solve() method, the MappingProblem runs the algorithm, after which the Solution object may be obtained by the user.

The template parameter is the InputAdapter containing the data that is to be partitioned.

Definition at line 85 of file Zoltan2_MappingProblem.hpp.

Member Typedef Documentation

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef Adapter::scalar_t Zoltan2::MappingProblem< Adapter, MachineRep >::scalar_t

Definition at line 89 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef Adapter::gno_t Zoltan2::MappingProblem< Adapter, MachineRep >::gno_t

Definition at line 90 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef Adapter::lno_t Zoltan2::MappingProblem< Adapter, MachineRep >::lno_t

Definition at line 91 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef Adapter::user_t Zoltan2::MappingProblem< Adapter, MachineRep >::user_t

Definition at line 92 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef Adapter::part_t Zoltan2::MappingProblem< Adapter, MachineRep >::part_t

Definition at line 93 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef Adapter::base_adapter_t Zoltan2::MappingProblem< Adapter, MachineRep >::base_adapter_t

Definition at line 94 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef PartitioningSolution<Adapter> Zoltan2::MappingProblem< Adapter, MachineRep >::partsoln_t

Definition at line 96 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

typedef MappingSolution<Adapter> Zoltan2::MappingProblem< Adapter, MachineRep >::mapsoln_t

Definition at line 97 of file Zoltan2_MappingProblem.hpp.

Constructor & Destructor Documentation

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

virtual Zoltan2::MappingProblem< Adapter, MachineRep >::~MappingProblem ( )

inlinevirtual

Destructor.

Definition at line 101 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

Zoltan2::MappingProblem< Adapter, MachineRep >::MappingProblem ( Adapter *  A_, Teuchos::ParameterList *  p_, const Teuchos::RCP< const Teuchos::Comm< int > > &  ucomm_, partsoln_t *  partition_ = NULL, MachineRep *  machine_ = NULL  )

inline

Constructor that takes an Teuchos communicator.

Definition at line 105 of file Zoltan2_MappingProblem.hpp.

Member Function Documentation

template<typename Adapter , typename MachineRep >

void Zoltan2::MappingProblem< Adapter, MachineRep >::solve ( bool  updateInputData = true )

virtual

Direct the problem to create a solution.

Implements Zoltan2::ProblemRoot.

Definition at line 258 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

static void Zoltan2::MappingProblem< Adapter, MachineRep >::getValidParameters ( ParameterList &  pl )

inlinestatic

Set up validators specific to this Problem.

Definition at line 151 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

mapsoln_t* Zoltan2::MappingProblem< Adapter, MachineRep >::getSolution ( )

inline

Get the solution to the problem.

Definition at line 188 of file Zoltan2_MappingProblem.hpp.

template<typename Adapter, typename MachineRep = MachineRepresentation<typename Adapter::scalar_t, typename Adapter::part_t>>

Teuchos::RCP<MachineRep> Zoltan2::MappingProblem< Adapter, MachineRep >::getMachine ( )

inline

Definition at line 189 of file Zoltan2_MappingProblem.hpp.

---

The documentation for this class was generated from the following file:

• Zoltan2_MappingProblem.hpp