PyTrilinos.Isorropia.LevelScheduler Class Reference

Inheritance diagram for PyTrilinos.Isorropia.LevelScheduler:

Collaboration diagram for PyTrilinos.Isorropia.LevelScheduler:

List of all members.

Public Member Functions
def	__init__
def	schedule
def	numLevels
def	numElemsWithLevel
def	elemsWithLevel

---

Detailed Description

Interface (abstract base class) for an operator that computes a
partitioning of local elements into levels. On each process the levels
begin at 1 and increase by 1. All elements in the same level can be
used in calculation concurrently. All elements in level i are
dependent upon the completion of the calculations involving the
elements in level i-1.

C++ includes: Isorropia_LevelScheduler.hpp 

---

Member Function Documentation

def PyTrilinos.Isorropia.LevelScheduler.elemsWithLevel	(		self,
			args
	)

elemsWithLevel(LevelScheduler self, int level, int * elementList, int len)

virtual void Isorropia::LevelScheduler::elemsWithLevel(int level, int
*elementList, int len) const

Fill user-allocated list (of length len) with the local ID for each
element in the given level.

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

level:  the wanted level

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

len:  the number of elements wanted

See:   Isorropia::Operator::elemsWithProperty() 

def PyTrilinos.Isorropia.LevelScheduler.numElemsWithLevel	(		self,
			args
	)

numElemsWithLevel(LevelScheduler self, int level) -> int

virtual int Isorropia::LevelScheduler::numElemsWithLevel(int level)
const

Return the number of elements in a given level.

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

level:  The wanted level.

The number of elements in the level.

See:   Isorropia::Operator::numElemsWithProperty() 

def PyTrilinos.Isorropia.LevelScheduler.numLevels	(		self,
			args
	)

numLevels(LevelScheduler self) -> int

virtual
int Isorropia::LevelScheduler::numLevels() const

Method which returns the number of levels.

The number of levels on the local process. Levels begin at 1 and
increase by 1.

See:   Isorropia::Operator::numProperties() 

def PyTrilinos.Isorropia.LevelScheduler.schedule	(		self,
			args
	)

schedule(LevelScheduler self, bool forceScheduling=False)

virtual
void Isorropia::LevelScheduler::schedule(bool forceScheduling=false)=0

Method which does the work of computing a new level schedule.

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

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

---

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

• Isorropia/__init__.py