PartitioningProblem sets up partitioning problems for the user. More...

#include <Zoltan2_PartitioningProblem.hpp>

Inheritance diagram for Zoltan2::PartitioningProblem< Adapter >:

Collaboration diagram for Zoltan2::PartitioningProblem< Adapter >:

Public Types
typedef Adapter::scalar_t	scalar_t

typedef Adapter::gno_t	gno_t

typedef Adapter::lno_t	lno_t

typedef Adapter::part_t	part_t

typedef Adapter::user_t	user_t

typedef Adapter::base_adapter_t	base_adapter_t

Public Member Functions
	PartitioningProblem (Adapter A, ParameterList p, const RCP< const Teuchos::Comm< int > > &comm)
	Constructor where Teuchos communicator is specified. More...

	PartitioningProblem (Adapter A, ParameterList p)
	Constructor where communicator is the Teuchos default. More...

	~PartitioningProblem ()
	Destructor. More...

void	solve (bool updateInputData=true)
	Direct the problem to create a solution. More...

const PartitioningSolution < Adapter > &	getSolution ()
	Get the solution to the problem. More...

void	setPartSizes (int len, part_t partIds, scalar_t partSizes, bool makeCopy=true)
	Set or reset relative sizes for the parts that Zoltan2 will create. More...

void	setPartSizesForCriteria (int criteria, int len, part_t partIds, scalar_t partSizes, bool makeCopy=true)
	Set or reset the relative sizes (per weight) for the parts that Zoltan2 will create. More...

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)

Protected Member Functions
void	initializeProblem ()

virtual void	processAlgorithmName (const std::string &algorithm, const std::string &defString, const std::string &model, Environment &env, bool &removeSelfEdges, bool &isGraphType, bool &needConsecutiveGlobalIds)

void	createPartitioningProblem (bool newData)

virtual void	createAlgorithm ()

Protected Attributes
RCP< PartitioningSolution < Adapter > >	solution_

BaseAdapterType	inputType_

modelFlag_t	graphFlags_

modelFlag_t	idFlags_

modelFlag_t	coordFlags_

std::string	algName_

int	numberOfWeights_

ArrayRCP< ArrayRCP< part_t > >	partIds_

ArrayRCP< ArrayRCP< scalar_t > >	partSizes_

int	numberOfCriteria_

ArrayRCP< int >	levelNumberParts_

bool	hierarchical_

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_

Additional Inherited Members
Protected Types inherited from Zoltan2::Problem< Adapter >
typedef Adapter::base_adapter_t	base_adapter_t

Detailed Description

template<typename Adapter>
class Zoltan2::PartitioningProblem< Adapter >

PartitioningProblem sets up partitioning problems for the user.

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

Todo:

include pointers to examples

repartition given an initial solution

follow partitioning with global or local ordering

allow unsetting of part sizes by passing in null pointers

add a parameter by which user tells us there are no self edges to be removed.

- Should Problems and Solution have interfaces for returning views and for returning RCPs? Or just one? At a minimum, we should have the word "View" in function names that return views.

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

Todo:: hierarchical partitioning

Examples:: block.cpp, kokkosBlock.cpp, and rcb_C.cpp.

Definition at line 104 of file Zoltan2_PartitioningProblem.hpp.

Member Typedef Documentation

template<typename Adapter>

typedef Adapter::scalar_t Zoltan2::PartitioningProblem< Adapter >::scalar_t

Definition at line 108 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

typedef Adapter::gno_t Zoltan2::PartitioningProblem< Adapter >::gno_t

Definition at line 109 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

typedef Adapter::lno_t Zoltan2::PartitioningProblem< Adapter >::lno_t

Definition at line 110 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

typedef Adapter::part_t Zoltan2::PartitioningProblem< Adapter >::part_t

Definition at line 111 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

typedef Adapter::user_t Zoltan2::PartitioningProblem< Adapter >::user_t

Definition at line 112 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

typedef Adapter::base_adapter_t Zoltan2::PartitioningProblem< Adapter >::base_adapter_t

Definition at line 113 of file Zoltan2_PartitioningProblem.hpp.

Constructor & Destructor Documentation

template<typename Adapter>

Zoltan2::PartitioningProblem< Adapter >::PartitioningProblem	(	Adapter *	A,
		ParameterList *	p,
		const RCP< const Teuchos::Comm< int > > &	comm
	)

inline

Constructor where Teuchos communicator is specified.

Definition at line 116 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

Zoltan2::PartitioningProblem< Adapter >::PartitioningProblem	(	Adapter *	A,
		ParameterList *	p
	)

inline

Constructor where communicator is the Teuchos default.

Definition at line 139 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

Zoltan2::PartitioningProblem< Adapter >::~PartitioningProblem ( )

inline

Destructor.

Definition at line 145 of file Zoltan2_PartitioningProblem.hpp.

Member Function Documentation

template<typename Adapter >

void Zoltan2::PartitioningProblem< Adapter >::solve ( bool updateInputData = true )

virtual

Direct the problem to create a solution.

Implements Zoltan2::ProblemRoot.

Definition at line 614 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

const PartitioningSolution<Adapter>& Zoltan2::PartitioningProblem< Adapter >::getSolution ( )

inline

Get the solution to the problem.

Definition at line 170 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

void Zoltan2::PartitioningProblem< Adapter >::setPartSizes	(	int	len,
		part_t *	partIds,
		scalar_t *	partSizes,
		bool	makeCopy = `true`
	)

inline

Set or reset relative sizes for the parts that Zoltan2 will create.

Parameters

len	The size of the `partIds` and `partSizes` lists
partIds	A list of `len` part identifiers. Part identifiers range from zero to one less than the global number of identifiers.
partSizes	A list of `len` relative sizes corresponding to the `partIds`.
makeCopy	If true, Zoltan2 will make a copy of the ids and sizes that are provided in this call. If false, Zoltan2 will just save the pointers to to the caller's lists. If the pointers will remain remain valid throughout the lifetime of the PartitioningProblem, and memory use is an issue, then set makeCopy to false. By default, Zoltan2 will copy the caller's list of ids and sizes.

A given partid should be provided only once across all ranks. Duplicate partIds will generate a std::runtime_error exception when the PartitioningSolution is created. Part ids that are omitted will be assigned the average of the sizes that have been specified.

Subsequent calls to setPartSizes will replace the list of part ids and part sizes provided previously.

If the application has set multiple weights per object, then the part sizes supplied in this method are applied to the first weight.

Zoltan2 assumes that uniform part sizes are desired by the caller, unless specified otherwise in a call to setPartSizes or setPartSizesForCriteria.

Todo:: A user should be able to give us one set of part sizes that applies to all weight indices. Right now for each weight index that does not have uniform part sizes, the user has to give us the part sizes once for each.

Definition at line 212 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter >

void Zoltan2::PartitioningProblem< Adapter >::setPartSizesForCriteria	(	int	criteria,
		int	len,
		part_t *	partIds,
		scalar_t *	partSizes,
		bool	makeCopy = `true`
	)

Set or reset the relative sizes (per weight) for the parts that Zoltan2 will create.

Parameters

criteria	the criteria for which these part sizes apply. Criteria range from zero to one less than the number of weights per object specified in the caller's InputAdapter.
len	The size of the `partIds` and `partSizes` lists
partIds	A list of `len` part identifiers. Part identifiers range from zero to one less than the global number of identifiers.
partSizes	A list of `len` relative sizes corresponding to the `partIds`.
makeCopy	If true, Zoltan2 will make a copy of the ids and sizes that are provided in this call. If false, Zoltan2 will just save the pointers to to the caller's lists. If the pointers will remain remain valid throughout the lifetime of the PartitioningProblem, and memory use is an issue, then set makeCopy to false. By default, Zoltan2 will copy the caller's list of ids and sizes.

A given partid should only be provided once across the application. Duplicate partIds will generate a std::runtime_error exception when the PartitioningSolution is created. Part ids that are omitted will be assigned the average of the sizes that have been specified.

Subsequent calls to setPartSizes for the same criteria will replace the list of part ids and part sizes provided for that criteria previously.

Zoltan2 assumes that uniform part sizes are desired by the caller, unless specified otherwise in a call to setPartSizes or setPartSizesForCriteria.

Definition at line 486 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter>

static void Zoltan2::PartitioningProblem< Adapter >::getValidParameters ( ParameterList & pl )

inlinestatic

Set up validators specific to this Problem.

Definition at line 260 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter >

void Zoltan2::PartitioningProblem< Adapter >::initializeProblem ( )

protected

Definition at line 430 of file Zoltan2_PartitioningProblem.hpp.

template<typename Adapter >

void Zoltan2::PartitioningProblem< Adapter >::processAlgorithmName	(	const std::string &	algorithm,
		const std::string &	defString,
		const std::string &	model,
		Environment &	env,
		bool &	removeSelfEdges,
		bool &	isGraphType,
		bool &	needConsecutiveGlobalIds
	)