Zoltan2
Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | List of all members
Zoltan2::Problem< Adapter > Class Template Referenceabstract

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]

Public Member Functions

 Problem (const Adapter *input, ParameterList *params)
 Constructor where communicator is Teuchos default. More...
 
 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...
 
virtual void solve (bool updateInputData)=0
 Method that creates a solution. 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...
 

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

◆ base_adapter_t

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

Definition at line 211 of file Zoltan2_Problem.hpp.

Constructor & Destructor Documentation

◆ Problem() [1/2]

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

Constructor where communicator is Teuchos default.

Definition at line 75 of file Zoltan2_Problem.hpp.

◆ Problem() [2/2]

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

◆ ~Problem()

template<typename Adapter >
virtual Zoltan2::Problem< Adapter >::~Problem ( )
inlinevirtual

Destructor.

Definition at line 123 of file Zoltan2_Problem.hpp.

Member Function Documentation

◆ getComm()

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

Return the communicator used by the problem.

Definition at line 127 of file Zoltan2_Problem.hpp.

◆ resetParameters()

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

Reset the list of parameters.

Definition at line 328 of file Zoltan2_Problem.hpp.

◆ solve()

template<typename Adapter >
virtual void Zoltan2::Problem< Adapter >::solve ( bool  updateInputData)
pure virtual

◆ printTimers()

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

◆ getValidParameters()

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

Definition at line 164 of file Zoltan2_Problem.hpp.

◆ getEnvironment()

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

Get the current Environment. Useful for testing.

Definition at line 198 of file Zoltan2_Problem.hpp.

Member Data Documentation

◆ inputAdapter_

template<typename Adapter >
RCP<const Adapter> Zoltan2::Problem< Adapter >::inputAdapter_
protected

Definition at line 213 of file Zoltan2_Problem.hpp.

◆ baseInputAdapter_

template<typename Adapter >
RCP<const base_adapter_t> Zoltan2::Problem< Adapter >::baseInputAdapter_
protected

Definition at line 214 of file Zoltan2_Problem.hpp.

◆ graphModel_

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

Definition at line 216 of file Zoltan2_Problem.hpp.

◆ identifierModel_

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

Definition at line 217 of file Zoltan2_Problem.hpp.

◆ coordinateModel_

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

Definition at line 218 of file Zoltan2_Problem.hpp.

◆ baseModel_

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

Definition at line 224 of file Zoltan2_Problem.hpp.

◆ algorithm_

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

Definition at line 227 of file Zoltan2_Problem.hpp.

◆ params_

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

Definition at line 229 of file Zoltan2_Problem.hpp.

◆ comm_

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

Definition at line 230 of file Zoltan2_Problem.hpp.

◆ env_

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

Definition at line 236 of file Zoltan2_Problem.hpp.

◆ envConst_

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

Definition at line 241 of file Zoltan2_Problem.hpp.

◆ timer_

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

Definition at line 245 of file Zoltan2_Problem.hpp.


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