Ifpack_Utils.h File Reference

#include "Ifpack_ConfigDefs.h"
#include "Epetra_Comm.h"
#include "unistd.h"

Include dependency graph for Ifpack_Utils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Ifpack_Element
Functions
void	Ifpack_PrintLine ()
	Prints a line of `=' on cout.
void	Ifpack_BreakForDebugger (Epetra_Comm &Comm)
	Stops the execution of code, so that a debugger can be attached.
Epetra_CrsMatrix *	Ifpack_CreateOverlappingCrsMatrix (const Epetra_RowMatrix *Matrix, const int OverlappingLevel)
	Creates an overlapping Epetra_CrsMatrix. Returns 0 if OverlappingLevel is 0.
Epetra_CrsGraph *	Ifpack_CreateOverlappingCrsMatrix (const Epetra_CrsGraph *Graph, const int OverlappingLevel)
	Creates an overlapping Epetra_CrsGraph. Returns 0 if OverlappingLevel is 0.
string	Ifpack_toString (const int &x)
	Convertes an integer to string.
string	Ifpack_toString (const double &x)
	Convertes a double to string.
int	Ifpack_PrintResidual (char *Label, const Epetra_RowMatrix &A, const Epetra_MultiVector &X, const Epetra_MultiVector &Y)
	Prints on cout the true residual.
int	Ifpack_PrintResidual (const int iter, const Epetra_RowMatrix &A, const Epetra_MultiVector &X, const Epetra_MultiVector &Y)
void	Ifpack_PrintSparsity_Simple (const Epetra_RowMatrix &A)
int	Ifpack_Analyze (const Epetra_RowMatrix &A, const bool Cheap=false, const int NumPDEEqns=1)
	Analyzes the basic properties of the input matrix A; see Usage of Ifpack_Analyze()..
int	Ifpack_AnalyzeMatrixElements (const Epetra_RowMatrix &A, const bool abs=false, const int steps=10)
	Analyzes the distribution of values of the input matrix A.
int	Ifpack_AnalyzeVectorElements (const Epetra_Vector &Diagonal, const bool abs=false, const int steps=10)
	Analyzes the distribution of values of the input vector Diagonal.
Largely inspired from Yousef Saad's SPARSKIT plot function.
Plots the sparsity pattern of an Epetra_RowMatrix into a PS file. Parameters: A  (In) - Epetra_RowMatrix whose sparsity pattern will be plotted. FileName  (In) - char string containing the filename. If 0, then the matrix label is used as file name, after appending .ps. NumPDEEqns  (In) - number of PDE equations. The function will plot the block structure of the matrix if NumPDEEqns > 1
int	Ifpack_PrintSparsity (const Epetra_RowMatrix &A, const char *FileName=0, const int NumPDEEqns=1)

---

Detailed Description

---

Function Documentation

int Ifpack_Analyze	(	const Epetra_RowMatrix &	A,
		const bool	Cheap = false,
		const int	NumPDEEqns = 1
	)

Analyzes the basic properties of the input matrix A; see Usage of Ifpack_Analyze()..

int Ifpack_AnalyzeMatrixElements	(	const Epetra_RowMatrix &	A,
		const bool	abs = false,
		const int	steps = 10
	)

Analyzes the distribution of values of the input matrix A.

Parameters:

	A	- (In) matrix to be analyzed.
	abs	- (In) if true, the function will analyze matrix B, whose elements are defined as .
	steps	- (In) number of intervals for the analysis.

An example of output is reported Usage of Ifpack_AnalyzeMatrixElements().

int Ifpack_AnalyzeVectorElements	(	const Epetra_Vector &	Diagonal,
		const bool	abs = false,
		const int	steps = 10
	)

Analyzes the distribution of values of the input vector Diagonal.

Parameters:

	Diagonal	- (In) Vector to be analyzed.
	abs	- (In) if true, the function will analyze vector B, whose elements are defined as .
	steps	- (In) number of intervals for the analysis.

An example of output is reported Usage of Ifpack_AnalyzeVectorElements().

void Ifpack_BreakForDebugger

(

Epetra_Comm &

Comm

)

Stops the execution of code, so that a debugger can be attached.

Epetra_CrsGraph* Ifpack_CreateOverlappingCrsMatrix	(	const Epetra_CrsGraph *	Graph,
		const int	OverlappingLevel
	)

Creates an overlapping Epetra_CrsGraph. Returns 0 if OverlappingLevel is 0.

Epetra_CrsMatrix* Ifpack_CreateOverlappingCrsMatrix	(	const Epetra_RowMatrix *	Matrix,
		const int	OverlappingLevel
	)

Creates an overlapping Epetra_CrsMatrix. Returns 0 if OverlappingLevel is 0.

void Ifpack_PrintLine

(

)

Prints a line of `=' on cout.

int Ifpack_PrintResidual	(	const int	iter,
		const Epetra_RowMatrix &	A,
		const Epetra_MultiVector &	X,
		const Epetra_MultiVector &	Y
	)

int Ifpack_PrintResidual	(	char *	Label,
		const Epetra_RowMatrix &	A,
		const Epetra_MultiVector &	X,
		const Epetra_MultiVector &	Y
	)

Prints on cout the true residual.

int Ifpack_PrintSparsity	(	const Epetra_RowMatrix &	A,
		const char *	FileName = 0,
		const int	NumPDEEqns = 1
	)

void Ifpack_PrintSparsity_Simple

(

const Epetra_RowMatrix &

A

)

string Ifpack_toString

(

const double &

x

)

Convertes a double to string.

string Ifpack_toString

(

const int &

x

)

Convertes an integer to string.