Isorropia::Orderer Class Reference

Interface (abstract base class) for computing a new ordering and describing the layout of elements in the new order. More...

#include <Isorropia_Orderer.hpp>

Inheritance diagram for Isorropia::Orderer:

Inheritance graph
[legend]
Collaboration diagram for Isorropia::Orderer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~Orderer ()
 Destructor.
virtual void order (bool forceOrdering=false)=0
 Method which does the work of computing a new ordering.
virtual int extractPermutationView (int &size, const int *&array) const
 Give access of the "direct" permutation vector that is owned by the current processor.
virtual int extractPermutationCopy (int len, int &size, int *array) const
 Copy a part of the "direct" permutation vector.
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 ordering and describing the layout of elements in the new order.

If the methods which describe the new ordering (e.g., operator[], etc.) are called before order() 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 order() internally in a constructor or factory method, so this won't usually be an issue.


Constructor & Destructor Documentation

virtual Isorropia::Orderer::~Orderer (  )  [inline, virtual]

Destructor.

Reimplemented in Isorropia::Epetra::Orderer.


Member Function Documentation

virtual void Isorropia::Orderer::order ( bool  forceOrdering = false  )  [pure virtual]

Method which does the work of computing a new ordering.

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

Implemented in Isorropia::Epetra::Orderer.

virtual int Isorropia::Orderer::extractPermutationView ( int &  size,
const int *&  array 
) const [inline, virtual]

Give access of the "direct" permutation vector that is owned by the current processor.

Parameters:
[out] size Number of elements in the array.
[out] array Pointer to the the part assignements array inside the object.
Remarks:
This pointer is only significant if the object still exists. Otherwise, you must use
See also:
Isorropia::Operator::extractPartsCopy()

Isorropia::Operator::extractPropertiesView()

virtual int Isorropia::Orderer::extractPermutationCopy ( int  len,
int &  size,
int *  array 
) const [inline, virtual]

Copy a part of the "direct" permutation vector.

Parameters:
[in] len of the array given by the user.
[out] size Number of elements in the array.
[out] array Direct permutation vector. Allocated by the user with a size of at least len elements.
Remarks:
Memory space which is not useful in the array is not initialized or used in this method.
See also:
Isorropia::Operator::extractPropertiesCopy()

virtual void Isorropia::Operator::setParameters ( const Teuchos::ParameterList &  paramlist  )  [pure virtual, inherited]

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, inherited]

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::LevelScheduler, Isorropia::Epetra::Operator, Isorropia::Epetra::Orderer, Isorropia::Epetra::Partitioner, and Isorropia::Epetra::Partitioner2D.

virtual bool Isorropia::Operator::alreadyComputed (  )  const [pure virtual, inherited]

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, inherited]

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 int Isorropia::Operator::numLocalProperties (  )  const [pure virtual, inherited]

Return the number of different values used for "properties" for this process only.

Returns:
Local number of values for properties

Implemented in Isorropia::Epetra::Operator.

virtual const int& Isorropia::Operator::operator[] ( int  myElem  )  const [pure virtual, inherited]

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, inherited]

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, inherited]

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.

virtual int Isorropia::Operator::extractPropertiesView ( int &  size,
const int *&  array 
) const [pure virtual, inherited]

Give access of the property array that is owned by the current processor.

Parameters:
[out] size Number of elements in the array.
[out] array Pointer to the the properties array inside the object.
Remarks:
This pointer is only significant if the object still exists. Otherwise, you must use
See also:
Isorropia::Operator::extractPropertiesCopy().

Isorropia::Operator::extractPropertiesCopy()

Implemented in Isorropia::Epetra::Operator.

virtual int Isorropia::Operator::extractPropertiesCopy ( int  len,
int &  size,
int *  array 
) const [pure virtual, inherited]

Copy a part of the property array.

Parameters:
[in] len of the array given by the user.
[out] size Number of elements in the array.
[out] array Array of properties. Allocated by the user with a size of at least len elements.
Remarks:
Memory space which is not useful in the array is not initialized or used in this method.
See also:
Isorropia::Operator::extractPropertiesView()

Implemented in Isorropia::Epetra::Operator.


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