Describes the interface of a nonlinear equation solver. More...

Public Member Functions
subroutine	nonlin_solver (this, fcn, x, fvec, ib, err)

Detailed Description

Describes the interface of a nonlinear equation solver.

Parameters

[in,out]	this	The equation_solver-based object.
[in]	fcn	The vecfcn_helper object containing the equations to solve.
[in,out]	x	On input, an N-element array containing an initial estimate to the solution. On output, the updated solution estimate. N is the number of variables.
[out]	fvec	An M-element array that, on output, will contain the values of each equation as evaluated at the variable values given in `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 1902 of file nonlin_core.f90.

Constructor & Destructor Documentation

subroutine nonlin_core::nonlin_solver::nonlin_solver	(	class(equation_solver), intent(inout)	this,
		class(vecfcn_helper), intent(in)	fcn,
		real(real64), dimension(:), intent(inout)	x,
		real(real64), dimension(:), intent(out)	fvec,
		type(iteration_behavior), optional	ib,
		class(errors), intent(inout), optional, target	err )

Definition at line 1902 of file nonlin_core.f90.

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