Base type for multigrid smoother. More...

Inheritance diagram for scale_multigrid_smoother_base::mgsmootherbase:

Public Member Functions
procedure	set_smoothing_param (this, num_smooth_itr_max, threshold_ratio_residual_l2, threshold_residual_l2, threshold_residual_max, history_residual_step)
	Set smoothing parameters.
procedure	output_residual_history (this)
procedure	is_converged (this, is_vcycle_end)
procedure	get_initial_residual_statistics (this, res_l2_init, res_max_init)
procedure	get_current_residual_statistics (this, res_l2, res_max)

Public Attributes
integer	itration
	Current smoothing iteration.
integer	num_smooth_itr_max
	Maximum number of smoothing iterations.
real(rp)	threshold_ratio_residual_l2
	Threshold of decreasing ratio of residual for smoothing (L2 norm)
real(rp)	threshold_residual_l2
	Residual threshold for smoothing (L2 norm)
real(rp)	threshold_residual_max
	Residual threshold for smoothing (max norm)
integer	history_residual_step
	Step recording residual history.
integer	history_residual_rstep
	Remaining step to record residual history.
integer	history_residual_count
	Count of recorded residuals.
real(rp), dimension(:), allocatable	history_residual_l2
	Residual history of L2 norm.
real(rp)	history_residual_l2_initial
	Initial residual L2 norm.
real(rp), dimension(:), allocatable	history_residual_max
	Residual history of max norm.
real(rp)	history_residual_max_initial
	Initial residual max norm.

Detailed Description

Base type for multigrid smoother.

Definition at line 50 of file scale_multigrid_smoother_base.F90.

Member Function/Subroutine Documentation

◆ set_smoothing_param()

procedure scale_multigrid_smoother_base::mgsmootherbase::set_smoothing_param	(	class(mgsmootherbase), intent(inout)	this,
		integer, intent(in)	num_smooth_itr_max,
		real(rp), intent(in)	threshold_ratio_residual_l2,
		real(rp), intent(in)	threshold_residual_l2,
		real(rp), intent(in)	threshold_residual_max,
		integer, intent(in)	history_residual_step )

Set smoothing parameters.

Parameters

[in]	num_smooth_itr_max	Maximum number of smoothing iterations
[in]	threshold_ratio_residual_l2	Threshold of decreasing ratio of residual for smoothing (L2 norm)
[in]	threshold_residual_l2	Residual threshold for smoothing (L2 norm)
[in]	threshold_residual_max	Residual threshold for smoothing (max norm)
[in]	history_residual_step	Step recording residual history

Definition at line 66 of file scale_multigrid_smoother_base.F90.

◆ output_residual_history()

procedure scale_multigrid_smoother_base::mgsmootherbase::output_residual_history ( class(mgsmootherbase), intent(in) this )

Definition at line 67 of file scale_multigrid_smoother_base.F90.

◆ is_converged()

procedure scale_multigrid_smoother_base::mgsmootherbase::is_converged	(	class(mgsmootherbase), intent(in)	this,
		logical, intent(in)	is_vcycle_end )

Definition at line 68 of file scale_multigrid_smoother_base.F90.

◆ get_initial_residual_statistics()

procedure scale_multigrid_smoother_base::mgsmootherbase::get_initial_residual_statistics	(	class(mgsmootherbase), intent(in)	this,
		real(rp), intent(out)	res_l2_init,
		real(rp), intent(out)	res_max_init )

Definition at line 69 of file scale_multigrid_smoother_base.F90.

◆ get_current_residual_statistics()

procedure scale_multigrid_smoother_base::mgsmootherbase::get_current_residual_statistics	(	class(mgsmootherbase), intent(in)	this,
		real(rp), intent(out)	res_l2,
		real(rp), intent(out)	res_max )

Definition at line 70 of file scale_multigrid_smoother_base.F90.

References scale_multigrid_smoother_base::mgsmootherbase_final(), scale_multigrid_smoother_base::mgsmootherbase_get_statistic_lc(), scale_multigrid_smoother_base::mgsmootherbase_init(), and scale_multigrid_smoother_base::mgsmootherbase_put_residual_history().

Member Data Documentation

◆ itration

integer scale_multigrid_smoother_base::mgsmootherbase::itration

Current smoothing iteration.

Definition at line 51 of file scale_multigrid_smoother_base.F90.

51 integer :: itration !< Current smoothing iteration

◆ num_smooth_itr_max

integer scale_multigrid_smoother_base::mgsmootherbase::num_smooth_itr_max

Maximum number of smoothing iterations.

Definition at line 52 of file scale_multigrid_smoother_base.F90.

52 integer :: num_smooth_itr_max !< Maximum number of smoothing iterations

◆ threshold_ratio_residual_l2

real(rp) scale_multigrid_smoother_base::mgsmootherbase::threshold_ratio_residual_l2

Threshold of decreasing ratio of residual for smoothing (L2 norm)

Definition at line 54 of file scale_multigrid_smoother_base.F90.

54 real(RP) :: threshold_ratio_residual_l2 !< Threshold of decreasing ratio of residual for smoothing (L2 norm)

◆ threshold_residual_l2

real(rp) scale_multigrid_smoother_base::mgsmootherbase::threshold_residual_l2

Residual threshold for smoothing (L2 norm)

Definition at line 55 of file scale_multigrid_smoother_base.F90.

55 real(RP) :: threshold_residual_l2 !< Residual threshold for smoothing (L2 norm)

◆ threshold_residual_max

real(rp) scale_multigrid_smoother_base::mgsmootherbase::threshold_residual_max

Residual threshold for smoothing (max norm)

Definition at line 56 of file scale_multigrid_smoother_base.F90.

56 real(RP) :: threshold_residual_max !< Residual threshold for smoothing (max norm)

◆ history_residual_step

integer scale_multigrid_smoother_base::mgsmootherbase::history_residual_step

Step recording residual history.

Definition at line 58 of file scale_multigrid_smoother_base.F90.

58 integer :: history_residual_step !< Step recording residual history

◆ history_residual_rstep

integer scale_multigrid_smoother_base::mgsmootherbase::history_residual_rstep

Remaining step to record residual history.

Definition at line 59 of file scale_multigrid_smoother_base.F90.

59 integer :: history_residual_rstep !< Remaining step to record residual history

◆ history_residual_count

integer scale_multigrid_smoother_base::mgsmootherbase::history_residual_count

Count of recorded residuals.

Definition at line 60 of file scale_multigrid_smoother_base.F90.

60 integer :: history_residual_count !< Count of recorded residuals

◆ history_residual_l2

real(rp), dimension(:), allocatable scale_multigrid_smoother_base::mgsmootherbase::history_residual_l2

Residual history of L2 norm.

Definition at line 61 of file scale_multigrid_smoother_base.F90.

61 real(RP), allocatable :: history_residual_l2(:) !< Residual history of L2 norm

◆ history_residual_l2_initial

real(rp) scale_multigrid_smoother_base::mgsmootherbase::history_residual_l2_initial

Initial residual L2 norm.

Definition at line 62 of file scale_multigrid_smoother_base.F90.

62 real(RP) :: history_residual_l2_initial !< Initial residual L2 norm

◆ history_residual_max

real(rp), dimension(:), allocatable scale_multigrid_smoother_base::mgsmootherbase::history_residual_max

Residual history of max norm.

Definition at line 63 of file scale_multigrid_smoother_base.F90.

63 real(RP), allocatable :: history_residual_max(:) !< Residual history of max norm

◆ history_residual_max_initial

real(rp) scale_multigrid_smoother_base::mgsmootherbase::history_residual_max_initial

Initial residual max norm.

Definition at line 64 of file scale_multigrid_smoother_base.F90.

64 real(RP) :: history_residual_max_initial !< Initial residual max norm

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

scale_multigrid_smoother_base.F90

Public Member Functions

Public Attributes