EpetraExt_MultiVectorOut.cpp File Reference

#include "EpetraExt_MultiVectorOut.h"
#include "EpetraExt_mmio.h"
#include "Epetra_Comm.h"
#include "Epetra_BlockMap.h"
#include "Epetra_Map.h"
#include "Epetra_Vector.h"
#include "Epetra_IntVector.h"
#include "Epetra_SerialDenseVector.h"
#include "Epetra_IntSerialDenseVector.h"
#include "Epetra_Import.h"
#include "Epetra_CrsMatrix.h"

Include dependency graph for EpetraExt_MultiVectorOut.cpp:

Go to the source code of this file.

Namespaces

namespace  EpetraExt

Functions

int MultiVectorToMatlabFile (const char *filename, const Epetra_MultiVector &A)
 Writes an Epetra_MultiVector object to a file that is compatible with Matlab.
int MultiVectorToMatrixMarketFile (const char *filename, const Epetra_MultiVector &A, const char *matrixName, const char *matrixDescription, bool writeHeader)
 Writes an Epetra_MultiVector object to a Matrix Market format file.
int MultiVectorToMatlabHandle (FILE *handle, const Epetra_MultiVector &A)
 Writes an Epetra_MultiVector object that is compatible with Matlab to a file handle.
int MultiVectorToMatrixMarketHandle (FILE *handle, const Epetra_MultiVector &A)
 Writes an Epetra_MultiVector object that is compatible with Matrix Market array format to a file handle.
int MultiVectorToHandle (FILE *handle, const Epetra_MultiVector &A, bool mmFormat)
int writeMultiVector (FILE *handle, const Epetra_MultiVector &A, bool mmFormat)


Function Documentation

int EpetraExt::MultiVectorToMatlabFile const char *  filename,
const Epetra_MultiVector A
 

Writes an Epetra_MultiVector object to a file that is compatible with Matlab.

This function takes any matrix that implements the Epetra_MultiVector interface and writes it to the specified file. The matrix can be distributed or serial. This function is a convenience wrapper around MultiVectorToMatrixMarketFile. The following Matlab commands can be used to read the resulting file and convert to it to a Matlab sparse matrix:

  1. load filename;
For example:
  1. load A.dat;
The above produces a dense matrix A with each vector in the multivector as a column in A.

Parameters:
filename (In) A filename, including path if desired. If a file with this name already exists, it will be deleted. On exit, this file will contain a row for each row of the multivector.
A (In) An Epetra_MultiVector Object containing the user matrix to be dumped to file.
Returns:
Returns 0 if no error, -1 if any problems with file system.

Definition at line 43 of file EpetraExt_MultiVectorOut.cpp.

int EpetraExt::MultiVectorToMatrixMarketFile const char *  filename,
const Epetra_MultiVector A,
const char *  matrixName = 0,
const char *  matrixDescription = 0,
bool  writeHeader = true
 

Writes an Epetra_MultiVector object to a Matrix Market format file.

This function takes an Epetra_MultiVector object and writes it to the specified file. The multivector can be distributed or serial. The user can provide a strings containing the object name, a description, and specify that header information should or should not be printed to the file.

Parameters:
filename (In) A filename, including path if desired. If a file with this name already exists, it will be deleted. On exit, this file will contained any requested header information followed by the matrix coefficients. The file will contain a row for each entry. All entries for a column are listed before going to the next column.
A (In) An Epetra_MultiVector Object containing the user matrix to be dumped to file.
matrixName (In) A C-style string pointer to a name that will be stored in the comment field of the file. This is not a required argument. Note that it is possible to pass in the method A.Label().
matrixDescription (In) A C-style string pointer to a matrix description that will be stored in the comment field of the file.
writeHeader (In) If true, the header will be written, otherwise only the matrix entries will be written.
Returns:
Returns 0 if no error, -1 if any problems with file system.

Definition at line 57 of file EpetraExt_MultiVectorOut.cpp.

int EpetraExt::MultiVectorToMatlabHandle FILE *  handle,
const Epetra_MultiVector A
 

Writes an Epetra_MultiVector object that is compatible with Matlab to a file handle.

This function takes an Epetra_MultiVector and writes it to the specified file handle.

Parameters:
handle (In) A C-style file handle, already opened. On exit, the file associated with this handle will have appended to it a row for each multivector row.
A (In) An Epetra_MultiVector Object containing the user object to be dumped to file.
Returns:
Returns 0 if no error, -1 if any problems with file system.

Definition at line 94 of file EpetraExt_MultiVectorOut.cpp.

int EpetraExt::MultiVectorToMatrixMarketHandle FILE *  handle,
const Epetra_MultiVector A
 

Writes an Epetra_MultiVector object that is compatible with Matrix Market array format to a file handle.

This function takes an Epetra_MultiVector and writes it to the specified file handle.

Parameters:
handle (In) A C-style file handle, already opened. On exit, the file associated with this handle will have appended to it a row for each multivector row.
A (In) An Epetra_MultiVector Object containing the user object to be dumped to file.
Returns:
Returns 0 if no error, -1 if any problems with file system.

Definition at line 97 of file EpetraExt_MultiVectorOut.cpp.

int EpetraExt::MultiVectorToHandle FILE *  handle,
const Epetra_MultiVector A,
bool  mmFormat
 

Definition at line 100 of file EpetraExt_MultiVectorOut.cpp.

int EpetraExt::writeMultiVector FILE *  handle,
const Epetra_MultiVector A,
bool  mmFormat
 

Definition at line 167 of file EpetraExt_MultiVectorOut.cpp.


Generated on Thu Sep 18 12:31:45 2008 for EpetraExt by doxygen 1.3.9.1