Aztec2Petra.h File Reference

Aztec2Petra: A function that converts an Aztec linear problem to a Petra linear problem. More...

#include "az_aztec.h"
#include "Epetra_SerialComm.h"
#include "Epetra_Map.h"
#include "Epetra_Vector.h"
#include "Epetra_VbrMatrix.h"
#include "Epetra_CrsMatrix.h"

Include dependency graph for Aztec2Petra.h:

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

Functions
int	Aztec2Petra (int *proc_config, AZ_MATRIX *Amat, double *az_x, double *az_b, Epetra_Comm *&comm, Epetra_BlockMap *&map, Epetra_RowMatrix *&A, Epetra_Vector *&x, Epetra_Vector *&b, int **global_indices)
	Converts from an Aztec linear problem to a Petra linear problem. More...

Detailed Description

Aztec2Petra: A function that converts an Aztec linear problem to a Petra linear problem.

Aztec2Petra takes the Aztec proc_config, Amat, az_x and az_b objects and converts them into corresponding Petra equivalents: comm, map (layout information), A, x, and b. This function is used by AZOO_iterate, but can be used independently by someone making a transistion from Aztec to Trilinos/AztecOO.

Function Documentation

int Aztec2Petra	(	int *	proc_config,
		AZ_MATRIX *	Amat,
		double *	az_x,
		double *	az_b,
		Epetra_Comm *&	comm,
		Epetra_BlockMap *&	map,
		Epetra_RowMatrix *&	A,
		Epetra_Vector *&	x,
		Epetra_Vector *&	b,
		int **	global_indices
	)

Converts from an Aztec linear problem to a Petra linear problem.

Parameters

proc_config	(In) Aztec array containing information about the parallel machine.
Amat	(In) An Aztec AZ_MATRIX structure. Must be an MSR or VBR matrix at this time.
az_x	(In) The Aztec initial guess/solution vector. Must be of adequate length on each processor for any ghost values (unnecessary in uniprocessor mode).
az_b	(In) The Aztec right hand side vector. .
comm	(Out) A pointer to a Epetra_Comm object. Must be deleted by the caller of this function.
map	(Out) A pointer to a Epetra_BlockMap object. Must be deleted by the caller of this function. Note: This object may actually be a Epetra_Map object, but Epetra_BlockMap is a base clase for Epetra_Map.
A	(Out) A pointer to a Epetra_RowMatrix object containing a deep copy of the matrix in Amat, if the user matrix is an Msr matrix. It is a shallow copy of the matrix if the user matrix is in Vbr format. Must be deleted by the caller of this function. Note: This pointer will actually point to a Epetra_CrsMatrix or a Epetra_VbrMatrix. We cast the pointer to a Epetra_RowMatrix because it is the abstract base class used by AztecOO.
x	(Out) A pointer to a Epetra_Vector object containing a shallow copy (view) of az_x. Must be deleted by the caller of this function.
b	(Out) A pointer to a Epetra_Vector object containing a shallow copy (view) of az_b. Must be deleted by the caller of this function.
global_indices	(Out) A pointer to an internally created integer array. If the user matrix is in Vbr format, this array contains a copy of the column index values in global mode. By using this array, we can avoid a deep copy of the user matrix in this case. SPECIAL NOTE: This array must be delete using the special Aztec function as follows: if (global_indices!=0) AZ_free((void *) global_indices);

References Copy, Epetra_CrsMatrix::FillComplete(), Epetra_BlockMap::GlobalIndicesLongLong(), Epetra_CrsMatrix::InsertGlobalValues(), Epetra_RowMatrix::RowMatrixRowMap(), Epetra_Comm::SumAll(), and View.

Referenced by AZOO_iterate().