qs_fb_matrix_data_types Module Reference

Data Types
type	fb_matrix_data_obj
	the object container which allows for the creation of an array of pointers to fb_matrix_data objects More...

Functions/Subroutines
subroutine, public	fb_matrix_data_add (matrix_data, row, col, blk)
	Add a matrix block to a fb_matrix_data object.
subroutine, public	fb_matrix_data_create (matrix_data, nmax, nencode)
	Creates and initialises an empty fb_matrix_data object of a given size.
subroutine, public	fb_matrix_data_get (matrix_data, row, col, blk_p, found)
	retrieve a matrix block from a matrix_data object
pure logical function, public	fb_matrix_data_has_data (matrix_data)
	check if the object has data associated to it
pure subroutine, public	fb_matrix_data_nullify (matrix_data)
	Nullifies a fb_matrix_data object.
subroutine, public	fb_matrix_data_release (matrix_data)
	releases given object

Function/Subroutine Documentation

fb_matrix_data_add()

subroutine, public qs_fb_matrix_data_types::fb_matrix_data_add	(	type(fb_matrix_data_obj), intent(inout)	matrix_data,
		integer, intent(in)	row,
		integer, intent(in)	col,
		real(kind=dp), dimension(:, :), intent(in)	blk
	)

Add a matrix block to a fb_matrix_data object.

Parameters

matrix_data	: the fb_matrix_data object
row	: block row index of the matrix block
col	: block col index of the matrix block
blk	: the matrix block to add

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 91 of file qs_fb_matrix_data_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fb_matrix_data_create()

subroutine, public qs_fb_matrix_data_types::fb_matrix_data_create	(	type(fb_matrix_data_obj), intent(out)	matrix_data,
		integer, intent(in)	nmax,
		integer, intent(in)	nencode
	)

Creates and initialises an empty fb_matrix_data object of a given size.

Parameters

matrix_data	: the fb_matrix_data object, its content must be NULL and cannot be UNDEFINED
nmax	: max number of matrix blks can be stored
nencode	...

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 152 of file qs_fb_matrix_data_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fb_matrix_data_get()

subroutine, public qs_fb_matrix_data_types::fb_matrix_data_get	(	type(fb_matrix_data_obj), intent(in)	matrix_data,
		integer, intent(in)	row,
		integer, intent(in)	col,
		real(kind=dp), dimension(:, :), pointer	blk_p,
		logical, intent(out)	found
	)

retrieve a matrix block from a matrix_data object

Parameters

matrix_data	: the fb_matrix_data object
row	: row index
col	: col index
blk_p	: pointer to the block in the fb_matrix_data object
found	: if the requested block exists in the fb_matrix_data object

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 180 of file qs_fb_matrix_data_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fb_matrix_data_has_data()

pure logical function, public qs_fb_matrix_data_types::fb_matrix_data_has_data

(

type(fb_matrix_data_obj), intent(in)

matrix_data

)

check if the object has data associated to it

Parameters

matrix_data

: the fb_matrix_data object in question

Returns

: true if matrix_dataobj is associated, false otherwise

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 210 of file qs_fb_matrix_data_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fb_matrix_data_nullify()

pure subroutine, public qs_fb_matrix_data_types::fb_matrix_data_nullify

(

type(fb_matrix_data_obj), intent(inout)

matrix_data

)

Nullifies a fb_matrix_data object.

Parameters

matrix_data

: the fb_matrix_data object

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 260 of file qs_fb_matrix_data_types.F.

Here is the caller graph for this function:

fb_matrix_data_release()

subroutine, public qs_fb_matrix_data_types::fb_matrix_data_release

(

type(fb_matrix_data_obj), intent(inout)

matrix_data

)

releases given object

Parameters

matrix_data

: the fb_matrix_data object in question

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 271 of file qs_fb_matrix_data_types.F.

Here is the call graph for this function:

Here is the caller graph for this function: