class_CSRMAT Module Reference

Data type to store a CSR matrix. More...

List of all members.

Data Types
interface	assignment(=)
type	CSRMAT
	matrix stored in CSR format More...
Public Member Functions
integer function, public	new_CSRCOEF (CSRMAT_inout)
	Allocates the CSR matrix coefficients.
integer function, public	dlt_CSRCOEF (CSRMAT_inout)
	Deallocates the CSR matrix coefficients.
integer function, public	new_CSRMAT (nrows, nterm, CSRMAT_inout)
	Allocates the CSR matrix data structure.
integer function, public	dlt_CSRMAT (CSRMAT_inout)
	Deallocates the CSR matrix data structure.
subroutine, public	copy_CSRMAT (mat_out, mat_in)
	Copy a CSR matrix data structure.
subroutine, public	errchk_CSRMAT (ounit, sub, ierr)
	Error handling routine.

---

Detailed Description

Data type to store a CSR matrix.

This module is used to define the Compact Sparse Row (CSR) data type for matrices storage (see Y. Saad -- Iterative Methods for Sparse Linear Systems)

Author:

Carlo Janna

Version:

1.0

Date:

January 2013

License:

This program is intended for internal research only and can not be distributed elsewhere without authors' consent.

---

Member Function/Subroutine Documentation

subroutine, public class_CSRMAT::copy_CSRMAT	(	type(CSRMAT), intent(inout)	mat_out,
		type(CSRMAT), intent(in)	mat_in
	)

Copy a CSR matrix data structure.

Author:

Carlo Janna

Parameters:

[in]	mat_in	CSRMAT variable
	inout]	mat_out CSRMAT variable

Version:

1.0

Date:

January 2013

integer function, public class_CSRMAT::dlt_CSRCOEF

(

type(CSRMAT), intent(inout)

CSRMAT_inout

)

Deallocates the CSR matrix coefficients.

Author:

Carlo Janna

Version:

1.0

Date:

January 2013

integer function, public class_CSRMAT::dlt_CSRMAT

(

type(CSRMAT), intent(inout)

CSRMAT_inout

)

Deallocates the CSR matrix data structure.

Author:

Carlo Janna

Version:

1.0

Date:

January 2013

subroutine, public class_CSRMAT::errchk_CSRMAT	(	integer, intent(in)	ounit,
		character*(*), intent(in)	sub,
		integer, intent(in)	ierr
	)

Error handling routine.

Author:

Carlo Janna

Version:

1.0

Date:

January 2013

integer function, public class_CSRMAT::new_CSRCOEF

(

type(CSRMAT), intent(inout)

CSRMAT_inout

)

Allocates the CSR matrix coefficients.

Author:

Carlo Janna

Version:

1.0

Date:

January 2013

integer function, public class_CSRMAT::new_CSRMAT	(	integer, intent(in)	nrows,
		integer, intent(in)	nterm,
		type(CSRMAT), intent(inout)	CSRMAT_inout
	)

Allocates the CSR matrix data structure.

Author:

Carlo Janna

Parameters:

[in]	nrows	# of rows
[in]	nterm	# of non zeroes
	inout]	mat_inout CSRMAT variable
[out]	ierr	error code
	==	0, successful allocation
	/=	0, allocation error

Version:

1.0

Date:

January 2013

---

The documentation for this module was generated from the following file:

• B_CSRMAT.f90