nonlin_solver Interface

interface
public subroutine nonlin_solver(this, fcn, x, fvec, ib, err)

Arguments

Type IntentOptional Attributes Name
class(equation_solver), intent(inout) :: this

The equation_solver-based object.

class(vecfcn_helper), intent(in) :: fcn

The vecfcn_helper object containing the equations to solve.

real(kind=real64), intent(inout), dimension(:) :: 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.

real(kind=real64), intent(out), dimension(:) :: fvec

An M-element array that, on output, will contain the values of each equation as evaluated at the variable values given in x.

type(iteration_behavior), optional :: ib

An optional output, that if provided, allows the caller to obtain iteration performance statistics.

class(errors), intent(inout), optional, target :: err

An error handling object.

Description

Describes the interface of a nonlinear equation solver.