Isorropia Coloring Methods

Here we describe the coloring interface provided by Isorropia. More...

Classes
class	Isorropia::Epetra::Colorer
	An implementation of the Colorer interface that operates on Epetra matrices and linear systems. More...

Functions
	Isorropia::Epetra::Colorer::Colorer (Teuchos::RCP< const Epetra_CrsGraph > input_graph, const Teuchos::ParameterList &paramlist=Teuchos::ParameterList("EmptyParameterList"), bool compute_now=true)
	Constructor. More...
	Isorropia::Epetra::Colorer::Colorer (const Epetra_CrsGraph *input_graph, const Teuchos::ParameterList &paramlist=Teuchos::ParameterList("EmptyParameterList"), bool compute_now=true)
	Constructor. More...
	Isorropia::Epetra::Colorer::Colorer (Teuchos::RCP< const Epetra_RowMatrix > input_matrix, const Teuchos::ParameterList &paramlist=Teuchos::ParameterList("EmptyParameterList"), bool compute_now=true)
	Constructor. More...
	Isorropia::Epetra::Colorer::Colorer (const Epetra_RowMatrix *input_matrix, const Teuchos::ParameterList &paramlist=Teuchos::ParameterList("EmptyParameterList"), bool compute_now=true)
	Constructor. More...
void	Isorropia::Epetra::Colorer::color (bool force_coloring=false)
	Compute the coloring if it has not already been computed, same effect as Isorropia::Epetra::Colorer::compute. More...
void	Isorropia::Epetra::Colorer::compute (bool force_compute=false)
	Compute the coloring if it has not already been computed, same effect as Isorropia::Epetra::Colorer::color. More...
Teuchos::RCP< Epetra_MapColoring >	Isorropia::Epetra::Colorer::generateRowMapColoring ()
	Generate an Epetra_MapColoring object corresponding of rows color. More...
Teuchos::RCP< Epetra_MapColoring >	Isorropia::Epetra::Colorer::generateColMapColoring ()
	Generate an Epetra_MapColoring object corresponding of columns color. More...

Detailed Description

Here we describe the coloring interface provided by Isorropia.

Coloring

Isorropia supports vertex coloring of a graph via Zoltan. Both distance-1 and distance-2 coloring is supported. See the Zoltan User's guide (available at the Zoltan web site) for details. Currently, coloring is limited to structurally symmetric matrices but we expect to support nonsymmetric matrices (e.g., Jacobians) in the future.

Function Documentation

Isorropia::Epetra::Colorer::Colorer	(	Teuchos::RCP< const Epetra_CrsGraph >	input_graph,
		const Teuchos::ParameterList &	paramlist = Teuchos::ParameterList("EmptyParameterList"),
		bool	compute_now = true
	)

Constructor.

Parameters

input_graph	(in) the graph which is to have colors assigned to its rows
paramlist	(in) this parameter list may be used to pass parameters to Zoltan
compute_now	(in) if true, the coloring is computed in the constructor, otherwise call Isorropia::Epetra::Colorer::color when you want to compute the coloring, defaults to true

Isorropia::Epetra::Colorer::Colorer	(	const Epetra_CrsGraph *	input_graph,
		const Teuchos::ParameterList &	paramlist = Teuchos::ParameterList("EmptyParameterList"),
		bool	compute_now = true
	)

Constructor.

Parameters

input_graph	(in) the graph which is to have colors assigned to its rows
paramlist	(in) this parameter list may be used to pass parameters to Zoltan
compute_now	(in) if true, the coloring is computed in the constructor, otherwise call Isorropia::Epetra::Colorer::color when you want to compute the coloring, defaults to true

Isorropia::Epetra::Colorer::Colorer	(	Teuchos::RCP< const Epetra_RowMatrix >	input_matrix,
		const Teuchos::ParameterList &	paramlist = Teuchos::ParameterList("EmptyParameterList"),
		bool	compute_now = true
	)

Constructor.

Parameters

input_matrix	(in) the matrix which is to have colors assigned to its rows
paramlist	(in) this parameter list may be used to pass parameters to Zoltan
compute_now	(in) if true, the coloring is computed in the constructor, otherwise call Isorropia::Epetra::Colorer::color when you want to compute the coloring, defaults to true

Isorropia::Epetra::Colorer::Colorer	(	const Epetra_RowMatrix *	input_matrix,
		const Teuchos::ParameterList &	paramlist = Teuchos::ParameterList("EmptyParameterList"),
		bool	compute_now = true
	)

Constructor.

Parameters

input_matrix	(in) the matrix which is to have colors assigned to its rows
paramlist	(in) this parameter list may be used to pass parameters to Zoltan
compute_now	(in) if true, the coloring is computed in the constructor, otherwise call Isorropia::Epetra::Colorer::color when you want to compute the coloring, defaults to true

void Isorropia::Epetra::Colorer::color ( bool  force_coloring = false )

virtual

Compute the coloring if it has not already been computed, same effect as Isorropia::Epetra::Colorer::compute.

Parameters

force_coloring

(in) if true recompute the coloring even if it has already been computed, defaults to false

Implements Isorropia::Colorer.

void Isorropia::Epetra::Colorer::compute ( bool  force_compute = false )

inlinevirtual

Compute the coloring if it has not already been computed, same effect as Isorropia::Epetra::Colorer::color.

Parameters

force_compute

(in) if true recompute the coloring even if it has already been computed, defaults to false

Implements Isorropia::Epetra::Operator.

Teuchos::RCP<Epetra_MapColoring> Isorropia::Epetra::Colorer::generateRowMapColoring

(

)

Generate an Epetra_MapColoring object corresponding of rows color.

Provide access on the coloring thru the EpetraEXT color class Epetra_MapColoring. This methods requires EpetraEXT support.

Teuchos::RCP<Epetra_MapColoring> Isorropia::Epetra::Colorer::generateColMapColoring

(

)

Generate an Epetra_MapColoring object corresponding of columns color.

Provide access on the coloring thru the EpetraEXT color class Epetra_MapColoring. This methods requires EpetraEXT support.