dl_mg_info Module Reference

Subroutines for logs; also it stores the solver version. More...

Data Types
type	solver_status_t
type	defco_status_t

Functions/Subroutines
subroutine, public	mg_info_init (report_file_)
subroutine, public	mg_info_set (status, iter, resnorm, res_ratio, solnorm, tol, maxiter, eq_tag)
subroutine, public	mg_info_write (eq_type)
subroutine, public	write_comms_structure (mg)
subroutine, public	write_nonlinear_params (eq_type, n, c, q, temp, lam)
subroutine, public	mg_info_iteration_details (test_tag, level, iter, resnorm, vecnorm, tol)
	this won't write level 1 data if not active More...
subroutine, public	charge_neutrality_report (fixed, ions, obc_deviation, myid)
subroutine, public	charge_neutralisation_info
subroutine, public	accumulate_residual_ratio (eq_tag, iter, resnorm, potnorm, ratio, dmu)
subroutine, public	get_version (vs)
real(wp) function, public	info_get_res_norm (key)

Variables
character(len= *), parameter	version_string ="4.2.0 (17/10/2023)"
integer, parameter, public	info_newton_tag =222
integer, parameter, public	info_mg_tag =555
integer, parameter, public	info_cg_tag =777
type(solver_status_t), target	mg_status
type(solver_status_t), target, public	newton_status
type(solver_status_t), target	cg_status
type(defco_status_t), public	defco_status
logical, save, public	debug_write =.false.
logical, save, public	initialised_info = .false.
logical, save	collect_res_hist = .false.
logical, save	enables
logical, save	residual
logical, save	ratio
logical, save	histogram
logical, save	print_iter_info = .true.
logical, save	if
logical, save	true
logical, save	prints
logical, save	and
logical, save	solution
logical, save	norms
logical, save	at
logical, save	each
logical, save	iteration

Detailed Description

Subroutines for logs; also it stores the solver version.

Function/Subroutine Documentation

accumulate_residual_ratio()

subroutine, public dl_mg_info::accumulate_residual_ratio	(	integer, intent(in)	eq_tag,
		integer, intent(in)	iter,
		real(wp), intent(in)	resnorm,
		real(wp), intent(in)	potnorm,
		real(wp), intent(in)	ratio,
		real(wp), intent(in)	dmu
	)

Parameters

[in]

dmu

max( abs(mu - mu_prev))

charge_neutralisation_info()

subroutine, public dl_mg_info::charge_neutralisation_info

charge_neutrality_report()

subroutine, public dl_mg_info::charge_neutrality_report	(	real(wp), dimension(:), intent(in)	fixed,
		real(wp), dimension(:), intent(in)	ions,
		real(wp), dimension(:), intent(in)	obc_deviation,
		integer, intent(in), optional	myid
	)

get_version()

subroutine, public dl_mg_info::get_version

(

character(len=dl_mg_version_string_length), intent(out)

vs

)

info_get_res_norm()

real(wp) function, public dl_mg_info::info_get_res_norm

(

character(len=*), intent(in)

key

)

mg_info_init()

subroutine, public dl_mg_info::mg_info_init

(

character(len=*)

report_file_

)

mg_info_iteration_details()

subroutine, public dl_mg_info::mg_info_iteration_details	(	integer, intent(in)	test_tag,
		integer, intent(in)	level,
		integer, intent(in)	iter,
		real(kind(0.d0)), intent(in)	resnorm,
		real(kind(0.d0)), intent(in)	vecnorm,
		real(kind(0.d0)), intent(in)	tol
	)

this won't write level 1 data if not active

mg_info_set()

subroutine, public dl_mg_info::mg_info_set	(	integer, intent(in)	status,
		integer, intent(in)	iter,
		real(wp), intent(in)	resnorm,
		real(wp), intent(in)	res_ratio,
		real(wp), intent(in)	solnorm,
		real(wp), intent(in)	tol,
		integer, intent(in)	maxiter,
		integer, intent(in)	eq_tag
	)

mg_info_write()

subroutine, public dl_mg_info::mg_info_write

(

integer, intent(in)

eq_type

)

write_comms_structure()

subroutine, public dl_mg_info::write_comms_structure

(

type(mg_t), dimension(:), intent(in)

mg

)

write_nonlinear_params()

subroutine, public dl_mg_info::write_nonlinear_params	(	integer, intent(in)	eq_type,
		integer, intent(in)	n,
		real(wp), dimension(n), intent(in)	c,
		real(wp), dimension(n), intent(in)	q,
		real(wp), intent(in)	temp,
		real(wp), intent(in)	lam
	)

Variable Documentation

and

logical, save dl_mg_info::and

private

at

logical, save dl_mg_info::at

private

cg_status

type(solver_status_t), target dl_mg_info::cg_status

private

collect_res_hist

logical, save dl_mg_info::collect_res_hist = .false.

private

debug_write

logical, save, public dl_mg_info::debug_write =.false.

defco_status

type(defco_status_t), public dl_mg_info::defco_status

each

logical, save dl_mg_info::each

private

enables

logical, save dl_mg_info::enables

private

histogram

logical, save dl_mg_info::histogram

private

if

logical, save dl_mg_info::if

private

info_cg_tag

integer, parameter, public dl_mg_info::info_cg_tag =777

info_mg_tag

integer, parameter, public dl_mg_info::info_mg_tag =555

info_newton_tag

integer, parameter, public dl_mg_info::info_newton_tag =222

initialised_info

logical, save, public dl_mg_info::initialised_info = .false.

iteration

logical, save dl_mg_info::iteration

private

mg_status

type(solver_status_t), target dl_mg_info::mg_status

private

newton_status

type(solver_status_t), target, public dl_mg_info::newton_status

norms

logical, save dl_mg_info::norms

private

print_iter_info

logical, save dl_mg_info::print_iter_info = .true.

private

prints

logical, save dl_mg_info::prints

private

ratio

logical, save dl_mg_info::ratio

private

residual

logical save dl_mg_info::residual

private

solution

logical, save dl_mg_info::solution

private

true

logical, save dl_mg_info::true

private

version_string

character(len=*), parameter dl_mg_info::version_string ="4.2.0 (17/10/2023)"

private