Zoltan2::Problem< Adapter > Class Template Reference

Problem base class from which other classes (PartitioningProblem, ColoringProblem, OrderingProblem, MatchingProblem, etc.) derive. More...

#include <Zoltan2_Problem.hpp>

Inheritance diagram for Zoltan2::Problem< Adapter >:

Collaboration diagram for Zoltan2::Problem< Adapter >:

Public Member Functions
	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 ()
virtual void	solve (bool updateInputData=true)=0
	Method that creates a solution. More...

Static Public Member Functions
static void	getValidParameters (ParameterList &pl)

Protected Types
typedef Adapter::base_adapter_t	base_adapter_t

Protected Attributes
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::Problem< Adapter >

Problem base class from which other classes (PartitioningProblem, ColoringProblem, OrderingProblem, MatchingProblem, etc.) derive.

Definition at line 48 of file Zoltan2_Problem.hpp.

Member Typedef Documentation

template<typename Adapter >

typedef Adapter::base_adapter_t Zoltan2::Problem< Adapter >::base_adapter_t

protected

Definition at line 155 of file Zoltan2_Problem.hpp.

Constructor & Destructor Documentation

template<typename Adapter >

Zoltan2::Problem< Adapter >::Problem ( const Adapter *  input, ParameterList *  params, const RCP< const Comm< int > > &  comm  )

inline

Constructor where Teuchos communicator is specified.

Definition at line 53 of file Zoltan2_Problem.hpp.

template<typename Adapter >

virtual Zoltan2::Problem< Adapter >::~Problem ( )

inlinevirtual

Destructor.

Definition at line 70 of file Zoltan2_Problem.hpp.

Member Function Documentation

template<typename Adapter >

RCP<const Comm<int> > Zoltan2::Problem< Adapter >::getComm ( )

inlinevirtual

Return the communicator used by the problem.

Implements Zoltan2::ProblemRoot.

Definition at line 74 of file Zoltan2_Problem.hpp.

template<typename Adapter >

void Zoltan2::Problem< Adapter >::resetParameters

(

ParameterList *

params

)

Reset the list of parameters.

Definition at line 255 of file Zoltan2_Problem.hpp.

template<typename Adapter >

void Zoltan2::Problem< Adapter >::printTimers ( ) const

inline

Return the communicator passed to the problem.

If timer data was collected, print out global data.

If the parameter "timer_output_stream" or "timer_output_file" was set, then timing statistics are available and will be printed out to the requested output stream with this call.

All processes in the application must call this, even if they were not all in the problem communicator. All timers are reset back to zero after this call.

Timer starts, stops and displays are ignored if Zoltan2 is compiled with Z2_OMIT_ALL_ERROR_CHECKING.

Definition at line 99 of file Zoltan2_Problem.hpp.

template<typename Adapter >

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

inlinestatic

Definition at line 107 of file Zoltan2_Problem.hpp.

template<typename Adapter >

const RCP<const Environment>& Zoltan2::Problem< Adapter >::getEnvironment ( ) const

inline

Get the current Environment. Useful for testing.

Definition at line 142 of file Zoltan2_Problem.hpp.

Member Data Documentation

template<typename Adapter >

RCP<const Adapter> Zoltan2::Problem< Adapter >::inputAdapter_

protected

Definition at line 157 of file Zoltan2_Problem.hpp.

template<typename Adapter >

RCP<const base_adapter_t> Zoltan2::Problem< Adapter >::baseInputAdapter_

protected

Definition at line 158 of file Zoltan2_Problem.hpp.

template<typename Adapter >

RCP<Algorithm<Adapter> > Zoltan2::Problem< Adapter >::algorithm_

protected

Definition at line 161 of file Zoltan2_Problem.hpp.

template<typename Adapter >

RCP<ParameterList> Zoltan2::Problem< Adapter >::params_

protected

Definition at line 163 of file Zoltan2_Problem.hpp.

template<typename Adapter >

RCP<const Comm<int> > Zoltan2::Problem< Adapter >::comm_

protected

Definition at line 164 of file Zoltan2_Problem.hpp.

template<typename Adapter >

RCP<Environment> Zoltan2::Problem< Adapter >::env_

protected

Definition at line 170 of file Zoltan2_Problem.hpp.

template<typename Adapter >

RCP<const Environment> Zoltan2::Problem< Adapter >::envConst_

protected

Definition at line 175 of file Zoltan2_Problem.hpp.

template<typename Adapter >

RCP<TimerManager> Zoltan2::Problem< Adapter >::timer_

protected

Definition at line 179 of file Zoltan2_Problem.hpp.

---

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

• Zoltan2_Problem.hpp