matrixelement_module Module Reference

Matrix element module. More...

Data Types
type	matrixelementvector
	This handles the matrix elements and also expands the vector size if we have reached max capacity. More...

Functions/Subroutines
subroutine	check_constructed (this)
	Check that type is constructed. More...
subroutine	construct_mat_standard (this)
	Construct the type. More...
subroutine	initialize_struct_standard (this, matrix_size, matrix_type, block_size)
	Initialize the type. More...
subroutine	insert_matelem_standard (this, i, j, coefficient, class, thresh)
	Insert a new element. More...
subroutine	get_matelem_standard (this, idx, i, j, coeff)
	Retrieve element. More...
subroutine	expand_standard (this, capacity)
	Retrieve element. More...
subroutine	clear_standard (this)
	Clear elements. More...
subroutine	sort_matelem (this)
	Sort elements. More...
subroutine	destroy_standard (this)
	Destroy elements. More...

Detailed Description

Matrix element module.

Authors

A Al-Refaie

Date

2017

Note

16/01/2019 - Jakub Benda: Unifom coding style and expanded documentation.

Function/Subroutine Documentation

check_constructed()

subroutine matrixelement_module::check_constructed ( class(matrixelementvector)  this )

private

Check that type is constructed.

Authors

A Al-Refaie

Date

2017

Checks if the type is constructed and hard aborts when not.

Definition at line 69 of file MatrixElement_module.f90.

clear_standard()

subroutine matrixelement_module::clear_standard ( class(matrixelementvector)  this )

private

Clear elements.

Authors

A Al-Refaie

Date

2017

Definition at line 163 of file MatrixElement_module.f90.

construct_mat_standard()

subroutine matrixelement_module::construct_mat_standard ( class(matrixelementvector)  this )

private

Construct the type.

Authors

A Al-Refaie

Date

2017

Definition at line 84 of file MatrixElement_module.f90.

destroy_standard()

subroutine matrixelement_module::destroy_standard ( class(matrixelementvector)  this )

private

Destroy elements.

Authors

A Al-Refaie

Date

2017

Definition at line 195 of file MatrixElement_module.f90.

expand_standard()

subroutine matrixelement_module::expand_standard ( class(matrixelementvector)  this, integer, intent(in)  capacity  )

private

Retrieve element.

Authors

A Al-Refaie

Date

2017

Definition at line 148 of file MatrixElement_module.f90.

get_matelem_standard()

subroutine matrixelement_module::get_matelem_standard ( class(matrixelementvector)  this, integer, intent(in)  idx, integer, intent(out)  i, integer, intent(out)  j, real(wp), intent(out)  coeff  )

private

Retrieve element.

Authors

A Al-Refaie

Date

2017

Definition at line 133 of file MatrixElement_module.f90.

initialize_struct_standard()

subroutine matrixelement_module::initialize_struct_standard ( class(matrixelementvector)  this, integer, intent(in)  matrix_size, integer, intent(in)  matrix_type, integer, intent(in)  block_size  )

private

Initialize the type.

Authors

A Al-Refaie

Date

2017

Definition at line 99 of file MatrixElement_module.f90.

insert_matelem_standard()

subroutine matrixelement_module::insert_matelem_standard ( class(matrixelementvector)  this, integer, intent(in)  i, integer, intent(in)  j, real(wp), intent(in)  coefficient, integer, intent(in)  class, real(wp), intent(in)  thresh  )

private

Insert a new element.

Authors

A Al-Refaie

Date

2017

Definition at line 114 of file MatrixElement_module.f90.

sort_matelem()

subroutine matrixelement_module::sort_matelem ( class(matrixelementvector)  this )

private

Sort elements.

Authors

A Al-Refaie

Date

2017

Definition at line 183 of file MatrixElement_module.f90.