EpetraMatrix Class Reference

#include <epetra.h>

Inherits SparseMatrix.

List of all members.

Public Member Functions
	EpetraMatrix ()
virtual	~EpetraMatrix ()
virtual void	prealloc (int n)
	prepare memory
virtual void	pre_add_ij (int row, int col)
	add indices of nonzero matrix element
virtual void	finish ()
virtual void	alloc ()
	allocate the memory for stiffness matrix and right-hand side
virtual void	free ()
	free the memory associated with stiffness matrix and right-hand side
virtual scalar	get (int m, int n)
	Get the value from a position.
virtual int	get_num_row_entries (int row)
	Return the number of entries in a specified row.
virtual void	extract_row_copy (int row, int len, int &n_entries, double *vals, int *idxs)
	Extract the copy of a row.
virtual void	zero ()
	Zero the matrix.
virtual void	add (int m, int n, scalar v)
	update the stiffness matrix
virtual void	add (int m, int n, scalar **mat, int *rows, int *cols)
	update the stiffness matrix
virtual bool	dump (FILE *file, const char *var_name, EMatrixDumpFormat fmt=DF_MATLAB_SPARSE)
	dumping matrix and right-hand side
virtual int	get_matrix_size () const
virtual double	get_fill_in () const
Friends
class	AmesosSolver
class	AztecOOSolver
class	NoxSolver
class	IfpackPrecond
class	MlPrecond

---

Constructor & Destructor Documentation

EpetraMatrix::EpetraMatrix

(

)

EpetraMatrix::~EpetraMatrix

(

)

[virtual]

---

Member Function Documentation

void EpetraMatrix::add	(	int	m,
		int	n,
		scalar **	mat,
		int *	rows,
		int *	cols
	)			[virtual]

update the stiffness matrix

Parameters:

[in]	m	- number of rows of given block
[in]	n	- number of columns of given block
[in]	matrix	- block of values
[in]	rows	- array with row indexes
[in]	cols	- array with column indexes

Implements Matrix.

void EpetraMatrix::add	(	int	m,
		int	n,
		scalar	v
	)			[virtual]

update the stiffness matrix

Parameters:

[in]	m	- the row where to update
[in]	n	- the column where to update
[in]	v	- value

Implements Matrix.

void EpetraMatrix::alloc

(

)

[virtual]

allocate the memory for stiffness matrix and right-hand side

Implements Matrix.

bool EpetraMatrix::dump	(	FILE *	file,
		const char *	var_name,
		EMatrixDumpFormat	fmt = DF_MATLAB_SPARSE
	)			[virtual]

dumping matrix and right-hand side

Implements Matrix.

void EpetraMatrix::extract_row_copy	(	int	row,
		int	len,
		int &	n_entries,
		double *	vals,
		int *	idxs
	)			[virtual]

Extract the copy of a row.

Parameters:

[in]	row	- global row to extract
[in]	len	- length of 'vals' and 'idxs' arrays.
[out]	n_entries	- number of nonzero entries extracted.
[out]	vals	- extracted values for this row.
[out]	idxs	- extracted global column indices for the corresponding values.

Reimplemented from SparseMatrix.

void EpetraMatrix::finish

(

)

[virtual]

Reimplemented from SparseMatrix.

void EpetraMatrix::free

(

)

[virtual]

free the memory associated with stiffness matrix and right-hand side

Implements Matrix.

scalar EpetraMatrix::get	(	int	m,
		int	n
	)			[virtual]

Get the value from a position.

Returns:

the value from the specified position

Parameters:

[in]	m	- the number of row
[in]	n	- the number of column

Implements Matrix.

double EpetraMatrix::get_fill_in

(

)

const [virtual]

Implements SparseMatrix.

int EpetraMatrix::get_matrix_size

(

)

const [virtual]

Implements Matrix.

int EpetraMatrix::get_num_row_entries

(

int

row

)

[virtual]

Return the number of entries in a specified row.

Parameters:

[in]

row

- index of the row

Returns:

- the number of entries in the row 'row'

Reimplemented from SparseMatrix.

void EpetraMatrix::pre_add_ij	(	int	row,
		int	col
	)			[virtual]

add indices of nonzero matrix element

Parameters:

[in]	row	- row index
[in]	col	- column index

Reimplemented from SparseMatrix.

void EpetraMatrix::prealloc

(

int

n

)

[virtual]

prepare memory

Parameters:

[in]

ndofs

- number of unknowns

Reimplemented from SparseMatrix.

void EpetraMatrix::zero

(

)

[virtual]

Zero the matrix.

Implements Matrix.

---

Friends And Related Function Documentation

friend class AmesosSolver [friend]

friend class AztecOOSolver [friend]

friend class IfpackPrecond [friend]

friend class MlPrecond [friend]

friend class NoxSolver [friend]

---

The documentation for this class was generated from the following files:

• epetra.h
• epetra.cpp