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_Py_Binding#

Bases: FortranModule

Module modgvec_py_binding

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/binding.f90 lines 6-49

static flush_stdout()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/binding.f90 lines 32-42

static redirect_abort()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/binding.f90 lines 45-49

static redirect_stdout(filename)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/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/v1.2/src/pygvec/run.f90 lines 6-39

property initialized#

Element initialized ftype=logical pytype=bool

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/run.f90 line 12

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

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/run.f90 lines 15-39

Parameters:

  • parameterfile (str)

  • restartfile_in (str)

  • comm_in (int)

class gvec.lib.Modgvec_Py_State#

Bases: FortranModule

Module modgvec_py_state

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 6-902

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/v1.2/src/pygvec/state.f90 lines 338-377

Parameters:

  • n_stz (int)

  • 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/v1.2/src/pygvec/state.f90 lines 260-287

Parameters:

  • n_s (int)

  • n_tz (int)

  • 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/v1.2/src/pygvec/state.f90 lines 293-332

Parameters:

  • n_s (int)

  • n_tz (int)

  • 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/v1.2/src/pygvec/state.f90 lines 382-412

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/v1.2/src/pygvec/state.f90 lines 418-457

Parameters:

  • n_s (int)

  • n_t (int)

  • n_z (int)

  • 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/v1.2/src/pygvec/state.f90 lines 838-878

Parameters:

  • sfl_boozer (T_Sfl_Boozer)

  • n_s (int)

  • n_tz (int)

  • 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/v1.2/src/pygvec/state.f90 lines 488-517

Parameters:

  • n (int)

  • 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_only(n, x1, x2, zeta, pos, dx_dq1, dx_dq2, dx_dq3)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 543-567

Parameters:

  • n (int)

  • 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/v1.2/src/pygvec/state.f90 lines 522-538

Parameters:

  • n (int)

  • 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/v1.2/src/pygvec/state.f90 lines 462-483

Parameters:

  • n (int)

  • 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/v1.2/src/pygvec/state.f90 lines 701-726

Parameters:

  • n (int)

  • 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/v1.2/src/pygvec/state.f90 lines 679-696

Parameters:

  • n (int)

  • 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/v1.2/src/pygvec/state.f90 lines 577-674

Parameters:

  • n (int)

  • 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/v1.2/src/pygvec/state.f90 lines 766-797

Parameters:

  • n_s (int)

  • s (float array)

  • deriv (int)

  • 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/v1.2/src/pygvec/state.f90 lines 731-761

Parameters:

  • n_s (int)

  • rho2 (float array)

  • deriv (int)

  • var (str)

  • result (float array)

static finalize()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 881-902

static get_boozer(self)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 824-832

Parameters:

sfl_boozer (T_Sfl_Boozer)

static get_integration_points(var, s_gp, s_w)#

t_w, z_w = get_integration_points(var, s_gp, s_w)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 184-199

Parameters:

  • var (str)

  • s_gp (float array)

  • s_w (float array)

Returns:

  • t_w (float)

  • z_w (float)

static get_integration_points_num(var)#

n_s, n_t, n_z = get_integration_points_num(var)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 162-179

Parameters:

var (str)

Returns:

  • n_s (int)

  • n_t (int)

  • n_z (int)

static get_mn_ip(var)#

mn_ip = get_mn_ip(var)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 225-233

Parameters:

var (str)

Returns:

mn_ip

Return type:

int

static get_mn_max(var)#

m_max, n_max = get_mn_max(var)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 213-222

Parameters:

var (str)

Returns:

  • m_max (int)

  • n_max (int)

static get_modes(var)#

modes = get_modes(var)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 202-210

Parameters:

var (str)

Returns:

modes

Return type:

int

static get_s_ip(var, s_ip)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 247-255

Parameters:

  • var (str)

  • s_ip (float array)

static get_s_nbase(var)#

s_nbase = get_s_nbase(var)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 236-244

Parameters:

var (str)

Returns:

s_nbase

Return type:

int

static init(parameterfile)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 16-50

Parameters:

parameterfile (str)

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

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/v1.2/src/pygvec/state.f90 lines 803-822

Parameters:

  • mn_max (int array)

  • mn_nyq (int array)

  • sin_cos (str)

  • nrho (int)

  • 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/v1.2/src/pygvec/state.f90 line 12

static initsolution()#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 53-55

property nfp#

Element nfp ftype=integer pytype=int

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 line 13

static readstate(statefile)#

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/pygvec/state.f90 lines 58-69

Parameters:

statefile (str)

class gvec.lib.Modgvec_Sfl_Boozer#

Bases: FortranModule

Module modgvec_sfl_boozer

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 lines 13-518

class t_sfl_boozer(handle=None)#

Bases: FortranDerivedType

Type(name=t_sfl_boozer)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 lines 27-49

find_angles(tz_dim, tz_boozer, thetzeta_out)#

find_angles__binding__t_sfl_boozer(self, tz_dim, tz_boozer, thetzeta_out)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 lines 358-370

Parameters:

  • sf (T_Sfl_Boozer)

  • tz_dim (int)

  • tz_boozer (float array)

  • thetzeta_out (float array)

  • ----------------------------------------------------------------------------------------------------------------------------------- – INPUT VARIABLES

find_angles_irho(irho, tz_dim, tz_boozer, thetzeta_out)#

find_angles_irho__binding__t_sfl_boozer(self, irho, tz_dim, tz_boozer, thetzeta_out)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 lines 376-389

Parameters:

  • sf (T_Sfl_Boozer)

  • irho (int)

  • tz_dim (int)

  • tz_boozer (float array)

  • thetzeta_out (float array)

  • ----------------------------------------------------------------------------------------------------------------------------------- – INPUT VARIABLES

free()#

free__binding__t_sfl_boozer(self)

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 lines 116-126

Parameters:

  • sf (T_Sfl_Boozer)

  • =================================================================================================================================

property initialized#

Element initialized ftype=logical pytype=bool

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 line 29

property iota#

Element iota ftype=real(wp) pytype=float

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 line 35

property lambda_#

Element lambda_ ftype=real(wp) pytype=float

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 line 37

property nrho#

Element nrho ftype=integer pytype=int

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 line 32

property nu#

Element nu ftype=real(wp) pytype=float

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 line 37

property phiprime#

Element phiprime ftype=real(wp) pytype=float

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/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/v1.2/src/transform_sfl/sfl_boozer.f90 line 33

property rho_pos#

Element rho_pos ftype=real(wp) pytype=float

Defined at /home/docs/checkouts/readthedocs.org/user_builds/gvec/checkouts/v1.2/src/transform_sfl/sfl_boozer.f90 line 35

On this page
Show Source