Device based coupled preconditioned conjugate gradient method. More...

Inheritance diagram for cg_cpld_device::cg_cpld_device_t:

Collaboration diagram for cg_cpld_device::cg_cpld_device_t:

[legend]

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

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

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

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

procedure(ksp_init_intrf), deferred, pass(this)	init (this, n, max_iter, m, rel_tol, abs_tol, monitor)
	Constructor.

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	w1

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

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

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

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

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

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

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

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

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

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

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

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

type(c_ptr)	w1_d = C_NULL_PTR

type(c_ptr)	w2_d = C_NULL_PTR

type(c_ptr)	w3_d = C_NULL_PTR

type(c_ptr)	r1_d = C_NULL_PTR

type(c_ptr)	r2_d = C_NULL_PTR

type(c_ptr)	r3_d = C_NULL_PTR

type(c_ptr)	p1_d = C_NULL_PTR

type(c_ptr)	p2_d = C_NULL_PTR

type(c_ptr)	p3_d = C_NULL_PTR

type(c_ptr)	z1_d = C_NULL_PTR

type(c_ptr)	z2_d = C_NULL_PTR

type(c_ptr)	z3_d = C_NULL_PTR

type(c_ptr)	tmp_d = C_NULL_PTR

type(c_ptr)	gs_event = C_NULL_PTR

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 54 of file cg_cpld_device.f90.

Member Function/Subroutine Documentation

◆ free() [1/2]

procedure, pass(this) cg_cpld_device::cg_cpld_device_t::free ( class(cg_cpld_device_t), intent(inout) this )

Definition at line 91 of file cg_cpld_device.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 102 of file krylov.f90.

◆ init() [1/2]

procedure, pass(this) cg_cpld_device::cg_cpld_device_t::init	(	class(cg_cpld_device_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 90 of file cg_cpld_device.f90.

◆ init() [2/2]

procedure(ksp_init_intrf), deferred, pass(this) krylov::ksp_t::init	(	class(ksp_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
	)

pure virtualinherited

Definition at line 82 of file krylov.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 100 of file krylov.f90.

◆ ksp_free()

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

inherited

Definition at line 86 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. 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 84 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 98 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 94 of file krylov.f90.

◆ monitor_stop()

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

inherited

Definition at line 96 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 88 of file krylov.f90.

◆ solve() [1/2]

procedure, pass(this) cg_cpld_device::cg_cpld_device_t::solve	(	class(cg_cpld_device_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 92 of file cg_cpld_device.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 90 of file krylov.f90.

◆ solve_coupled() [1/2]

procedure, pass(this) cg_cpld_device::cg_cpld_device_t::solve_coupled	(	class(cg_cpld_device_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 93 of file cg_cpld_device.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 92 of file krylov.f90.

Member Data Documentation

◆ abs_tol

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

inherited

Definition at line 76 of file krylov.f90.

◆ gs_event

type(c_ptr) cg_cpld_device::cg_cpld_device_t::gs_event = C_NULL_PTR

Definition at line 88 of file cg_cpld_device.f90.

◆ m

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

inherited

Definition at line 74 of file krylov.f90.

◆ m_ident

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

inherited

Definition at line 78 of file krylov.f90.

◆ max_iter

integer krylov::ksp_t::max_iter

inherited

Definition at line 77 of file krylov.f90.

◆ monitor

logical krylov::ksp_t::monitor

inherited

Definition at line 79 of file krylov.f90.

◆ p1

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::p1

Definition at line 61 of file cg_cpld_device.f90.

◆ p1_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::p1_d = C_NULL_PTR

Definition at line 78 of file cg_cpld_device.f90.

◆ p2

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::p2

Definition at line 62 of file cg_cpld_device.f90.

◆ p2_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::p2_d = C_NULL_PTR

Definition at line 79 of file cg_cpld_device.f90.

◆ p3

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::p3

Definition at line 63 of file cg_cpld_device.f90.

◆ p3_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::p3_d = C_NULL_PTR

Definition at line 80 of file cg_cpld_device.f90.

◆ r1

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::r1

Definition at line 58 of file cg_cpld_device.f90.

◆ r1_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::r1_d = C_NULL_PTR

Definition at line 74 of file cg_cpld_device.f90.

◆ r2

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::r2

Definition at line 59 of file cg_cpld_device.f90.

◆ r2_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::r2_d = C_NULL_PTR

Definition at line 75 of file cg_cpld_device.f90.

◆ r3

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::r3

Definition at line 60 of file cg_cpld_device.f90.

◆ r3_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::r3_d = C_NULL_PTR

Definition at line 76 of file cg_cpld_device.f90.

◆ rel_tol

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

inherited

Definition at line 75 of file krylov.f90.

◆ tmp

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::tmp

Definition at line 67 of file cg_cpld_device.f90.

◆ tmp_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::tmp_d = C_NULL_PTR

Definition at line 86 of file cg_cpld_device.f90.

◆ w1

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::w1

Definition at line 55 of file cg_cpld_device.f90.

◆ w1_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::w1_d = C_NULL_PTR

Definition at line 70 of file cg_cpld_device.f90.

◆ w2

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::w2

Definition at line 56 of file cg_cpld_device.f90.

◆ w2_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::w2_d = C_NULL_PTR

Definition at line 71 of file cg_cpld_device.f90.

◆ w3

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::w3

Definition at line 57 of file cg_cpld_device.f90.

◆ w3_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::w3_d = C_NULL_PTR

Definition at line 72 of file cg_cpld_device.f90.

◆ z1

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::z1

Definition at line 64 of file cg_cpld_device.f90.

◆ z1_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::z1_d = C_NULL_PTR

Definition at line 82 of file cg_cpld_device.f90.

◆ z2

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::z2

Definition at line 65 of file cg_cpld_device.f90.

◆ z2_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::z2_d = C_NULL_PTR

Definition at line 83 of file cg_cpld_device.f90.

◆ z3

real(kind=rp), dimension(:), allocatable cg_cpld_device::cg_cpld_device_t::z3

Definition at line 66 of file cg_cpld_device.f90.

◆ z3_d

type(c_ptr) cg_cpld_device::cg_cpld_device_t::z3_d = C_NULL_PTR

Definition at line 84 of file cg_cpld_device.f90.

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

/home/runner/work/neko/neko/src/krylov/bcknd/device/cg_cpld_device.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ free() [1/2]

◆ free() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ 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

◆ gs_event

◆ m

◆ m_ident

◆ max_iter

◆ monitor

◆ p1

◆ p1_d

◆ p2

◆ p2_d

◆ p3

◆ p3_d

◆ r1

◆ r1_d

◆ r2

◆ r2_d

◆ r3

◆ r3_d

◆ rel_tol

◆ tmp

◆ tmp_d

◆ w1

◆ w1_d

◆ w2

◆ w2_d

◆ w3

◆ w3_d

◆ z1

◆ z1_d

◆ z2

◆ z2_d

◆ z3

◆ z3_d