Standard preconditioned conjugate gradient method. More...

Inheritance diagram for cg::cg_t:

Collaboration diagram for cg::cg_t:

Public Member Functions
procedure, pass(this)	init (this, n, max_iter, m, rel_tol, abs_tol, monitor)
	Initialise a standard PCG solver.

procedure, pass(this)	free (this)
	Deallocate a standard PCG solver.

procedure, pass(this)	solve (this, ax, x, f, n, coef, blst, gs_h, niter)
	Standard PCG solve.

procedure, pass(this)	solve_coupled (this, ax, x, y, z, fx, fy, fz, n, coef, blstx, blsty, blstz, gs_h, niter)
	Standard PCG coupled solve.

procedure, pass(this)	ksp_init (this, max_iter, rel_tol, abs_tol, m, monitor)
	Base type constructor.

procedure, pass(this)	ksp_free (this)
	Base type destructor.

procedure, pass(this)	set_pc (this, m)
	Set preconditioner.

procedure(ksp_method), deferred, pass	solve (this, ax, x, f, n, coef, blst, gs_h, niter)
	Solve the system.

procedure(ksp_method_coupled), deferred, pass	solve_coupled (this, ax, x, y, z, fx, fy, fz, n, coef, blstx, blsty, blstz, gs_h, niter)
	Solve the system (coupled version).

procedure, pass(this)	monitor_start (this, name)
	Monitor start.

procedure, pass(this)	monitor_stop (this)
	Monitor stop.

procedure, pass(this)	monitor_iter (this, iter, rnorm)
	Monitor iteration.

procedure, pass(this)	is_converged (this, iter, residual)
	Check for convergence.

procedure(ksp_t_free), deferred, pass	free (this)
	Destructor.

Public Attributes
real(kind=rp), dimension(:), allocatable	w

real(kind=rp), dimension(:), allocatable	r

real(kind=rp), dimension(:,:), allocatable	p

real(kind=rp), dimension(:), allocatable	z

real(kind=rp), dimension(:), allocatable	alpha

class(pc_t), pointer	m => null()
	Preconditioner.

real(kind=rp)	rel_tol
	Relative tolerance.

real(kind=rp)	abs_tol
	Absolute tolerance.

integer	max_iter
	Maximum number of iterations.

class(pc_t), allocatable	m_ident
	Internal preconditioner (Identity)

logical	monitor
	Turn on/off monitoring.

Detailed Description

Definition at line 51 of file cg.f90.

Member Function/Subroutine Documentation

◆ free() [1/2]

procedure, pass(this) cg::cg_t::free ( class(cg_t), intent(inout) this )

Definition at line 59 of file cg.f90.

◆ free() [2/2]

procedure(ksp_t_free), deferred, pass krylov::ksp_t::free ( class(ksp_t), intent(inout) this )

pure virtualinherited

Definition at line 95 of file krylov.f90.

◆ init()

procedure, pass(this) cg::cg_t::init	(	class(cg_t), intent(inout), target	this,
		integer, intent(in)	n,
		integer, intent(in)	max_iter,
		class(pc_t), intent(in), optional, target	m,
		real(kind=rp), intent(in), optional	rel_tol,
		real(kind=rp), intent(in), optional	abs_tol,
		logical, intent(in), optional	monitor
	)

Definition at line 58 of file cg.f90.

◆ is_converged()

procedure, pass(this) krylov::ksp_t::is_converged	(	class(ksp_t), intent(in)	this,
		integer, intent(in)	iter,
		real(kind=rp), intent(in)	residual
	)

inherited

This function checks if the Krylov solver has converged. The solver is considered converged if the residual is less than the absolute tolerance.

Parameters

residual	Residual
iter	Iteration number

Definition at line 93 of file krylov.f90.

◆ ksp_free()

procedure, pass(this) krylov::ksp_t::ksp_free ( class(ksp_t), intent(inout) this )

inherited

Definition at line 79 of file krylov.f90.

◆ ksp_init()

procedure, pass(this) krylov::ksp_t::ksp_init	(	class(ksp_t), intent(inout), target	this,
		integer, intent(in)	max_iter,
		real(kind=rp), intent(in), optional	rel_tol,
		real(kind=rp), intent(in), optional	abs_tol,
		class(pc_t), intent(in), optional, target	m,
		logical, intent(in), optional	monitor
	)

inherited

Parameters

object	The object to be allocated.
n	Size of the vectors the solver operates on.
type_name	The name of the solver type.
max_iter	The maximum number of iterations
abstol	The absolute tolerance, optional.
M	The preconditioner, optional.
monitor	Enable/disable monitoring, optional. Destroy an iterative Krylov type_name Constructor for the base type.
max_iter	Maximum number of iterations.
rel_tol	Relative tolarance for converence.
rel_tol	Absolute tolarance for converence.
M	The preconditioner.

Definition at line 77 of file krylov.f90.

◆ monitor_iter()

procedure, pass(this) krylov::ksp_t::monitor_iter	(	class(ksp_t), intent(in)	this,
		integer, intent(in)	iter,
		real(kind=rp), intent(in)	rnorm
	)

inherited

Definition at line 91 of file krylov.f90.

◆ monitor_start()

procedure, pass(this) krylov::ksp_t::monitor_start	(	class(ksp_t), intent(in)	this,
		character(len=*)	name
	)

inherited

Definition at line 87 of file krylov.f90.

◆ monitor_stop()

procedure, pass(this) krylov::ksp_t::monitor_stop ( class(ksp_t), intent(in) this )

inherited

Definition at line 89 of file krylov.f90.

◆ set_pc()

procedure, pass(this) krylov::ksp_t::set_pc	(	class(ksp_t), intent(inout)	this,
		class(pc_t), intent(in), target	m
	)

inherited

Parameters

M	The preconditioner.

Definition at line 81 of file krylov.f90.

◆ solve() [1/2]

procedure, pass(this) cg::cg_t::solve	(	class(cg_t), intent(inout)	this,
		class(ax_t), intent(in)	ax,
		type(field_t), intent(inout)	x,
		real(kind=rp), dimension(n), intent(in)	f,
		integer, intent(in)	n,
		type(coef_t), intent(inout)	coef,
		type(bc_list_t), intent(inout)	blst,
		type(gs_t), intent(inout)	gs_h,
		integer, intent(in), optional	niter
	)

Definition at line 60 of file cg.f90.

◆ solve() [2/2]

procedure(ksp_method), deferred, pass krylov::ksp_t::solve	(	class(ksp_t), intent(inout)	this,
		class(ax_t), intent(in)	ax,
		type(field_t), intent(inout)	x,
		real(kind=rp), dimension(n), intent(in)	f,
		integer, intent(in)	n,
		type(coef_t), intent(inout)	coef,
		type(bc_list_t), intent(inout)	blst,
		type(gs_t), intent(inout)	gs_h,
		integer, intent(in), optional	niter
	)

pure virtualinherited

Definition at line 83 of file krylov.f90.

◆ solve_coupled() [1/2]

procedure, pass(this) cg::cg_t::solve_coupled	(	class(cg_t), intent(inout)	this,
		class(ax_t), intent(in)	ax,
		type(field_t), intent(inout)	x,
		type(field_t), intent(inout)	y,
		type(field_t), intent(inout)	z,
		real(kind=rp), dimension(n), intent(in)	fx,
		real(kind=rp), dimension(n), intent(in)	fy,
		real(kind=rp), dimension(n), intent(in)	fz,
		integer, intent(in)	n,
		type(coef_t), intent(inout)	coef,
		type(bc_list_t), intent(inout)	blstx,
		type(bc_list_t), intent(inout)	blsty,
		type(bc_list_t), intent(inout)	blstz,
		type(gs_t), intent(inout)	gs_h,
		integer, intent(in), optional	niter
	)

Definition at line 61 of file cg.f90.

◆ solve_coupled() [2/2]

procedure(ksp_method_coupled), deferred, pass krylov::ksp_t::solve_coupled	(	class(ksp_t), intent(inout)	this,
		class(ax_t), intent(in)	ax,
		type(field_t), intent(inout)	x,
		type(field_t), intent(inout)	y,
		type(field_t), intent(inout)	z,
		real(kind=rp), dimension(n), intent(in)	fx,
		real(kind=rp), dimension(n), intent(in)	fy,
		real(kind=rp), dimension(n), intent(in)	fz,
		integer, intent(in)	n,
		type(coef_t), intent(inout)	coef,
		type(bc_list_t), intent(inout)	blstx,
		type(bc_list_t), intent(inout)	blsty,
		type(bc_list_t), intent(inout)	blstz,
		type(gs_t), intent(inout)	gs_h,
		integer, intent(in), optional	niter
	)

pure virtualinherited

Definition at line 85 of file krylov.f90.

Member Data Documentation

◆ abs_tol

real(kind=rp) krylov::ksp_t::abs_tol

inherited

Definition at line 71 of file krylov.f90.

◆ alpha

real(kind=rp), dimension(:), allocatable cg::cg_t::alpha

Definition at line 56 of file cg.f90.

◆ m

class(pc_t), pointer krylov::ksp_t::m => null()

inherited

Definition at line 69 of file krylov.f90.

◆ m_ident

class(pc_t), allocatable krylov::ksp_t::m_ident

inherited

Definition at line 73 of file krylov.f90.

◆ max_iter

integer krylov::ksp_t::max_iter

inherited

Definition at line 72 of file krylov.f90.

◆ monitor

logical krylov::ksp_t::monitor

inherited

Definition at line 74 of file krylov.f90.

◆ p

real(kind=rp), dimension(:,:), allocatable cg::cg_t::p

Definition at line 54 of file cg.f90.

◆ r

real(kind=rp), dimension(:), allocatable cg::cg_t::r

Definition at line 53 of file cg.f90.

◆ rel_tol

real(kind=rp) krylov::ksp_t::rel_tol

inherited

Definition at line 70 of file krylov.f90.

◆ w

real(kind=rp), dimension(:), allocatable cg::cg_t::w

Definition at line 52 of file cg.f90.

◆ z

real(kind=rp), dimension(:), allocatable cg::cg_t::z

Definition at line 55 of file cg.f90.

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

/home/runner/work/neko/neko/src/krylov/bcknd/cpu/cg.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ free() [1/2]

◆ free() [2/2]

◆ init()

◆ is_converged()

◆ ksp_free()

◆ ksp_init()

◆ monitor_iter()

◆ monitor_start()

◆ monitor_stop()

◆ set_pc()

◆ solve() [1/2]

◆ solve() [2/2]

◆ solve_coupled() [1/2]

◆ solve_coupled() [2/2]

Member Data Documentation

◆ abs_tol

◆ alpha

◆ m

◆ m_ident

◆ max_iter

◆ monitor

◆ p

◆ r

◆ rel_tol

◆ w

◆ z