Detailed Description

Abstract complex matrix class.

Basic class for OFT matices (ex. fem operators)

Inheritance diagram for oft_cmatrix:

[legend]

Public Member Functions
procedure(cmat_add_values), deferred	add_values (self, i_inds, j_inds, b, n, m, iblock, jblock, loc_cache)
	Add values to the matrix.

generic	apply (self, a, b)
	Compute matrix-vector product.

generic	apply (self, a, b)
	Compute matrix-vector product.

procedure(cmat_apply_cvec), deferred	apply_complex (self, a, b)

procedure	apply_real (self, a, b)
	Compute matrix vector product.

generic	applyt (self, a, b)
	Compute matrix-vector product for matrix transpose.

generic	applyt (self, a, b)
	Compute matrix-vector product for matrix transpose.

procedure(cmat_apply_cvec), deferred	applyt_complex (self, a, b)

procedure	applyt_real (self, a, b)
	Apply matrix vector product for matrix transpose.

procedure(cmat_assemble), deferred	assemble (self, diag)
	Complete matrix assembly.

procedure(cmat_add_values), deferred	atomic_add_values (self, i_inds, j_inds, b, n, m, iblock, jblock, loc_cache)
	Add values atomically to the matrix.

procedure	delete (self)
	Delete matrix.

procedure(cmat_set_values), deferred	set_values (self, i_inds, j_inds, b, n, m, iblock, jblock)
	Set values of the matrix.

procedure(cmat_zero), deferred	zero (self)
	Zero all elements.

procedure(cmat_zero_rows), deferred	zero_rows (self, nrows, irows, iblock, keep_diag)
	Zero all elements in a given row.

Public Attributes
class(oft_cvector), pointer	d => NULL()
	Diagonal entries for scaling.

logical	force_local = .FALSE.
	Do not stitch resulting vector (Native ONLY)

type(oft_map), dimension(:), pointer	i_map => NULL()
	Row block mapping.

type(oft_map), dimension(:), pointer	j_map => NULL()
	Column block mapping.

integer(i4)	nc
	Local number of columns.

integer(i8)	ncg
	Gobal number of columns.

integer(i4)	ncslice = 0
	Number of owned columns.

integer(i4)	ni = 0
	Number of row blocks.

integer(i4)	nj = 0
	Number of column blocks.

integer(i4)	nr
	Local number of rows.

integer(i8)	nrg
	Gobal number of rows.

integer(i4)	nrslice = 0
	Number of owned rows.

Member Function/Subroutine Documentation

◆ add_values()

procedure(cmat_add_values), deferred add_values	(	class(oft_cmatrix), intent(inout)	self,
		integer(i4), dimension(n), intent(in)	i_inds,
		integer(i4), dimension(m), intent(in)	j_inds,
		complex(c8), dimension(n,m), intent(in)	b,
		integer(i4), intent(in)	n,
		integer(i4), intent(in)	m,
		integer(i4), intent(in), optional	iblock,
		integer(i4), intent(in), optional	jblock,
		integer(i4), dimension(n,m), intent(inout), optional	loc_cache
	)

pure virtual

Add values to the matrix.

Parameters

[in]	i_inds	Row indices of entries to add [n]
[in]	j_inds	Column indices of entries to add [m]
[in]	b	Values to add [n,m]
[in]	n	Number of rows in local matrix
[in]	m	Number of columns in local matrix
[in]	iblock	Row block (optional)
[in]	jblock	Column block (optional)
[in,out]	loc_cache	Cache of entry locations

◆ apply() [1/2]

generic apply	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

Compute matrix-vector product.

b = self * a

Parameters

[in,out]	self	Matrix object
[in,out]	a	Vector object
[in,out]	b	Result vector

◆ apply() [2/2]

generic apply	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_cvector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

Compute matrix-vector product.

Parameters

[in,out]	a	Source vector
[in,out]	b	Result of matrix product

◆ apply_complex()

procedure(cmat_apply_cvec), deferred apply_complex	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_cvector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

pure virtual

Parameters

[in,out]	a	Source vector
[in,out]	b	Result of matrix product

◆ apply_real()

procedure apply_real	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

Compute matrix vector product.

b = self * a

Parameters

[in,out]	self	Matrix object
[in,out]	a	Vector object
[in,out]	b	Result vector

◆ applyt() [1/2]

generic applyt	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

Compute matrix-vector product for matrix transpose.

b = self^T * a

Parameters

[in,out]	self	Matrix object
[in,out]	a	Vector object
[in,out]	b	Result vector

◆ applyt() [2/2]

generic applyt	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_cvector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

Compute matrix-vector product for matrix transpose.

Parameters

[in,out]	a	Source vector
[in,out]	b	Result of matrix product

◆ applyt_complex()

procedure(cmat_apply_cvec), deferred applyt_complex	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_cvector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

pure virtual

Parameters

[in,out]	a	Source vector
[in,out]	b	Result of matrix product

◆ applyt_real()

procedure applyt_real	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_vector), intent(inout), target	a,
		class(oft_cvector), intent(inout)	b
	)

Apply matrix vector product for matrix transpose.

b = self^T * a

Parameters

[in,out]	self	Matrix object
[in,out]	a	Vector object
[in,out]	b	Result vector

◆ assemble()

procedure(cmat_assemble), deferred assemble	(	class(oft_cmatrix), intent(inout)	self,
		class(oft_cvector), intent(inout), optional, target	diag
	)

pure virtual

Complete matrix assembly.

Parameters

[in,out] diag Diagonal entries of matrix [nr] (optional)

◆ atomic_add_values()

procedure(cmat_add_values), deferred atomic_add_values	(	class(oft_cmatrix), intent(inout)	self,
		integer(i4), dimension(n), intent(in)	i_inds,
		integer(i4), dimension(m), intent(in)	j_inds,
		complex(c8), dimension(n,m), intent(in)	b,
		integer(i4), intent(in)	n,
		integer(i4), intent(in)	m,
		integer(i4), intent(in), optional	iblock,
		integer(i4), intent(in), optional	jblock,
		integer(i4), dimension(n,m), intent(inout), optional	loc_cache
	)

pure virtual

Add values atomically to the matrix.

Parameters

[in]	i_inds	Row indices of entries to add [n]
[in]	j_inds	Column indices of entries to add [m]
[in]	b	Values to add [n,m]
[in]	n	Number of rows in local matrix
[in]	m	Number of columns in local matrix
[in]	iblock	Row block (optional)
[in]	jblock	Column block (optional)
[in,out]	loc_cache	Cache of entry locations

◆ delete()

procedure delete ( class(oft_cmatrix), intent(inout) self )

Delete matrix.

Note: This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized matrices

◆ set_values()

procedure(cmat_set_values), deferred set_values	(	class(oft_cmatrix), intent(inout)	self,
		integer(i4), dimension(n), intent(in)	i_inds,
		integer(i4), dimension(m), intent(in)	j_inds,
		complex(c8), dimension(n,m), intent(in)	b,
		integer(i4), intent(in)	n,
		integer(i4), intent(in)	m,
		integer(i4), intent(in), optional	iblock,
		integer(i4), intent(in), optional	jblock
	)

pure virtual

Set values of the matrix.

Parameters

[in]	i_inds	Row indices of entries to set [n]
[in]	j_inds	Column indices of entries to set [m]
[in]	b	Values to set [n,m]
[in]	n	Number of rows in local matrix
[in]	m	Number of columns in local matrix
[in]	iblock	Row block (optional)
[in]	jblock	Column block (optional)

◆ zero()

procedure(cmat_zero), deferred zero ( class(oft_cmatrix), intent(inout) self )

pure virtual

Zero all elements.

◆ zero_rows()

procedure(cmat_zero_rows), deferred zero_rows	(	class(oft_cmatrix), intent(inout)	self,
		integer(i4), intent(in)	nrows,
		integer(i4), dimension(nrows), intent(in)	irows,
		integer(i4), intent(in), optional	iblock,
		logical, intent(in), optional	keep_diag
	)

pure virtual

Zero all elements in a given row.

Parameters

[in]	nrows	Number of rows to zero
[in]	irows	Indices of rows to zero [nrows]
[in]	iblock	Row block (optional)
[in]	keep_diag	Keep diagonal entries

Member Data Documentation

◆ d

class(oft_cvector), pointer d => NULL()

Diagonal entries for scaling.

◆ force_local

logical force_local = .FALSE.

Do not stitch resulting vector (Native ONLY)

◆ i_map

type(oft_map), dimension(:), pointer i_map => NULL()

Row block mapping.

◆ j_map

type(oft_map), dimension(:), pointer j_map => NULL()

Column block mapping.

◆ nc

integer(i4) nc

Local number of columns.

◆ ncg

integer(i8) ncg

Gobal number of columns.

◆ ncslice

integer(i4) ncslice = 0

Number of owned columns.

◆ ni

integer(i4) ni = 0

Number of row blocks.

◆ nj

integer(i4) nj = 0

Number of column blocks.

◆ nr

integer(i4) nr

Local number of rows.

◆ nrg

integer(i8) nrg

Gobal number of rows.

◆ nrslice

integer(i4) nrslice = 0

Number of owned rows.

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

/home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/lin_alg/lin_alg_base.F90

Detailed Description

Public Member Functions

Public Attributes

Member Function/Subroutine Documentation

◆ add_values()

◆ apply() [1/2]

◆ apply() [2/2]

◆ apply_complex()

◆ apply_real()

◆ applyt() [1/2]

◆ applyt() [2/2]

◆ applyt_complex()

◆ applyt_real()

◆ assemble()

◆ atomic_add_values()

◆ delete()

◆ set_values()

◆ zero()

◆ zero_rows()

Member Data Documentation

◆ d

◆ force_local

◆ i_map

◆ j_map

◆ nc

◆ ncg

◆ ncslice

◆ ni

◆ nj

◆ nr

◆ nrg

◆ nrslice