Extended gradient_descent_class. More...

Inheritance diagram for vmec_equilibrium::vmec_descent_class:

Public Member Functions
procedure	chi2 (this, chi2)
	Function to compute chi value and it's gradients.

class(vmec_descent_class) function, pointer	vmec_descent_construct (t0, u0, dx, x0)
	Construct a vmec_descent_class.

Public Member Functions inherited from gradient_descent::gradient_descent_class
procedure	chi2 (this, chi2)
	Compute the χ^2 value and the gradients.

procedure	minimize (this)
	Gradient descent to minimize the χ^2 function.

FINAL	gradient_descent_destruct (this)
	Deconstruct a gradient_descent_test_class object.

Public Attributes
real(rprec), dimension(3)	dx

real(rprec), dimension(3)	x0

Public Attributes inherited from gradient_descent::gradient_descent_class
real(rprec)	step
	Step size to use.

real(rprec)	tolarance
	Minimization tolarance.

real(rprec), dimension(:), pointer	x_var => null()
	Variables.

Detailed Description

Extended gradient_descent_class.

Interface for the construction of vmec_descent_class type using vmec_descent_construct.

Member Function/Subroutine Documentation

procedure vmec_equilibrium::vmec_descent_class::chi2	(	class (vmec_descent_class), intent(in)	this,
		real (rprec), dimension(:), intent(out)	chi2
	)

Function to compute chi value and it's gradients.

Compute the chi and gradient values for the vmec_equilbrium::vmec_limit_path_to_boundary method.

Parameters

[in]	this	A vmec_descent_class instance.
[out]	chi2	χ, dχdt, dχdu

class (vmec_descent_class) function, pointer vmec_equilibrium::vmec_descent_class::vmec_descent_construct	(	real (rprec), intent(in)	t0,
		real (rprec), intent(in)	u0,
		real (rprec), dimension(3), intent(in)	dx,
		real (rprec), dimension(3), intent(in)	x0
	)

Allocates memory and initializes a vmec_descent_class object.

Parameters

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