EpetraExt_VectorOut.cpp File Reference

#include "EpetraExt_VectorOut.h"
#include "EpetraExt_MultiVectorOut.h"
#include "EpetraExt_mmio.h"
#include "Epetra_Comm.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_VectorOut.cpp:

Go to the source code of this file.

Namespaces

namespace  EpetraExt

Functions

int VectorToMatlabFile (const char *filename, const Epetra_Vector &A)
 Writes an Epetra_Vector object to a file that is compatible with Matlab.
int VectorToMatrixMarketFile (const char *filename, const Epetra_Vector &A, const char *matrixName, const char *matrixDescription, bool writeHeader)
 Writes an Epetra_Vector object to a Matrix Market format file.
int VectorToHandle (FILE *handle, const Epetra_Vector &A)
 Writes an Epetra_Vector object to a format file that is compatible with Matlab.
int writeVector (FILE *handle, const Epetra_Vector &A)


Function Documentation

int EpetraExt::VectorToMatlabFile const char *  filename,
const Epetra_Vector A
 

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

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

  1. load filename;
  2. matrix_name = spconvert(filename_root);
For example:
  1. load A.dat;
  2. A = spconvert(filename_root);
The above produces a sparse matrix 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 matrix entry The first column is the global row index, using base 1, the second column is the global column index of the entry, the third value is the matrix value for that entry.
A (In) An Epetra_Vector Object containing the user matrix to be dumped to file. Any object that implements the Epetra_Vector interface can be passed in. In particular, the Epetra_CrsMatrix, Epetra_VbrMatrix, Epetra_FECrsMatrix, Epetra_FEVbrMatrix and Epetra_MsrMatrix classes are compatible with this interface.
Returns:
Returns 0 if no error, -1 if any problems with file system.

Definition at line 44 of file EpetraExt_VectorOut.cpp.

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

Writes an Epetra_Vector object to a Matrix Market format file.

This function takes any matrix that implements the Epetra_Vector interface and writes it to the specified file. The matrix can be distributed or serial. The user can provide a strings containing the matrix name, a matrix 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 matrix entry The first column is the global row index, using base 1, the second column is the global column index of the entry, the third value is the matrix value for that entry.
A (In) An Epetra_Vector Object containing the user matrix to be dumped to file. Any object that implements the Epetra_Vector interface can be passed in. In particular, the Epetra_CrsMatrix, Epetra_VbrMatrix, Epetra_FECrsMatrix, Epetra_FEVbrMatrix and Epetra_MsrMatrix classes are compatible with this interface.
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() if the matrix is one of the four types: Epetra_CrsMatrix, Epetra_VbrMatrix, Epetra_FECrsMatrix, Epetra_FEVbrMatrix.
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 48 of file EpetraExt_VectorOut.cpp.

int EpetraExt::VectorToHandle FILE *  handle,
const Epetra_Vector A
 

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

This function takes any matrix that implements the Epetra_Vector interface and writes it to the specified file handle. The matrix can be distributed or serial. This function is a convenience wrapper around VectorToMatrixMarketFile.

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 matrix entry The first column is the global row index, using base 1, the second column is the global column index of the entry, the third value is the matrix value for that entry.
A (In) An Epetra_Vector Object containing the user matrix to be dumped to file. Any object that implements the Epetra_Vector interface can be passed in. In particular, the Epetra_CrsMatrix, Epetra_VbrMatrix, Epetra_FECrsMatrix, Epetra_FEVbrMatrix and Epetra_MsrMatrix classes are compatible with this interface.
Returns:
Returns 0 if no error, -1 if any problems with file system.

Definition at line 55 of file EpetraExt_VectorOut.cpp.

int EpetraExt::writeVector FILE *  handle,
const Epetra_Vector A
 

Definition at line 59 of file EpetraExt_VectorOut.cpp.


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