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. More...
void	Ifpack_BreakForDebugger (Epetra_Comm &Comm)
	Stops the execution of code, so that a debugger can be attached. More...
Epetra_CrsMatrix *	Ifpack_CreateOverlappingCrsMatrix (const Epetra_RowMatrix *Matrix, const int OverlappingLevel)
	Creates an overlapping Epetra_CrsMatrix. Returns 0 if OverlappingLevel is 0. More...
Epetra_CrsGraph *	Ifpack_CreateOverlappingCrsMatrix (const Epetra_CrsGraph *Graph, const int OverlappingLevel)
	Creates an overlapping Epetra_CrsGraph. Returns 0 if OverlappingLevel is 0. More...
std::string	Ifpack_toString (const int &x)
	Converts an integer to std::string. More...
std::string	Ifpack_toString (const double &x)
	Converts a double to std::string. More...
int	Ifpack_PrintResidual (char *Label, const Epetra_RowMatrix &A, const Epetra_MultiVector &X, const Epetra_MultiVector &Y)
	Prints on cout the true residual. More...
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 ifp_analyze. More...
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. More...
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. More...

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 std::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)

Function Documentation

void Ifpack_PrintLine

(

)

Prints a line of `=' on cout.

Definition at line 55 of file Ifpack_Utils.cpp.

void Ifpack_BreakForDebugger

(

Epetra_Comm &

Comm

)

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

Definition at line 61 of file Ifpack_Utils.cpp.

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

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

Definition at line 102 of file Ifpack_Utils.cpp.

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

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

Definition at line 182 of file Ifpack_Utils.cpp.

std::string Ifpack_toString

(

const int &

x

)

Converts an integer to std::string.

Definition at line 242 of file Ifpack_Utils.cpp.

std::string Ifpack_toString

(

const double &

x

)

Converts a double to std::string.

Definition at line 250 of file Ifpack_Utils.cpp.

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

Prints on cout the true residual.

Definition at line 258 of file Ifpack_Utils.cpp.

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

Definition at line 273 of file Ifpack_Utils.cpp.

void Ifpack_PrintSparsity_Simple

(

const Epetra_RowMatrix &

A

)

Definition at line 299 of file Ifpack_Utils.cpp.

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 ifp_analyze.

Definition at line 418 of file Ifpack_Utils.cpp.

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 ifp_matrix.

Definition at line 900 of file Ifpack_Utils.cpp.

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 ifp_vector.

Definition at line 841 of file Ifpack_Utils.cpp.

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

Definition at line 975 of file Ifpack_Utils.cpp.