DICe::MultiField_Matrix Class Reference

A container class for a CrsMatrix. More...

#include <DICe_MultiFieldEpetra.h>

Public Member Functions
	MultiField_Matrix (const MultiField_Map &row_map, const int_t num_entries_per_row)
	Default constructor.
	MultiField_Matrix (const MultiField_Map &row_map, const MultiField_Map &col_map, const int_t num_entries_per_row)
	Constructor with a column map.
	~MultiField_Matrix ()
	Destructor.
Teuchos::RCP< Epetra_CrsMatrix >	get ()
	Return the underlying matrix.
int_t	num_local_rows ()
	get the number of rows
void	put_scalar (const mv_scalar_type &value)
void	insert_global_values (const int_t global_row, const Teuchos::ArrayView< const int_t > &cols, const Teuchos::ArrayView< const mv_scalar_type > &vals)
void	replace_local_values (const int_t local_row, const Teuchos::ArrayView< const int_t > &cols, const Teuchos::ArrayView< const mv_scalar_type > &vals)
void	describe () const
	Print the matrix to the screen.
void	fill_complete ()
	Finish assembling the matrix.
void	resume_fill ()
	Finish assembling the matrix.
void	do_export (Teuchos::RCP< MultiField_Matrix > multifield_matrix, MultiField_Exporter &exporter, const Combine_Mode mode=INSERT)
	export the data from one distributed object to this one More...
	MultiField_Matrix (const MultiField_Map &row_map, const int_t num_entries_per_row)
	Default constructor.
	MultiField_Matrix (const MultiField_Map &row_map, const MultiField_Map &col_map, const int_t num_entries_per_row)
	Constructor with a column map.
	~MultiField_Matrix ()
	Destructor.
Teuchos::RCP< matrix_type >	get ()
	Return the underlying matrix.
int_t	num_local_rows ()
	get the number of rows
void	put_scalar (const scalar_t &value)
void	insert_global_values (const int_t global_row, const Teuchos::ArrayView< const int_t > &cols, const Teuchos::ArrayView< const scalar_t > &vals)
void	replace_local_values (const int_t local_row, const Teuchos::ArrayView< const int_t > &cols, const Teuchos::ArrayView< const scalar_t > &vals)
void	describe () const
	Print the matrix to the screen.
void	fill_complete ()
	Finish assembling the matrix.
void	resume_fill ()
	Finish assembling the matrix.
void	do_export (Teuchos::RCP< MultiField_Matrix > multifield_matrix, MultiField_Exporter &exporter, const Combine_Mode mode=INSERT)
	export the data from one distributed object to this one More...

Private Attributes
Teuchos::RCP< Epetra_CrsMatrix >	matrix_
	The underlying crs matrix.
Teuchos::RCP< matrix_type >	matrix_
	The underlying crs matrix.

Detailed Description

A container class for a CrsMatrix.

Member Function Documentation

do_export() [1/2]

void DICe::MultiField_Matrix::do_export ( Teuchos::RCP< MultiField_Matrix >  multifield_matrix, MultiField_Exporter &  exporter, const Combine_Mode  mode = INSERT  )

inline

export the data from one distributed object to this one

Parameters

multifield_matrix	the multifield to export
exporter	the exporter defines how the information will be transferred
mode	combine mode

do_export() [2/2]

void DICe::MultiField_Matrix::do_export ( Teuchos::RCP< MultiField_Matrix >  multifield_matrix, MultiField_Exporter &  exporter, const Combine_Mode  mode = INSERT  )

inline

export the data from one distributed object to this one

Parameters

multifield_matrix	the multifield to export
exporter	the exporter defines how the information will be transferred
mode	combine mode

insert_global_values() [1/2]

void DICe::MultiField_Matrix::insert_global_values ( const int_t  global_row, const Teuchos::ArrayView< const int_t > &  cols, const Teuchos::ArrayView< const mv_scalar_type > &  vals  )

inline

Insert values into the global indices given

Parameters

global_row	The global id of the row to insert
cols	An array of global column ids
vals	An array of real values to insert

insert_global_values() [2/2]

void DICe::MultiField_Matrix::insert_global_values ( const int_t  global_row, const Teuchos::ArrayView< const int_t > &  cols, const Teuchos::ArrayView< const scalar_t > &  vals  )

inline

Insert values into the global indices given

Parameters

global_row	The global id of the row to insert
cols	An array of global column ids
vals	An array of real values to insert

put_scalar() [1/2]

void DICe::MultiField_Matrix::put_scalar ( const mv_scalar_type &  value )

inline

Put scalar value in all matrix entries

Parameters

value

The value to insert

put_scalar() [2/2]

void DICe::MultiField_Matrix::put_scalar ( const scalar_t &  value )

inline

Put scalar value in all matrix entries

Parameters

value

The value to insert

replace_local_values() [1/2]

void DICe::MultiField_Matrix::replace_local_values ( const int_t  local_row, const Teuchos::ArrayView< const int_t > &  cols, const Teuchos::ArrayView< const mv_scalar_type > &  vals  )

inline

Replace values in the local indices given

Parameters

local_row	The local id of the row to insert
cols	An array of local column ids
vals	An array of real values to insert

replace_local_values() [2/2]

void DICe::MultiField_Matrix::replace_local_values ( const int_t  local_row, const Teuchos::ArrayView< const int_t > &  cols, const Teuchos::ArrayView< const scalar_t > &  vals  )

inline

Replace values in the local indices given

Parameters

local_row	The local id of the row to insert
cols	An array of local column ids
vals	An array of real values to insert