gvec.lib#

Warning

Autogenerated API

The gvec.lib module is autogenerated by f90wrap and provides the first layer Python interface to the wrapped fortran API. (See pyGVEC for more details on the structure.) Use with caution!

class gvec.lib.Modgvec_Biotsavart#

Bases: FortranModule

Module modgvec_biotsavart Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/BiotSavart.F90 lines 6-97

static biotsavart(n_positions, xyz, n_points, coil_points, prefactor, b)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/BiotSavart.F90 lines 18-55

Parameters:

  • n_positions (int32)

  • xyz (float array)

  • n_points (int32)

  • coil_points (float array)

  • prefactor (float64)

  • b (float array)

static biotsavart_vectorpotential(n_positions, xyz, n_points, n_segments, coil_points, ehat, l, prefactor, a)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/BiotSavart.F90 lines 58-97

Parameters:

  • n_positions (int32)

  • xyz (float array)

  • n_points (int32)

  • n_segments (int32)

  • coil_points (float array)

  • ehat (float array)

  • l (float array)

  • prefactor (float64)

  • a (float array)

class gvec.lib.Modgvec_Fbase#

Bases: FortranModule

Module modgvec_fbase Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 16-1763

static change_base(instance, *args, **kwargs)#
static compare(instance, *args, **kwargs)#
static copy(instance, *args, **kwargs)#
static eval(instance, *args, **kwargs)#
static eval_xn(instance, *args, **kwargs)#
static evaldof_ip(instance, *args, **kwargs)#
static evaldof_x(instance, *args, **kwargs)#
static evaldof_xn(instance, *args, **kwargs)#
static evaldof_xn_tens(instance, *args, **kwargs)#
get_array_sin_cos_map()#
static init(instance, *args, **kwargs)#
static initdof(instance, *args, **kwargs)#
static projectiptodof(instance, *args, **kwargs)#
static projectxntodof(instance, *args, **kwargs)#
set_array_sin_cos_map(value)#
property sin_cos_map#

Element sin_cos_map ftype=character(len=8) pytype=str array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 88

class t_fBase(mn_max_in, mn_nyq_in, nfp_in, sin_cos_in, exclude_mn_zero_in, handle=None)#

Bases: FortranDerivedType

Type(name=t_fbase) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 23-81

property base1d_dthet_ipthet#

Element base1d_dthet_ipthet ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 59

property base1d_dzeta_ipzeta#

Element base1d_dzeta_ipzeta ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 63

property base1d_ipthet#

Element base1d_ipthet ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 57

property base1d_ipzeta#

Element base1d_ipzeta ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 61

property base_dthet_ip#

Element base_dthet_ip ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 53

property base_dzeta_ip#

Element base_dzeta_ip ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 54

property base_ip#

Element base_ip ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 52

change_base(self, old_fbase, iterdim, old_data, sf_data)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 494-592

Parameters:

  • sf (T_Fbase)

  • old_fbase (T_Fbase)

  • iterdim (int32)

  • old_data (float array)

  • sf_data (float array)

compare(self, tocompare[, is_same, cond_out])#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 463-485

Parameters:

  • sf (T_Fbase)

  • tocompare (T_Fbase)

  • is_same (bool)

  • cond_out (int32 array)

copy(self, tocopy)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 428-457

Parameters:

  • sf (T_Fbase)

  • tocopy (T_Fbase)

property cos_range#

Element cos_range ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 43

property d_thet#

Element d_thet ftype=real(wp) pytype=float64 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 45

property d_zeta#

Element d_zeta ftype=real(wp) pytype=float64 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 46

eval(deriv, x, interface_call=False)#

base_x = eval(self, deriv, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 598-608

Parameters:

  • sf (T_Fbase)

  • deriv (int32)

  • x (float array)

Returns:

base_x

Return type:

float array

eval_xn(deriv, np, xn, interface_call=False)#

base_xn = eval_xn(self, deriv, np, xn) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 614-675

Parameters:

  • sf (T_Fbase)

  • deriv (int32)

  • np (int32)

  • xn (float array)

Returns:

base_xn

Return type:

float array

evaldof_ip(deriv, dofs, interface_call=False)#

y_ip = evaldof_ip(self, deriv, dofs) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 1024-1078

Parameters:

  • sf (T_Fbase)

  • deriv (int32)

  • dofs (float array)

Returns:

y_ip

Return type:

float array

evaldof_x(x, deriv, dofs, interface_call=False)#

y = evaldof_x(self, x, deriv, dofs) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 808-824

Parameters:

  • sf (T_Fbase)

  • x (float array)

  • deriv (int32)

  • dofs (float array)

Returns:

y

Return type:

float64

evaldof_xn(np, xn, deriv, dofs, interface_call=False)#

y = evaldof_xn(self, np, xn, deriv, dofs) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 830-847

Parameters:

  • sf (T_Fbase)

  • np (int32)

  • xn (float array)

  • deriv (int32)

  • dofs (float array)

Returns:

y

Return type:

float array

evaldof_xn_tens(nthet, nzeta, thet, zeta, deriv, dofs, interface_call=False)#

y = evaldof_xn_tens(self, nthet, nzeta, thet, zeta, deriv, dofs) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 862-921

Parameters:

  • sf (T_Fbase)

  • nthet (int32)

  • nzeta (int32)

  • thet (float array)

  • zeta (float array)

  • deriv (int32)

  • dofs (float array)

Returns:

y

Return type:

float array

property exclude_mn_zero#

Element exclude_mn_zero ftype=logical pytype=bool Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 32

init(self, mn_max_in, mn_nyq_in, nfp_in, sin_cos_in, exclude_mn_zero_in)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 116-356

Parameters:

  • sf (T_Fbase)

  • mn_max_in (int array)

  • mn_nyq_in (int array)

  • nfp_in (int32)

  • sin_cos_in (str)

  • exclude_mn_zero_in (bool)

initdof(g_ip, thet_zeta_start=None, interface_call=False)#

dofs = initdof(self, g_ip[, thet_zeta_start]) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 1153-1174

Parameters:

  • sf (T_Fbase)

  • g_ip (float array)

  • thet_zeta_start (float array)

Returns:

dofs

Return type:

float array

property initialized#

Element initialized ftype=logical pytype=bool Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 40

property mn_ip#

Element mn_ip ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 28

property mn_max#

Element mn_max ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 26

property mn_nyq#

Element mn_nyq ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 27

property mn_zero_mode#

Element mn_zero_mode ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 44

property modes#

Element modes ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 34

property modes_end#

Element modes_end ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 35

property modes_str#

Element modes_str ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 35

property mtotal1d#

Element mtotal1d ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 56

property nfp#

Element nfp ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 29

property offset_modes#

Element offset_modes ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 36

projectiptodof(self, add, factor, deriv, y_ip, dofs)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 1084-1147

Parameters:

  • sf (T_Fbase)

  • add (bool)

  • factor (float64)

  • deriv (int32)

  • y_ip (float array)

  • dofs (float array)

projectxntodof(self, add, factor, deriv, np, xn, yn, dofs)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 lines 990-1009

Parameters:

  • sf (T_Fbase)

  • add (bool)

  • factor (float64)

  • deriv (int32)

  • np (int32)

  • xn (float array)

  • yn (float array)

  • dofs (float array)

property sin_cos#

Element sin_cos ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 30

property sin_range#

Element sin_range ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 42

property snorm_base#

Element snorm_base ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 55

property thet_ip#

Element thet_ip ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 50

property whichrank#

Element whichrank ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 38

property x_ip#

Element x_ip ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 49

property xmn#

Element xmn ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 47

property zero_odd_even#

Element zero_odd_even ftype=integer pytype=int array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 48

property zeta_ip#

Element zeta_ip ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/base/fbase.F90 line 51

class gvec.lib.Modgvec_Newton#

Bases: FortranModule

Module modgvec_newton Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 13-417

static FR(instance, *args, **kwargs)#
static FRdFR(instance, *args, **kwargs)#
class c_newton_Min1D(parent, handle=None)#

Bases: FortranDerivedType

Type(name=c_newton_min1d) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 33-37

FR(x, interface_call=False)#

y1x1 = FR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 73-78

Parameters:

  • sf (C_Newton_Min1D)

  • x (float64)

Returns:

y1x1

Return type:

float64

dFR(x, interface_call=False)#

y1x1 = dFR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 73-78

Parameters:

  • sf (C_Newton_Min1D)

  • x (float64)

Returns:

y1x1

Return type:

float64

ddFR(x, interface_call=False)#

y1x1 = ddFR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 73-78

Parameters:

  • sf (C_Newton_Min1D)

  • x (float64)

Returns:

y1x1

Return type:

float64

class c_newton_Min2D#

Bases: FortranDerivedType

Type(name=c_newton_min2d) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 61-65

FR(x, interface_call=False)#

y1x2 = FR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 94-99

Parameters:

  • sf (C_Newton_Min2D)

  • x (float array)

Returns:

y1x2

Return type:

float64

dFR(x, interface_call=False)#

y2x2 = dFR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 101-106

Parameters:

  • sf (C_Newton_Min2D)

  • x (float array)

Returns:

y2x2

Return type:

float array

ddFR(x, interface_call=False)#

y22x2 = ddFR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 108-113

Parameters:

  • sf (C_Newton_Min2D)

  • x (float array)

Returns:

y22x2

Return type:

float array

class c_newton_Root1D#

Bases: FortranDerivedType

Type(name=c_newton_root1d) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 39-42

FR(x, interface_call=False)#

y1x1 = FR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 80-85

Parameters:

  • sf (C_Newton_Root1D)

  • x (float64)

Returns:

y1x1

Return type:

float64

dFR(x, interface_call=False)#

y1x1 = dFR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 80-85

Parameters:

  • sf (C_Newton_Root1D)

  • x (float64)

Returns:

y1x1

Return type:

float64

class c_newton_Root1D_FdF#

Bases: FortranDerivedType

Type(name=c_newton_root1d_fdf) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 57-59

FRdFR(x, interface_call=False)#

y2x1 = FRdFR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 87-92

Parameters:

  • sf (C_Newton_Root1D_Fdf)

  • x (float64)

Returns:

y2x1

Return type:

float array

class c_newton_Root2D#

Bases: FortranDerivedType

Type(name=c_newton_root2d) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 67-70

FR(x, interface_call=False)#

y2x2 = FR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 115-120

Parameters:

  • sf (C_Newton_Root2D)

  • x (float array)

Returns:

y2x2

Return type:

float array

dFR(x, interface_call=False)#

y22x2 = dFR(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 122-127

Parameters:

  • sf (C_Newton_Root2D)

  • x (float array)

Returns:

y22x2

Return type:

float array

static dFR(instance, *args, **kwargs)#
static ddFR(instance, *args, **kwargs)#
static dfr(instance, *args, **kwargs)#
static fr(instance, *args, **kwargs)#
static newtonmin1d(tol, a, b, maxstep, x, fobj, interface_call=False)#

fmin = newtonmin1d(tol, a, b, maxstep, x, fobj) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 136-155

Parameters:

  • tol (float64)

  • a (float64)

  • b (float64)

  • maxstep (float64)

  • x (float64)

  • fobj (C_Newton_Min1D)

Returns:

fmin

Return type:

float64

static newtonmin2d(tol, a, b, x, fobj, interface_call=False)#

fmin = newtonmin2d(tol, a, b, x, fobj) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 326-364

Parameters:

  • tol (float64)

  • a (float array)

  • b (float array)

  • x (float array)

  • fobj (C_Newton_Min2D)

Returns:

fmin

Return type:

float64

static newtonroot1d(tol, a, b, maxstep, xin, f0, fobj, interface_call=False)#

xout = newtonroot1d(tol, a, b, maxstep, xin, f0, fobj) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 205-257

Parameters:

  • tol (float64)

  • a (float64)

  • b (float64)

  • maxstep (float64)

  • xin (float64)

  • f0 (float64)

  • fobj (C_Newton_Root1D)

Returns:

xout

Return type:

float64

static newtonroot1d_fdf(tol, a, b, maxstep, xin, f0, fobj, interface_call=False)#

xout = newtonroot1d_fdf(tol, a, b, maxstep, xin, f0, fobj) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 263-319

Parameters:

  • tol (float64)

  • a (float64)

  • b (float64)

  • maxstep (float64)

  • xin (float64)

  • f0 (float64)

  • fobj (C_Newton_Root1D_Fdf)

Returns:

xout

Return type:

float64

static newtonroot2d(tol, a, b, maxstep, xin, fobj, interface_call=False)#

xout = newtonroot2d(tol, a, b, maxstep, xin, fobj) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 372-417

Parameters:

  • tol (float64)

  • a (float array)

  • b (float array)

  • maxstep (float array)

  • xin (float array)

  • fobj (C_Newton_Root2D)

Returns:

xout

Return type:

float array

class t_newton_Root1D_wrap_Min1D(handle=None)#

Bases: c_newton_Root1D

Type(name=t_newton_root1d_wrap_min1d) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 48-52

dfr(x, interface_call=False)#

y1x1 = dfr(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 190-199

Parameters:

  • sf (T_Newton_Root1D_Wrap_Min1D)

  • x (float64)

Returns:

y1x1

Return type:

float64

fr(x, interface_call=False)#

y1x1 = fr(self, x) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 lines 175-184

Parameters:

  • sf (T_Newton_Root1D_Wrap_Min1D)

  • x (float64)

Returns:

y1x1

Return type:

float64

property parent#

Element parent ftype=class(c_newton_min1d) pytype=C_Newton_Min1D Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/globals/newton.F90 line 49

class gvec.lib.Modgvec_Py_Binding#

Bases: FortranModule

Module modgvec_py_binding Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/binding.F90 lines 6-50

static flush_stdout()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/binding.F90 lines 32-42

static redirect_abort()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/binding.F90 lines 45-50

static redirect_stdout(filename)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/binding.F90 lines 16-29

Parameters:

filename (str)

class gvec.lib.Modgvec_Py_Run#

Bases: FortranModule

Module modgvec_py_run Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/run.F90 lines 6-67

static cleanup()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/run.F90 lines 46-67

get_initialized()#
property initialized#

Element initialized ftype=logical pytype=bool Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/run.F90 line 13

set_initialized(value)#
static start_rungvec(parameterfile[, restartfile_in, comm_in])#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/run.F90 lines 16-43

Parameters:

  • parameterfile (str)

  • restartfile_in (str)

  • comm_in (int32)

class gvec.lib.Modgvec_Py_State#

Bases: FortranModule

Module modgvec_py_state Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 6-984

static evaluate_base_list_stz_all(n_stz, s, thetazeta, qsel, q, dq_ds, dq_dthet, dq_dzeta, dq_dss, dq_dst, dq_dsz, dq_dtt, dq_dtz, dq_dzz)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 365-404

Parameters:

  • n_stz (int32)

  • s (float array)

  • thetazeta (float array)

  • qsel (str)

  • q (float array)

  • dq_ds (float array)

  • dq_dthet (float array)

  • dq_dzeta (float array)

  • dq_dss (float array)

  • dq_dst (float array)

  • dq_dsz (float array)

  • dq_dtt (float array)

  • dq_dtz (float array)

  • dq_dzz (float array)

static evaluate_base_list_tz(n_s, n_tz, s, thetazeta, var, sel_deriv_s, sel_deriv_f, result)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 287-314

Parameters:

  • n_s (int32)

  • n_tz (int32)

  • s (float array)

  • thetazeta (float array)

  • var (str)

  • sel_deriv_s (str)

  • sel_deriv_f (str)

  • result (float array)

static evaluate_base_list_tz_all(n_s, n_tz, s, thetazeta, qsel, q, dq_ds, dq_dthet, dq_dzeta, dq_dss, dq_dst, dq_dsz, dq_dtt, dq_dtz, dq_dzz)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 320-359

Parameters:

  • n_s (int32)

  • n_tz (int32)

  • s (float array)

  • thetazeta (float array)

  • qsel (str)

  • q (float array)

  • dq_ds (float array)

  • dq_dthet (float array)

  • dq_dzeta (float array)

  • dq_dss (float array)

  • dq_dst (float array)

  • dq_dsz (float array)

  • dq_dtt (float array)

  • dq_dtz (float array)

  • dq_dzz (float array)

static evaluate_base_tens(s, theta, zeta, var, sel_deriv_s, sel_deriv_f, result)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 409-439

Parameters:

  • s (float array)

  • theta (float array)

  • zeta (float array)

  • var (str)

  • sel_deriv_s (str)

  • sel_deriv_f (str)

  • result (float array)

static evaluate_base_tens_all(n_s, n_t, n_z, s, theta, zeta, qsel, q, dq_ds, dq_dthet, dq_dzeta, dq_dss, dq_dst, dq_dsz, dq_dtt, dq_dtz, dq_dzz)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 445-484

Parameters:

  • n_s (int32)

  • n_t (int32)

  • n_z (int32)

  • s (float array)

  • theta (float array)

  • zeta (float array)

  • qsel (str)

  • q (float array)

  • dq_ds (float array)

  • dq_dthet (float array)

  • dq_dzeta (float array)

  • dq_dss (float array)

  • dq_dst (float array)

  • dq_dsz (float array)

  • dq_dtt (float array)

  • dq_dtz (float array)

  • dq_dzz (float array)

static evaluate_boozer_list_tz_all(self, n_s, n_tz, irho, thetazeta, qsel, q, dq_dthet, dq_dzeta, dq_dtt, dq_dtz, dq_dzz)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 921-960

Parameters:

  • sfl_boozer (T_Sfl_Boozer)

  • n_s (int32)

  • n_tz (int32)

  • irho (int array)

  • thetazeta (float array)

  • qsel (str)

  • q (float array)

  • dq_dthet (float array)

  • dq_dzeta (float array)

  • dq_dtt (float array)

  • dq_dtz (float array)

  • dq_dzz (float array)

static evaluate_hmap(n, x1, x2, zeta, dx1_ds, dx2_ds, dx1_dthet, dx2_dthet, dx1_dzeta, dx2_dzeta, coord, e_s, e_thet, e_zeta)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 514-542

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • dx1_ds (float array)

  • dx2_ds (float array)

  • dx1_dthet (float array)

  • dx2_dthet (float array)

  • dx1_dzeta (float array)

  • dx2_dzeta (float array)

  • coord (float array)

  • e_s (float array)

  • e_thet (float array)

  • e_zeta (float array)

static evaluate_hmap_derivs(n, x1, x2, zeta, k_11, k_12, k_13, k_22, k_23, k_33)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 701-723

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • k_11 (float array)

  • k_12 (float array)

  • k_13 (float array)

  • k_22 (float array)

  • k_23 (float array)

  • k_33 (float array)

static evaluate_hmap_only(n, x1, x2, zeta, pos, dx_dq1, dx_dq2, dx_dq3)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 567-590

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • pos (float array)

  • dx_dq1 (float array)

  • dx_dq2 (float array)

  • dx_dq3 (float array)

static evaluate_hmap_only_pw(n, x1, x2, zeta, pos, dx_dq1, dx_dq2, dx_dq3)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 547-562

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • pos (float array)

  • dx_dq1 (float array)

  • dx_dq2 (float array)

  • dx_dq3 (float array)

static evaluate_hmap_pw(n, x1, x2, zeta, dx1_ds, dx2_ds, dx1_dthet, dx2_dthet, dx1_dzeta, dx2_dzeta, coord, e_s, e_thet, e_zeta)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 489-509

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • dx1_ds (float array)

  • dx2_ds (float array)

  • dx1_dthet (float array)

  • dx2_dthet (float array)

  • dx1_dzeta (float array)

  • dx2_dzeta (float array)

  • coord (float array)

  • e_s (float array)

  • e_thet (float array)

  • e_zeta (float array)

static evaluate_jac_h_derivs(n, x1, x2, zeta, dx1_ds, dx2_ds, dx1_dt, dx2_dt, dx1_dz, dx2_dz, djh_ds, djh_dt, djh_dz)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 749-773

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • dx1_ds (float array)

  • dx2_ds (float array)

  • dx1_dt (float array)

  • dx2_dt (float array)

  • dx1_dz (float array)

  • dx2_dz (float array)

  • djh_ds (float array)

  • djh_dt (float array)

  • djh_dz (float array)

static evaluate_jac_h_derivs_pw(n, x1, x2, zeta, dx1_ds, dx2_ds, dx1_dt, dx2_dt, dx1_dz, dx2_dz, djh_ds, djh_dt, djh_dz)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 728-744

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • dx1_ds (float array)

  • dx2_ds (float array)

  • dx1_dt (float array)

  • dx2_dt (float array)

  • dx1_dz (float array)

  • dx2_dz (float array)

  • djh_ds (float array)

  • djh_dt (float array)

  • djh_dz (float array)

static evaluate_metric_derivs(n, x1, x2, zeta, dx1_ds, dx2_ds, dx1_dt, dx2_dt, dx1_dz, dx2_dz, dx1_dss, dx2_dss, dx1_dst, dx2_dst, dx1_dsz, dx2_dsz, dx1_dtt, dx2_dtt, dx1_dtz, dx2_dtz, dx1_dzz, dx2_dzz, dg_ss_ds, dg_st_ds, dg_sz_ds, dg_tt_ds, dg_tz_ds, dg_zz_ds, dg_ss_dt, dg_st_dt, dg_sz_dt, dg_tt_dt, dg_tz_dt, dg_zz_dt, dg_ss_dz, dg_st_dz, dg_sz_dz, dg_tt_dz, dg_tz_dz, dg_zz_dz)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 600-696

Parameters:

  • n (int32)

  • x1 (float array)

  • x2 (float array)

  • zeta (float array)

  • dx1_ds (float array)

  • dx2_ds (float array)

  • dx1_dt (float array)

  • dx2_dt (float array)

  • dx1_dz (float array)

  • dx2_dz (float array)

  • dx1_dss (float array)

  • dx2_dss (float array)

  • dx1_dst (float array)

  • dx2_dst (float array)

  • dx1_dsz (float array)

  • dx2_dsz (float array)

  • dx1_dtt (float array)

  • dx2_dtt (float array)

  • dx1_dtz (float array)

  • dx2_dtz (float array)

  • dx1_dzz (float array)

  • dx2_dzz (float array)

  • dg_ss_ds (float array)

  • dg_st_ds (float array)

  • dg_sz_ds (float array)

  • dg_tt_ds (float array)

  • dg_tz_ds (float array)

  • dg_zz_ds (float array)

  • dg_ss_dt (float array)

  • dg_st_dt (float array)

  • dg_sz_dt (float array)

  • dg_tt_dt (float array)

  • dg_tz_dt (float array)

  • dg_zz_dt (float array)

  • dg_ss_dz (float array)

  • dg_st_dz (float array)

  • dg_sz_dz (float array)

  • dg_tt_dz (float array)

  • dg_tz_dz (float array)

  • dg_zz_dz (float array)

static evaluate_profile(n_s, s, deriv, var, result)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 812-854

Parameters:

  • n_s (int32)

  • s (float array)

  • deriv (int32)

  • var (str)

  • result (float array)

static evaluate_rho2_profile(n_s, rho2, deriv, var, result)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 778-807

Parameters:

  • n_s (int32)

  • rho2 (float array)

  • deriv (int32)

  • var (str)

  • result (float array)

static finalize()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 963-984

static find_pest_angles_2d(n_s, s, n_tz, tz_pest, tz_out)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 894-915

Parameters:

  • n_s (int32)

  • s (float array)

  • n_tz (int32)

  • tz_pest (float array)

  • tz_out (float array)

static get_boozer(self)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 880-889

Parameters:

sfl_boozer (T_Sfl_Boozer)

get_initialized()#
static get_integration_points(var, s_gp, s_w, interface_call=False)#

t_w, z_w = get_integration_points(var, s_gp, s_w) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 211-226

Parameters:

  • var (str)

  • s_gp (float array)

  • s_w (float array)

Returns:

  • t_w (float64)

  • z_w (float64)

static get_integration_points_num(var, interface_call=False)#

n_s, n_t, n_z = get_integration_points_num(var) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 190-206

Parameters:

var (str)

Returns:

  • n_s (int32)

  • n_t (int32)

  • n_z (int32)

static get_mn_ip(var, interface_call=False)#

mn_ip = get_mn_ip(var) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 252-260

Parameters:

var (str)

Returns:

mn_ip

Return type:

int32

static get_mn_max(var, interface_call=False)#

m_max, n_max = get_mn_max(var) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 240-249

Parameters:

var (str)

Returns:

  • m_max (int32)

  • n_max (int32)

static get_modes(var, interface_call=False)#

modes = get_modes(var) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 229-237

Parameters:

var (str)

Returns:

modes

Return type:

int32

get_nfp()#
static get_s_ip(var, s_ip)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 274-282

Parameters:

  • var (str)

  • s_ip (float array)

static get_s_nbase(var, interface_call=False)#

s_nbase = get_s_nbase(var) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 263-271

Parameters:

var (str)

Returns:

s_nbase

Return type:

int32

static init(parameterfile)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 17-62

Parameters:

parameterfile (str)

static init_boozer(mn_max, mn_nyq, sin_cos, nrho, rho_pos, relambda, interface_call=False)#

sfl_boozer = init_boozer(mn_max, mn_nyq, sin_cos, nrho, rho_pos, relambda) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 860-878

Parameters:

  • mn_max (int array)

  • mn_nyq (int array)

  • sin_cos (str)

  • nrho (int32)

  • rho_pos (float array)

  • relambda (bool)

Returns:

sfl_boozer

Return type:

T_Sfl_Boozer

property initialized#

Element initialized ftype=logical pytype=bool Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 line 13

static initsolution()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 65-69

static minimize([dt_in])#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 87-99

Parameters:

dt_in (float64)

property nfp#

Element nfp ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 line 14

static readstate(statefile)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/pygvec/state.F90 lines 72-84

Parameters:

statefile (str)

set_initialized(value)#
set_nfp(value)#
class gvec.lib.Modgvec_Rprofile_Base#

Bases: FortranModule

Module modgvec_rprofile_base Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 12-174

static antiderivative(instance, *args, **kwargs)#
class c_rProfile#

Bases: FortranDerivedType

Type(name=c_rprofile) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 17-27

antiderivative(interface_call=False)#

antideriv = antiderivative(self) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 38-42

Parameters:

sf (C_Rprofile)

Returns:

antideriv

Return type:

C_Rprofile

property coefs#

Element coefs ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 line 19

eval_at_rho(rho, deriv=None, interface_call=False)#

derivative = eval_at_rho(self, rho[, deriv]) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 143-174

Parameters:

  • sf (C_Rprofile)

  • rho (float64)

  • deriv (int32)

Returns:

derivative

Return type:

float64

eval_at_rho2(rho2, deriv=None, interface_call=False)#

profile_value = eval_at_rho2(self, rho2[, deriv]) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 30-36

Parameters:

  • sf (C_Rprofile)

  • rho2 (float64)

  • deriv (int32)

Returns:

profile_value

Return type:

float64

property n_coefs#

Element n_coefs ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 line 18

rprofile_drho2(rho, interface_call=False)#

derivative = rprofile_drho2(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 81-93

Parameters:

  • sf (C_Rprofile)

  • rho (float64)

Returns:

derivative

Return type:

float64

rprofile_drho3(rho, interface_call=False)#

derivative = rprofile_drho3(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 99-112

Parameters:

  • sf (C_Rprofile)

  • rho (float64)

Returns:

derivative

Return type:

float64

rprofile_drho4(rho, interface_call=False)#

derivative = rprofile_drho4(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 118-137

Parameters:

  • sf (C_Rprofile)

  • rho (float64)

Returns:

derivative

Return type:

float64

static eval_at_rho(instance, *args, **kwargs)#
static eval_at_rho2(instance, *args, **kwargs)#
static poly_derivative_prefactor(d, deriv, interface_call=False)#

prefactor = poly_derivative_prefactor(d, deriv) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 50-58

Parameters:

  • d (int32)

  • deriv (int32)

Returns:

prefactor

Return type:

float64

static rho2_derivative(rho, deriv, interface_call=False)#

rho2_prime = rho2_derivative(rho, deriv) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 64-75

Parameters:

  • rho (float64)

  • deriv (int32)

Returns:

rho2_prime

Return type:

float64

static rprofile_drho2(instance, *args, **kwargs)#
static rprofile_drho3(instance, *args, **kwargs)#
static rprofile_drho4(instance, *args, **kwargs)#
class gvec.lib.Modgvec_Rprofile_Bspl#

Bases: FortranModule

Module modgvec_rprofile_bspl Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_bspline.F90 lines 12-143

static antiderivative(instance, *args, **kwargs)#
static eval_at_rho(instance, *args, **kwargs)#
static eval_at_rho2(instance, *args, **kwargs)#
static rprofile_drho2(instance, *args, **kwargs)#
static rprofile_drho3(instance, *args, **kwargs)#
static rprofile_drho4(instance, *args, **kwargs)#
class t_rProfile_bspl(knots, coefs, handle=None)#

Bases: c_rProfile

Type(name=t_rprofile_bspl) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_bspline.F90 lines 19-29

antiderivative(interface_call=False)#

antideriv = antiderivative(self) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_bspline.F90 lines 106-128

Parameters:

sf (T_Rprofile_Bspl)

Returns:

antideriv

Return type:

C_Rprofile

property deg#

Element deg ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_bspline.F90 line 22

eval_at_rho(rho, deriv=None, interface_call=False)#

derivative = eval_at_rho(self, rho[, deriv]) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 143-174

Parameters:

  • sf (T_Rprofile_Bspl)

  • rho (float64)

  • deriv (int32)

Returns:

derivative

Return type:

float64

eval_at_rho2(rho2, deriv=None, interface_call=False)#

profile_prime_value = eval_at_rho2(self, rho2[, deriv]) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_bspline.F90 lines 75-97

Parameters:

  • sf (T_Rprofile_Bspl)

  • rho2 (float64)

  • deriv (int32)

Returns:

profile_prime_value

Return type:

float64

property knots#

Element knots ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_bspline.F90 line 23

property n_knots#

Element n_knots ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_bspline.F90 line 20

rprofile_drho2(rho, interface_call=False)#

derivative = rprofile_drho2(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 81-93

Parameters:

  • sf (T_Rprofile_Bspl)

  • rho (float64)

Returns:

derivative

Return type:

float64

rprofile_drho3(rho, interface_call=False)#

derivative = rprofile_drho3(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 99-112

Parameters:

  • sf (T_Rprofile_Bspl)

  • rho (float64)

Returns:

derivative

Return type:

float64

rprofile_drho4(rho, interface_call=False)#

derivative = rprofile_drho4(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 118-137

Parameters:

  • sf (T_Rprofile_Bspl)

  • rho (float64)

Returns:

derivative

Return type:

float64

class gvec.lib.Modgvec_Rprofile_Poly#

Bases: FortranModule

Module modgvec_rprofile_poly Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_polynomial.F90 lines 12-109

static antiderivative(instance, *args, **kwargs)#
static eval_at_rho(instance, *args, **kwargs)#
static eval_at_rho2(instance, *args, **kwargs)#
static rprofile_drho2(instance, *args, **kwargs)#
static rprofile_drho3(instance, *args, **kwargs)#
static rprofile_drho4(instance, *args, **kwargs)#
class t_rProfile_poly(coefs, handle=None)#

Bases: c_rProfile

Type(name=t_rprofile_poly) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_polynomial.F90 lines 18-25

antiderivative(interface_call=False)#

antideriv = antiderivative(self) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_polynomial.F90 lines 86-99

Parameters:

sf (T_Rprofile_Poly)

Returns:

antideriv

Return type:

C_Rprofile

property deg#

Element deg ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_polynomial.F90 line 20

eval_at_rho(rho, deriv=None, interface_call=False)#

derivative = eval_at_rho(self, rho[, deriv]) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 143-174

Parameters:

  • sf (T_Rprofile_Poly)

  • rho (float64)

  • deriv (int32)

Returns:

derivative

Return type:

float64

eval_at_rho2(rho2, deriv=None, interface_call=False)#

profile_prime_value = eval_at_rho2(self, rho2[, deriv]) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/rprofile_polynomial.F90 lines 49-80

Parameters:

  • sf (T_Rprofile_Poly)

  • rho2 (float64)

  • deriv (int32)

Returns:

profile_prime_value

Return type:

float64

rprofile_drho2(rho, interface_call=False)#

derivative = rprofile_drho2(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 81-93

Parameters:

  • sf (T_Rprofile_Poly)

  • rho (float64)

Returns:

derivative

Return type:

float64

rprofile_drho3(rho, interface_call=False)#

derivative = rprofile_drho3(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 99-112

Parameters:

  • sf (T_Rprofile_Poly)

  • rho (float64)

Returns:

derivative

Return type:

float64

rprofile_drho4(rho, interface_call=False)#

derivative = rprofile_drho4(self, rho) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/profiles/c_rprofile.F90 lines 118-137

Parameters:

  • sf (T_Rprofile_Poly)

  • rho (float64)

Returns:

derivative

Return type:

float64

class gvec.lib.Modgvec_Sfl_Boozer#

Bases: FortranModule

Module modgvec_sfl_boozer Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 lines 13-516

static find_angles(instance, *args, **kwargs)#
static find_angles_irho(instance, *args, **kwargs)#
static find_boozer_angles(nrho, iota, fbase_in, la_in, nu_in, tz_dim, tz_boozer, thetzeta_out)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 lines 407-461

Parameters:

  • nrho (int32)

  • iota (float array)

  • fbase_in (T_Fbase)

  • la_in (float array)

  • nu_in (float array)

  • tz_dim (int32)

  • tz_boozer (float array)

  • thetzeta_out (float array)

class t_sfl_boozer(handle=None)#

Bases: FortranDerivedType

Type(name=t_sfl_boozer) Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 lines 27-49

find_angles(self, tz_dim, tz_boozer, thetzeta_out)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 lines 364-374

Parameters:

  • sf (T_Sfl_Boozer)

  • tz_dim (int32)

  • tz_boozer (float array)

  • thetzeta_out (float array)

find_angles_irho(self, irho, tz_dim, tz_boozer, thetzeta_out)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 lines 380-391

Parameters:

  • sf (T_Sfl_Boozer)

  • irho (int32)

  • tz_dim (int32)

  • tz_boozer (float array)

  • thetzeta_out (float array)

property initialized#

Element initialized ftype=logical pytype=bool Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 29

property iota#

Element iota ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 35

property lambda_#

Element lambda_ ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 37

property nrho#

Element nrho ftype=integer pytype=int32 Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 32

property nu#

Element nu ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 37

property nu_fbase#

Element nu_fbase ftype=type(t_fbase) pytype=T_Fbase Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 34

property phiprime#

Element phiprime ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 35

property relambda#

Element relambda ftype=logical pytype=bool Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 33

property rho_pos#

Element rho_pos ftype=real(wp) pytype=float array Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/develop/src/transform_sfl/sfl_boozer.F90 line 35

On this page
Show Source