num_utilities::conv_mat Interface Reference

Converts a (symmetric) matrix A with the storage convention described in eq_vars.eq_2_type. More...

Public Member Functions
integer function	conv_mat_3d (A, B, n, transp)
	version defined on 3-D grid More...
integer function	conv_mat_3d_complex (A, B, n, transp)
	complex version defined on 3D grid More...
integer function	conv_mat_0d (A, B, n, transp)
	scalar version More...
integer function	conv_mat_0d_complex (A, B, n, transp)
	complex scalar version More...

Detailed Description

Converts a (symmetric) matrix A with the storage convention described in eq_vars.eq_2_type.

This matric can have elements depending on a 3-D grid or be constant.

• If the matrix is stored with n^2 numbers, only the lower diagonal elements are kept in matrix B.
• If only the lower diagonal elements are stored, they are copied to the upper diagonal ones of the matrix B as well.

Optionally, the transpose can be calculated.

Note

1. The routine does not check whether the matrix is indeed symmetric and that information may thus be lost after conversion.
2. This routine makes a copy of A so that by providing A as input argument for both A and B overwrites A.

Returns

ierr

Definition at line 123 of file num_utilities.f90.

Member Function/Subroutine Documentation

conv_mat_0d()

integer function num_utilities::conv_mat::conv_mat_0d	(	real(dp), dimension(:), intent(in)	A,
		real(dp), dimension(:), intent(inout)	B,
		integer, intent(in)	n,
		logical, intent(in), optional	transp
	)

scalar version

Parameters

[in]	a	matrix to be converted
[in,out]	b	converted matrix
[in]	n	size of matrix
[in]	transp	transpose

Definition at line 1084 of file num_utilities.f90.

conv_mat_0d_complex()

integer function num_utilities::conv_mat::conv_mat_0d_complex	(	complex(dp), dimension(:), intent(in)	A,
		complex(dp), dimension(:), intent(inout)	B,
		integer, intent(in)	n,
		logical, intent(in), optional	transp
	)

complex scalar version

Parameters

[in]	a	matrix to be converted
[in,out]	b	converted matrix
[in]	n	size of matrix
[in]	transp	transpose

Definition at line 1179 of file num_utilities.f90.

conv_mat_3d()

integer function num_utilities::conv_mat::conv_mat_3d	(	real(dp), dimension(:,:,:,:), intent(in)	A,
		real(dp), dimension(:,:,:,:), intent(inout)	B,
		integer, intent(in)	n,
		logical, intent(in), optional	transp
	)

version defined on 3-D grid

Parameters

[in]	a	matrix to be converted
[in,out]	b	converted matrix
[in]	n	size of matrix
[in]	transp	transpose

Definition at line 1015 of file num_utilities.f90.

Here is the call graph for this function:

conv_mat_3d_complex()

integer function num_utilities::conv_mat::conv_mat_3d_complex	(	complex(dp), dimension(:,:,:,:), intent(in)	A,
		complex(dp), dimension(:,:,:,:), intent(inout)	B,
		integer, intent(in)	n,
		logical, intent(in), optional	transp
	)

complex version defined on 3D grid

Parameters

[in]	a	matrix to be converted
[in,out]	b	converted matrix
[in]	n	size of matrix
[in]	transp	transpose

Definition at line 1110 of file num_utilities.f90.

Here is the call graph for this function:

---

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

• /opt/PB3D/Modules/num_utilities.f90