Zoltan2
Public Member Functions | Protected Types | Protected Attributes
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 >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Problem (Adapter *input, ParameterList *params)
 Constructor where communicator is Teuchos default.
 Problem (Adapter *input, ParameterList *params, RCP< const Comm< int > > &comm)
 Constructor where Teuchos communicator is specified.
virtual ~Problem ()
 Destructor.
RCP< const Comm< int > > getComm ()
 Return the communicator used by the problem.
void resetParameters (ParameterList *params)
 Reset the list of parameters.
virtual void solve (bool updateInputData)=0
 Method that creates a solution.
void printTimers () const
 Return the communicator passed to the problem.

Protected Types

typedef Adapter::base_adapter_t base_adapter_t

Protected Attributes

Adapter * inputAdapter_
base_adapter_tbaseInputAdapter_
RCP< GraphModel< base_adapter_t > > graphModel_
RCP< IdentifierModel
< base_adapter_t > > 
identifierModel_
RCP< CoordinateModel
< base_adapter_t > > 
coordinateModel_
RCP< const Model
< base_adapter_t > > 
baseModel_
RCP< Algorithm< Adapter > > algorithm_
RCP< ParameterList > params_
RCP< const Comm< int > > comm_
RCP< Environmentenv_
RCP< const EnvironmentenvConst_
RCP< TimerManagertimer_

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 70 of file Zoltan2_Problem.hpp.


Member Typedef Documentation

template<typename Adapter >
typedef Adapter::base_adapter_t Zoltan2::Problem< Adapter >::base_adapter_t [protected]

Constructor & Destructor Documentation

template<typename Adapter >
Zoltan2::Problem< Adapter >::Problem ( Adapter *  input,
ParameterList *  params 
) [inline]

Constructor where communicator is Teuchos default.

Definition at line 92 of file Zoltan2_Problem.hpp.

template<typename Adapter >
Zoltan2::Problem< Adapter >::Problem ( Adapter *  input,
ParameterList *  params,
RCP< const Comm< int > > &  comm 
) [inline]

Constructor where Teuchos communicator is specified.

Definition at line 105 of file Zoltan2_Problem.hpp.

template<typename Adapter >
virtual Zoltan2::Problem< Adapter >::~Problem ( ) [inline, virtual]

Destructor.

Definition at line 116 of file Zoltan2_Problem.hpp.


Member Function Documentation

template<typename Adapter >
RCP<const Comm<int> > Zoltan2::Problem< Adapter >::getComm ( ) [inline]

Return the communicator used by the problem.

Definition at line 120 of file Zoltan2_Problem.hpp.

template<typename Adapter >
void Zoltan2::Problem< Adapter >::resetParameters ( ParameterList *  params)

Reset the list of parameters.

Reimplemented in Zoltan2::PartitioningProblem< Adapter >.

Definition at line 282 of file Zoltan2_Problem.hpp.

template<typename Adapter >
virtual void Zoltan2::Problem< Adapter >::solve ( bool  updateInputData) [pure virtual]
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 149 of file Zoltan2_Problem.hpp.


Member Data Documentation

template<typename Adapter >
Adapter* Zoltan2::Problem< Adapter >::inputAdapter_ [protected]

Definition at line 167 of file Zoltan2_Problem.hpp.

template<typename Adapter >
base_adapter_t* Zoltan2::Problem< Adapter >::baseInputAdapter_ [protected]

Definition at line 168 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<GraphModel<base_adapter_t> > Zoltan2::Problem< Adapter >::graphModel_ [protected]

Definition at line 170 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<IdentifierModel<base_adapter_t> > Zoltan2::Problem< Adapter >::identifierModel_ [protected]

Definition at line 171 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<CoordinateModel<base_adapter_t> > Zoltan2::Problem< Adapter >::coordinateModel_ [protected]

Definition at line 172 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<const Model<base_adapter_t> > Zoltan2::Problem< Adapter >::baseModel_ [protected]

Definition at line 178 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<Algorithm<Adapter> > Zoltan2::Problem< Adapter >::algorithm_ [protected]

Definition at line 181 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<ParameterList> Zoltan2::Problem< Adapter >::params_ [protected]

Definition at line 183 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<const Comm<int> > Zoltan2::Problem< Adapter >::comm_ [protected]

Definition at line 184 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<Environment> Zoltan2::Problem< Adapter >::env_ [protected]

Definition at line 190 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<const Environment> Zoltan2::Problem< Adapter >::envConst_ [protected]

Definition at line 195 of file Zoltan2_Problem.hpp.

template<typename Adapter >
RCP<TimerManager> Zoltan2::Problem< Adapter >::timer_ [protected]

Definition at line 199 of file Zoltan2_Problem.hpp.


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