Describes the interface of a solver for an equation of one variable. More...

Public Member Functions
subroutine	nonlin_solver_1var (this, fcn, x, lim, f, ib, err)

Detailed Description

Describes the interface of a solver for an equation of one variable.

Parameters

[in,out]	this	The equation_solver_1var-based object.
[in]	fcn	The fcn1var_helper object containing the equation to solve.
[in,out]	x	On input the initial guess at the solution. On output the updated solution estimate.
[in]	lim	A value_pair object defining the search limits.
[out]	f	An optional parameter used to return the function residual as computed at `x`.
[out]	ib	An optional output, that if provided, allows the caller to obtain iteration performance statistics.
[out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. The possible error codes returned will likely vary from solver to solver.

Definition at line 1935 of file nonlin_core.f90.

Constructor & Destructor Documentation

subroutine nonlin_core::nonlin_solver_1var::nonlin_solver_1var	(	class(equation_solver_1var), intent(inout)	this,
		class(fcn1var_helper), intent(in)	fcn,
		real(real64), intent(inout)	x,
		type(value_pair), intent(in)	lim,
		real(real64), intent(out), optional	f,
		type(iteration_behavior), optional	ib,
		class(errors), intent(inout), optional, target	err )

Definition at line 1935 of file nonlin_core.f90.

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