PyTrilinos.Isorropia.Orderer Class Reference

Inheritance diagram for PyTrilinos.Isorropia.Orderer:

Collaboration diagram for PyTrilinos.Isorropia.Orderer:

List of all members.

Public Member Functions
def	__init__
def	order
def	extractPermutationView
def	extractPermutationCopy

---

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.

C++ includes: Isorropia_Orderer.hpp 

---

Member Function Documentation

def PyTrilinos.Isorropia.Orderer.extractPermutationCopy	(		self,
			args
	)

extractPermutationCopy(Orderer self, int len, int & size, int * array) -> int

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

Copy a part of the "direct" permutation vector.

Parameters:
-----------

len:  of the array given by the user.

size:  Number of elements in the array.

array:  Direct permutation vector. Allocated by the user with a size
of at least len elements.

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

See:   Isorropia::Operator::extractPropertiesCopy() 

def PyTrilinos.Isorropia.Orderer.extractPermutationView	(		self,
			args
	)

extractPermutationView(Orderer self, int & size, int const *& array) -> int

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

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

Parameters:
-----------

size:  Number of elements in the array.

array:  Pointer to the the part assignements array inside the object.

This pointer is only significant if the object still exists.
Otherwise, you must use

See:  Isorropia::Operator::extractPartsCopy()

Isorropia::Operator::extractPropertiesView() 

def PyTrilinos.Isorropia.Orderer.order	(		self,
			args
	)

order(Orderer self, bool forceOrdering=False)

virtual void
Isorropia::Orderer::order(bool forceOrdering=false)=0

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. 

---

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

• Isorropia/__init__.py