Isorropia::Operator Class Reference

Interface (abstract base class) for computing a new partitioning/coloring/ ordering and exploiting their results. More...

#include <Isorropia_Operator.hpp>

Inheritance diagram for Isorropia::Operator:

[legend]List of all members.

Public Member Functions
virtual	~Operator ()
	Destructor.
virtual void	setParameters (const Teuchos::ParameterList &paramlist)=0
	Set parameters for the Operator instance.
virtual void	compute (bool forceRecomputing=false)=0
	Method which does the work of computing a new partitioning/coloring/ordering, depending on the child class used.

---

Detailed Description

Interface (abstract base class) for computing a new partitioning/coloring/ ordering and exploiting their results.

If the accessor methods are called before the computation of the result (by a method like compute()) has been called, behavior is not well defined. Implementations will either return empty/erroneous data, or throw an exception. In most cases, implementations will probably call compute_partitioning() internally in a constructor or factory method, so this won't usually be an issue.

---

Constructor & Destructor Documentation

virtual Isorropia::Operator::~Operator

(

)

[inline, virtual]

Destructor.

Reimplemented in Isorropia::Epetra::Operator.

---

Member Function Documentation

virtual void Isorropia::Operator::setParameters

(

const Teuchos::ParameterList &

paramlist

)

[pure virtual]

Set parameters for the Operator instance.

The contents of the input paramlist object are copied into an internal ParameterList attribute. Instances of this interface should not retain a reference to the input ParameterList after this method returns.

Parameters:

[in]

paramlist

List of parameters that the user wants to use.

Implemented in Isorropia::Epetra::Operator.

virtual void Isorropia::Operator::compute

(

bool

forceRecomputing = false

)

[pure virtual]

Method which does the work of computing a new partitioning/coloring/ordering, depending on the child class used.

Parameters:

forceRecomputing

Optional argument defaults to false. Depending on the implementation, compute() should only perform a computation the first time it is called, and subsequent repeated calls are no-ops. If the user's intent is to re-compute the results (e.g., if parameters or other inputs have been changed), then setting this flag to true will force a new result to be computed.

Implemented in Isorropia::Epetra::Colorer, Isorropia::Epetra::Operator, Isorropia::Epetra::Orderer, and Isorropia::Epetra::Partitioner.

virtual bool Isorropia::Operator::alreadyComputed

(

)

const [pure virtual]

Query whether the computation has already been called.

Returns:

True if the computation has already been done, False otherwise.

Implemented in Isorropia::Epetra::Operator.

virtual int Isorropia::Operator::numProperties

(

)

const [pure virtual]

Return the number of different values used for "properties".

For example, the number of colors or the number of parts used for the overall graph/matrix.

Returns:

Global number of values for properties

Remarks:

Infact, it returns the upper bound of the interval of taken values. For example, for the colors "1,2,4"" , it will return "4"

Implemented in Isorropia::Epetra::Operator.

virtual const int& Isorropia::Operator::operator[]

(

int

myElem

)

const [pure virtual]

Return the "property" for a given element that resided locally.

Parameters:

[in]

myElem

the local ID of the element we want to know the property.

Returns:

property associated to the local element.

Implemented in Isorropia::Epetra::Operator.

virtual int Isorropia::Operator::numElemsWithProperty

(

int

property

)

const [pure virtual]

Return the number of LOCAL elements with the given property.

Parameters:

[in]

property

Value of the property to consider.

Returns:

Number of local elems which have this property.

Implemented in Isorropia::Epetra::Operator.

virtual void Isorropia::Operator::elemsWithProperty	(	int	property,
		int *	elementList,
		int	len
	)			const [pure virtual]

Fill user-allocated list (of length len) with the local element ids of the LOCAL elements with the given property.

Parameters:

[in]	property	Value of the property to consider.
[out]	elementList	User allocated array (of size at least len) of local ID that have the asked property.
[in]	len	Maximum lenght for the array. If len is greater than the result of numElemsWithProperty() for property, only the first and relevant elements are filled.

Remarks:

Memory space which is not useful in the array is not initialized or used in this method.

Implemented in Isorropia::Epetra::Operator.

---

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

• Isorropia_Operator.hpp