forsolver Module

Uses

- forsolver_kinds
- fordiff
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Interfaces

public interface solve

private pure function solver_lin(A, b, method) result(x)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=rk),	intent(in),		dimension(:, :), contiguous	::	A
real(kind=rk),	intent(in),		dimension(:), contiguous	::	b
character(len=*),	intent(in),	optional		::	method

Return Value real(kind=rk), dimension(max(1, size(A, 2)))

Derived Types

type, public :: nlsolver

Components

Type	Visibility	Attributes		Name		Initial
real(kind=rk),	public		::	TolFun
real(kind=rk),	public		::	cs_tol
character(len=:),	public,	allocatable	::	fdm_method
real(kind=rk),	public		::	fdm_tol
character(len=:),	public,	allocatable	::	lin_method
integer,	public		::	maxit
character(len=:),	public,	allocatable	::	nl_method
integer,	public		::	nmp
integer,	public		::	verbosity

Finalizations Procedures

final :: deallocate_solver

Type-Bound Procedures

procedure, public :: newton_complex_step_rel_T0
procedure, public :: newton_complex_step_rel_T1
procedure, public :: newton_rel_T0
procedure, public :: newton_rel_T1
procedure, public :: set_options
generic, public :: solve => newton_rel_T0, newton_rel_T1, newton_complex_step_rel_T0, newton_complex_step_rel_T1

Functions

private pure function solver_lin(A, b, method) result(x)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=rk),	intent(in),		dimension(:, :), contiguous	::	A
real(kind=rk),	intent(in),		dimension(:), contiguous	::	b
character(len=*),	intent(in),	optional		::	method

Return Value real(kind=rk), dimension(max(1, size(A, 2)))

Subroutines

private pure elemental subroutine deallocate_solver(this)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
type(nlsolver),	intent(inout)			::	this

private pure subroutine gels_rel(A, b, x, info)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

solves an overdetermined or underdetermined linear system using gels.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=rk),	intent(in),		dimension(:, :), contiguous	::	A
real(kind=rk),	intent(in),		dimension(:), contiguous	::	b
real(kind=rk),	intent(out),		dimension(max(1, size(A, 2)))	::	x
integer,	intent(out)			::	info

private pure subroutine gesv_rel(A, b, x, info)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=rk),	intent(in),		dimension(:, :), contiguous	::	A
real(kind=rk),	intent(in),		dimension(:), contiguous	::	b
real(kind=rk),	intent(out),		dimension(max(1, size(A, 2)))	::	x
integer,	intent(out)			::	info

private impure subroutine modified_newton_method_T0(this, F, dFdx, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun6)				::	F
procedure(dFun6)				::	dFdx
real(kind=rk),	intent(in)			::	x0
real(kind=rk),	intent(out)			::	x_sol

private impure subroutine modified_newton_method_T1(this, F, dFdx, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun11)				::	F
procedure(dFun11)				::	dFdx
real(kind=rk),	intent(in),		dimension(:)	::	x0
real(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine modified_quasi_cs_newton_method_T0(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun15)				::	F
complex(kind=rk),	intent(in)			::	x0
complex(kind=rk),	intent(out)			::	x_sol

private impure subroutine modified_quasi_cs_newton_method_T1(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun17)				::	F
complex(kind=rk),	intent(in),		dimension(:)	::	x0
complex(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine modified_quasi_fd_newton_method_T0(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun8)				::	F
real(kind=rk),	intent(in)			::	x0
real(kind=rk),	intent(out)			::	x_sol

private impure subroutine modified_quasi_fd_newton_method_T1(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun13)				::	F
real(kind=rk),	intent(in),		dimension(:)	::	x0
real(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine newton_complex_step_rel_T0(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun3)				::	F
complex(kind=rk),	intent(in)			::	x0
complex(kind=rk),	intent(out)			::	x_sol

private impure subroutine newton_complex_step_rel_T1(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun4)				::	F
complex(kind=rk),	intent(in),		dimension(:)	::	x0
complex(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine newton_method_T0(this, F, dFdx, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun5)				::	F
procedure(dFun5)				::	dFdx
real(kind=rk),	intent(in)			::	x0
real(kind=rk),	intent(out)			::	x_sol

private impure subroutine newton_method_T1(this, F, dFdx, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun9)				::	F
procedure(dFun10)				::	dFdx
real(kind=rk),	intent(in),		dimension(:)	::	x0
real(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine newton_rel_T0(this, F, dFdx, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun1)				::	F
procedure(dFun1),		optional		::	dFdx
real(kind=rk),	intent(in)			::	x0
real(kind=rk),	intent(out)			::	x_sol

private impure subroutine newton_rel_T1(this, F, dFdx, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun2)				::	F
procedure(dFun2),		optional		::	dFdx
real(kind=rk),	intent(in),		dimension(:)	::	x0
real(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine quasi_cs_newton_method_T0(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun14)				::	F
complex(kind=rk),	intent(in)			::	x0
complex(kind=rk),	intent(out)			::	x_sol

private impure subroutine quasi_cs_newton_method_T1(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun16)				::	F
complex(kind=rk),	intent(in),		dimension(:)	::	x0
complex(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine quasi_fd_newton_method_T0(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun7)				::	F
real(kind=rk),	intent(in)			::	x0
real(kind=rk),	intent(out)			::	x_sol

private impure subroutine quasi_fd_newton_method_T1(this, F, x0, x_sol)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
procedure(Fun12)				::	F
real(kind=rk),	intent(in),		dimension(:)	::	x0
real(kind=rk),	intent(out),		dimension(size(x0))	::	x_sol

private impure subroutine set_options(this, nl_method, lin_method, maxit, TolFun, alpha0, c1, c2, nmp, fdm_method, fdm_tol, cs_tol, stepsize, verbosity)

Author: Seyed Ali Ghasemi
License: BSD 3-Clause

Arguments

Type	Intent	Optional	Attributes		Name
class(nlsolver),	intent(inout)			::	this
character(len=*),	intent(in),	optional		::	nl_method
character(len=*),	intent(in),	optional		::	lin_method
integer,	intent(in),	optional		::	maxit
real(kind=rk),	intent(in),	optional		::	TolFun
real(kind=rk),	intent(in),	optional		::	alpha0
real(kind=rk),	intent(in),	optional		::	c1
real(kind=rk),	intent(in),	optional		::	c2
integer,	intent(in),	optional		::	nmp
character(len=*),	intent(in),	optional		::	fdm_method
real(kind=rk),	intent(in),	optional		::	fdm_tol
real(kind=rk),	intent(in),	optional		::	cs_tol
character(len=*),	intent(in),	optional		::	stepsize
integer,	intent(in),	optional		::	verbosity