Generic solver for m-form systems of equations. More...

Inheritance diagram for m_mform_solver::genericsolver:

Public Member Functions
procedure	init (this, amat, constraint1, constraint2, constraint3, coord_transform, options)
	Initialize the generic solver for a linear system of equations defined on m-forms.

procedure	solve (this, x, b, options)
	Solve the linear system of equations defined by the initialized generic solver and the right-hand side vector.

procedure	destroy (this)

Public Member Functions inherited from m_mform_solver::abstractsolver
procedure	get_warning_message (this, failure)

procedure	destroy (this)
	Destroy the generic solver object.

Public Attributes
type(mformspace)	space_col
	The m-form space of the solution vector.

type(mformspace)	space_row
	The m-form space of the residual.

type(mformconstraint), allocatable	constraint
	The optional constraint.

Public Attributes inherited from m_mform_solver::abstractsolver
integer	last_nr_iterations
	The matrix to be inverted.

real(wp)	last_residual_norm
	The residual norm in the last solve.

type(solverinitoptions)	options
	The convergence reason in the last solve.

Detailed Description

Generic solver for m-form systems of equations.

Member Function/Subroutine Documentation

procedure m_mform_solver::genericsolver::init	(	class(genericsolver), intent(inout)	this,
		class(abstractmatrix), intent(in)	amat,
		class(mformconstraintlocal), intent(in), optional	constraint1,
		class(mformconstraintlocal), intent(in), optional	constraint2,
		class(mformconstraintlocal), intent(in), optional	constraint3,
		class(coordtransformabstract), intent(in), optional	coord_transform,
		type(solverinitoptions), intent(in), optional	options )

Initialize the generic solver for a linear system of equations defined on m-forms.

Parameters

[in,out]	this	The generic solver object to be initialized
[in]	amat	The matrix to be inverted (any type derived from AbstractMatrix)
[in]	constraint1	_(optional)_ An optional constraint to be applied to the solution
[in]	constraint2	_(optional)_ An optional constraint to be applied to the solution
[in]	constraint3	_(optional)_ An optional constraint to be applied to the solution
[in]	coord_transform	_(optional)_ The coordinate transformation associated with the m-form spaces
[in]	options	_(optional)_ Options for initializing the solver

procedure m_mform_solver::genericsolver::solve	(	class(genericsolver), intent(in)	this,
		type(mformfun), intent(inout)	x,
		type(mformfun), intent(in)	b,
		type(solversolveoptions), intent(in), optional	options )

Solve the linear system of equations defined by the initialized generic solver and the right-hand side vector.

Parameters

[in]	this	The generic solver object
[in,out]	x	The solution vector (m-form function, xdistribute() is called)
[in]	b	The right-hand side vector (m-form function, bdistribute() is not needed)
[in]	options	_(optional)_ Options for solving the linear system

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