OrderingProblem sets up ordering problems for the user. More...

#include <Zoltan2_OrderingProblem.hpp>

Inheritance diagram for Zoltan2::OrderingProblem< Adapter >:

Collaboration diagram for Zoltan2::OrderingProblem< Adapter >:

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::base_adapter_t	base_adapter_t

Public Member Functions
virtual	~OrderingProblem ()
	Destructor. More...

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

	OrderingProblem (Adapter A, ParameterList p)
	Constructor that uses a default communicator. More...

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

LocalOrderingSolution< lno_t > *	getLocalOrderingSolution ()
	Get the local ordering solution to the problem. More...

GlobalOrderingSolution< gno_t > *	getGlobalOrderingSolution ()
	Get the global ordering solution to the problem. 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)

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>
class Zoltan2::OrderingProblem< Adapter >

OrderingProblem sets up ordering problems for the user.

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

Todo:

include pointers to examples

- 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.