PyTrilinos.Isorropia.Colorer Class Reference

Inheritance diagram for PyTrilinos.Isorropia.Colorer:

Collaboration diagram for PyTrilinos.Isorropia.Colorer:

List of all members.

Public Member Functions
def	__init__
def	color
def	numColors
def	numElemsWithColor
def	extractColorsView
def	extractColorsCopy
def	elemsWithColor

---

Detailed Description

Interface (abstract base class) for computing a new coloring and
describing the result.

The colors returned have values between 1 and C, where C is the number
of colors used.

C++ includes: Isorropia_Colorer.hpp 

---

Member Function Documentation

def PyTrilinos.Isorropia.Colorer.color	(		self,
			args
	)

color(Colorer self, bool forceColoring=False)

virtual void
Isorropia::Colorer::color(bool forceColoring=false)=0

Method which does the work of computing a new coloring.

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

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

def PyTrilinos.Isorropia.Colorer.elemsWithColor	(		self,
			args
	)

elemsWithColor(Colorer self, int color) -> PyObject *

virtual
void Isorropia::Colorer::elemsWithColor(int color, int *elementList,
int len) const

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

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

color:  the wanted color

elementList:  an array to receive local elements of the given color

len:  the number of elements wanted

See:   Isorropia::Operator::elemsWithProperty() 

def PyTrilinos.Isorropia.Colorer.extractColorsCopy	(		self,
			args
	)

extractColorsCopy(Colorer self, int len, int & size, int * array) -> int

virtual
int Isorropia::Colorer::extractColorsCopy(int len, int &size, int
*array) const

Copy a part of the color assignments array.

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

len:  of the array given by the user.

size:  Number of elements in the array.

array:  Array of color assignments. 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.Colorer.extractColorsView	(		self,
			args
	)

extractColorsView(Colorer self, int & size, int const *& array) -> int

virtual
int Isorropia::Colorer::extractColorsView(int &size, const int
*&array) const

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

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

size:  Number of elements in the array.

array:  Pointer to the color 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.Colorer.numColors	(		self,
			args
	)

numColors(Colorer self) -> int

virtual int
Isorropia::Colorer::numColors() const

Method which returns the number (global) of colors used.

The overall number of colors used. All colors used for all vertices
are between 1 and this value (included).

See:   Isorropia::Operator::numProperties() 

def PyTrilinos.Isorropia.Colorer.numElemsWithColor	(		self,
			args
	)

numElemsWithColor(Colorer self, int color) -> int

virtual
int Isorropia::Colorer::numElemsWithColor(int color) const

Return the number of local elements of a given color.

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

color:  The wanted color.

The number of local of the asked color.

See:   Isorropia::Operator::numElemsWithProperty() 

---

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

• Isorropia/__init__.py