Detailed Description

PETSc symmetric Point-Jacobi solver.

See also: oft_native_solvers::oft_jblock_precond

Inheritance diagram for oft_petsc_sjacobi_solver:

[legend]

Public Member Functions
procedure	apply (self, u, g)
	Solve system.
procedure(solver_apply), deferred	apply (self, u, g)
	Solve system.
procedure	check_thread (self)
	Check thread safety.
procedure	delete (self)
	Clean-up internal storage.
procedure(solver_delete), deferred	delete (self)
	Clean-up internal storage.
procedure	setup_from_xml (self, solver_node, level)
	Setup solver from XML node.
procedure	setup_from_xml (self, solver_node, level)
	Setup solver from XML node.
procedure	setup_ksp (self, ksp)
	Setup PETSc solver object.
procedure	update (self, new_pattern)
	Update solver with new settings/operators.
procedure	update (self, new_pattern)
	Update solver with new settings/operators.
procedure	view (self)
	Print solver information.

Public Attributes
class(oft_matrix), pointer	a => NULL()
	Matrix to be inverted.
real(r8)	atol = 1.d-14
	Absolute convergence tolerance \( \|res\| < atol \).
class(oft_solver_bc), pointer	bc => NULL()
	Boundary condition.
integer(i4)	cits = 0
	Number of iteractions to convergence.
real(r8)	df = .9d0
	Damping factor.
logical	dist = .FALSE.
	Matrix/Vector are distributed.
logical	full_residual = .TRUE.
	Output true residual on exit.
logical	initialized = .FALSE.
	Solver has been constructed.
integer(i4)	itplot =10
	Output frequency for iterative solvers when pm=.TRUE.
integer(i4)	its = -1
	Maximum iteration count.
logical	pm = .FALSE.
	Performance monitor override.
class(oft_solver), pointer	pre => NULL()
	Preconditioner.
real(r8)	rtol = 1.d-14
	Relative convergence tolerance \( \|res\|/\|res_0\| < rtol \).
type(tksp)	solver
	PETSc solver object.

Private Attributes
class(oft_vector), pointer, private	d => NULL()
	Internal storage.
logical, private	down =.TRUE.
	Internal flag for smoother step.
class(oft_vector), pointer, private	g_save => NULL()
	Internal storage.
class(oft_vector), pointer, private	u_save => NULL()
	Internal storage.
logical, private	warn_once = .TRUE.
	Internal flag for iteration check.

Member Function/Subroutine Documentation

◆ apply() [1/2]

procedure apply	(	class(oft_petsc_sjacobi_solver), intent(inout)	self,
		class(oft_vector), intent(inout)	u,
		class(oft_vector), intent(inout)	g )

Solve system.

Parameters

[in,out]	self	Solver object
[in,out]	u	Guess (input), Solution (output)
[in,out]	g	RHS (input), Residual (output)

◆ apply() [2/2]

procedure(solver_apply), deferred apply	(	class(oft_solver), intent(inout)	self,
		class(oft_vector), intent(inout)	u,
		class(oft_vector), intent(inout)	g )

pure virtualinherited

Solve system.

Parameters

[in,out]	self	Solver object
[in,out]	u	Guess/Solution field
[in,out]	g	RHS/Residual field

◆ check_thread()

procedure check_thread ( class(oft_solver), intent(inout) self )

inherited

Check thread safety.

Parameters

[in,out] self Solver object

◆ delete() [1/2]

procedure delete ( class(oft_petsc_solver), intent(inout) self )

inherited

Clean-up internal storage.

Parameters

[in,out] self Solver object

◆ delete() [2/2]

procedure(solver_delete), deferred delete ( class(oft_solver), intent(inout) self )

pure virtualinherited

Clean-up internal storage.

Parameters

[in,out] self Solver object

◆ setup_from_xml() [1/2]

procedure setup_from_xml	(	class(oft_petsc_sjacobi_solver), intent(inout)	self,
		type(xml_node), intent(in), pointer	solver_node,
		integer(i4), intent(in), optional	level )

Setup solver from XML node.

Parameters

[in,out]	self	Solver object
[in]	solver_node	XML element containing solver definition
[in]	level	Level in MG hierarchy (optional)

◆ setup_from_xml() [2/2]

procedure setup_from_xml	(	class(oft_solver), intent(inout)	self,
		type(xml_node), intent(in), pointer	solver_node,
		integer(i4), intent(in), optional	level )

inherited

Setup solver from XML node.

Note: This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized solvers

Parameters

[in,out]	self	Solver object
[in]	solver_node	XML element containing solver definition
[in]	level	Level in MG hierarchy (optional)

◆ setup_ksp()

procedure setup_ksp	(	class(oft_petsc_solver), intent(inout)	self,
		type(tksp), intent(inout)	ksp )

inherited

Setup PETSc solver object.

Parameters

[in,out] self Solver object

◆ update() [1/2]

procedure update	(	class(oft_petsc_solver), intent(inout)	self,
		logical, intent(in), optional	new_pattern )

inherited

Update solver with new settings/operators.

Parameters

[in,out]	self	Solver object
[in]	new_pattern	Update matrix pattern (optional)

◆ update() [2/2]

procedure update	(	class(oft_solver), intent(inout)	self,
		logical, intent(in), optional	new_pattern )

inherited

Update solver with new settings/operators.

Note: This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized solvers

Parameters

[in,out]	self	Solver object
[in]	new_pattern	Update matrix non-zero pattern? (optional)

◆ view()

procedure view ( class(oft_solver), intent(inout) self )

inherited

Print solver information.

Note: This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized solvers

Parameters

[in,out] self Solver object

Member Data Documentation

◆ a

class(oft_matrix), pointer a => NULL()

inherited

Matrix to be inverted.

◆ atol

real(r8) atol = 1.d-14

inherited

Absolute convergence tolerance \( |res| < atol \).

◆ bc

class(oft_solver_bc), pointer bc => NULL()

inherited

Boundary condition.

◆ cits

integer(i4) cits = 0

inherited

Number of iteractions to convergence.

◆ d

class(oft_vector), pointer, private d => NULL()

private

Internal storage.

◆ df

real(r8) df = .9d0

Damping factor.

◆ dist

logical dist = .FALSE.

inherited

Matrix/Vector are distributed.

◆ down

logical, private down =.TRUE.

private

Internal flag for smoother step.

◆ full_residual

logical full_residual = .TRUE.

inherited

Output true residual on exit.

◆ g_save

class(oft_vector), pointer, private g_save => NULL()

private

Internal storage.

◆ initialized

logical initialized = .FALSE.

inherited

Solver has been constructed.

◆ itplot

integer(i4) itplot =10

inherited

Output frequency for iterative solvers when pm=.TRUE.

◆ its

integer(i4) its = -1

inherited

Maximum iteration count.

◆ pm

logical pm = .FALSE.

inherited

Performance monitor override.

◆ pre

class(oft_solver), pointer pre => NULL()

inherited

Preconditioner.

◆ rtol

real(r8) rtol = 1.d-14

inherited

Relative convergence tolerance \( |res|/|res_0| < rtol \).

◆ solver

type(tksp) solver

inherited

PETSc solver object.

◆ u_save

class(oft_vector), pointer, private u_save => NULL()

private

Internal storage.

◆ warn_once

logical, private warn_once = .TRUE.

private

Internal flag for iteration check.

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

/home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/lin_alg/petsc_solvers.F90

Detailed Description

Public Member Functions

Public Attributes

Private Attributes

Member Function/Subroutine Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ check_thread()

◆ delete() [1/2]

◆ delete() [2/2]

◆ setup_from_xml() [1/2]

◆ setup_from_xml() [2/2]

◆ setup_ksp()

◆ update() [1/2]

◆ update() [2/2]

◆ view()

Member Data Documentation

◆ a

◆ atol

◆ bc

◆ cits

◆ d

◆ df

◆ dist

◆ down

◆ full_residual

◆ g_save

◆ initialized

◆ itplot

◆ its

◆ pm

◆ pre

◆ rtol

◆ solver

◆ u_save

◆ warn_once