Detailed Description

Base class for OFT solvers.

Inheritance diagram for oft_solver:

[legend]

Public Member Functions
procedure(solver_apply), deferred	apply (self, u, g)
	Solve system.

procedure	check_thread (self)
	Check thread safety.

procedure(solver_delete), deferred	delete (self)
	Clean-up internal storage.

procedure	setup_from_xml (self, solver_node, level)
	Setup solver from XML node.

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 \).

integer(i4)	cits = 0
	Number of iteractions to convergence.

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 \).

Static Public Attributes
procedure(oft_bc_proto), pointer, nopass	bc => NULL()
	Boundary condition.

Member Function/Subroutine Documentation

◆ apply()

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

pure virtual

Solve system.

◆ check_thread()

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

Check thread safety.

◆ delete()

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

pure virtual

Clean-up internal storage.

◆ setup_from_xml()

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

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]	solver_node	XML node containing solver definition
[in]	level	Level in MG hierarchy (optional)

◆ update()

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

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] new_pattern Update matrix pattern (optional)

◆ view()

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

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

Member Data Documentation

◆ a

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

Matrix to be inverted.

◆ atol

real(r8) atol = 1.d-14

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

◆ bc

procedure(oft_bc_proto), pointer, nopass bc => NULL()

static

Boundary condition.

◆ cits

integer(i4) cits = 0

Number of iteractions to convergence.

◆ full_residual

logical full_residual = .TRUE.

Output true residual on exit.

◆ initialized

logical initialized = .FALSE.

Solver has been constructed.

◆ itplot

integer(i4) itplot =10

Output frequency for iterative solvers when pm=.TRUE.

◆ its

integer(i4) its = -1

Maximum iteration count.

◆ pm

logical pm = .FALSE.

Performance monitor override.

◆ pre

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

Preconditioner.

◆ rtol

real(r8) rtol = 1.d-14

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

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

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