Zoltan2::EvaluateOrdering< Adapter > Class Template Reference

A class that computes and returns quality metrics. \A base class for the local and global ordering versions. More...

#include <Zoltan2_EvaluateOrdering.hpp>

Inheritance diagram for Zoltan2::EvaluateOrdering< Adapter >:

Collaboration diagram for Zoltan2::EvaluateOrdering< Adapter >:

Public Member Functions
	EvaluateOrdering (const Adapter *ia, ParameterList *p, const LocalOrderingSolution< lno_t > *localSoln, const GlobalOrderingSolution< gno_t > *globalSoln)
	Constructor where communicator is Teuchos default. More...
	EvaluateOrdering (const Adapter *ia, ParameterList *p, const RCP< const Comm< int > > &problemComm, const LocalOrderingSolution< lno_t > *localSoln, const GlobalOrderingSolution< gno_t > *globalSoln)
	Constructor where Teuchos communicator is specified. More...
lno_t	getBandwidth () const
lno_t	getEnvelope () const
lno_t	getSeparatorSize () const
virtual void	printMetrics (std::ostream &os) const
	Print all metrics of type metricType based on the metric object type Note that parent class currently suppresses this if the list is empty. More...
void	localOrderingMetrics (const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, const Adapter *ia, const LocalOrderingSolution< typename Adapter::lno_t > *localSoln)
Public Member Functions inherited from Zoltan2::EvaluateBaseClassRoot
virtual	~EvaluateBaseClassRoot ()
virtual void	printMetrics (std::ostream &) const
	Print all metrics. More...

Detailed Description

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

A class that computes and returns quality metrics. \A base class for the local and global ordering versions.

Definition at line 62 of file Zoltan2_EvaluateOrdering.hpp.

Constructor & Destructor Documentation

EvaluateOrdering() [1/2]

template<typename Adapter >

Zoltan2::EvaluateOrdering< Adapter >::EvaluateOrdering ( const Adapter *  ia, ParameterList *  p, const LocalOrderingSolution< lno_t > *  localSoln, const GlobalOrderingSolution< gno_t > *  globalSoln  )

inline

Constructor where communicator is Teuchos default.

Parameters

ia	the problem input adapter
p	the parameter list
localSoln	the local solution
globalSoln	the global solution The constructor does global communication to compute the metrics. The rest of the methods are local.

Definition at line 96 of file Zoltan2_EvaluateOrdering.hpp.

EvaluateOrdering() [2/2]

template<typename Adapter >

Zoltan2::EvaluateOrdering< Adapter >::EvaluateOrdering ( const Adapter *  ia, ParameterList *  p, const RCP< const Comm< int > > &  problemComm, const LocalOrderingSolution< lno_t > *  localSoln, const GlobalOrderingSolution< gno_t > *  globalSoln  )

inline

Constructor where Teuchos communicator is specified.

Parameters

ia	the problem input adapter
p	the parameter list
problemComm	the problem communicator
localSoln	the local solution
globalSoln	the global solution The constructor does global communication to compute the metrics. The rest of the methods are local.

Definition at line 115 of file Zoltan2_EvaluateOrdering.hpp.

Member Function Documentation

getBandwidth()

template<typename Adapter >

lno_t Zoltan2::EvaluateOrdering< Adapter >::getBandwidth ( ) const

inline

Definition at line 150 of file Zoltan2_EvaluateOrdering.hpp.

getEnvelope()

template<typename Adapter >

lno_t Zoltan2::EvaluateOrdering< Adapter >::getEnvelope ( ) const

inline

Definition at line 151 of file Zoltan2_EvaluateOrdering.hpp.

getSeparatorSize()

template<typename Adapter >

lno_t Zoltan2::EvaluateOrdering< Adapter >::getSeparatorSize ( ) const

inline

Definition at line 152 of file Zoltan2_EvaluateOrdering.hpp.

printMetrics()

template<typename Adapter >

virtual void Zoltan2::EvaluateOrdering< Adapter >::printMetrics ( std::ostream &  os ) const

inlinevirtual

Print all metrics of type metricType based on the metric object type Note that parent class currently suppresses this if the list is empty.

Reimplemented from Zoltan2::EvaluateBaseClassRoot.

Definition at line 157 of file Zoltan2_EvaluateOrdering.hpp.

localOrderingMetrics()

template<typename Adapter >

void Zoltan2::EvaluateOrdering< Adapter >::localOrderingMetrics ( const RCP< const Environment > &  env, const RCP< const Comm< int > > &  comm, const Adapter *  ia, const LocalOrderingSolution< typename Adapter::lno_t > *  localSoln  )

inline

Definition at line 168 of file Zoltan2_EvaluateOrdering.hpp.

---

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

• Zoltan2_EvaluateOrdering.hpp