vmec_equilibrium::vmec_descent_class Interface Reference

Extended gradient_descent_class. More...

Inheritance diagram for vmec_equilibrium::vmec_descent_class:

Public Member Functions
PROCEDURE	chi2 => vmec_descent_chi2
class(vmec_descent_class) function, pointer	vmec_descent_construct (t0, u0, dx, x0)
	Construct a vmec_descent_class. More...
Public Member Functions inherited from gradient_descent::gradient_descent_class
PROCEDURE	chi2 => gradient_descent_chi2
PROCEDURE	minimize => gradient_descent_minimize
FINAL	gradient_descent_destruct

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

vmec_descent_construct()

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
	)

Construct a vmec_descent_class.

Allocates memory and initializes a vmec_descent_class object.

Parameters

[in]	t0	Inital value of t0.
[in]	u0	Inital value of u0.
[in]	dx	Dx constant.
[in]	x0	X0 constant.

Returns

A pointer to a constructed vmec_descent_class object.

---

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

• V3FIT/Sources/vmec_equilibrium.f