Stellarator-Tools
VMEC Equilibrium Manual

Introduction

This page documents the V3FIT interface to the VMEC equilibrium solver. This lists all the parameters associated with a VMEC equilibrium. These parameters are divided input two types, reconstruction parameters and derived parameters. All parameters are documented in a table of the following form.

Input variableDescriptionCode Reference

VMEC Reconstruction Parameters

Reconstruction parameters are divided into two types, VMEC reconstruction parameters and auxillary parameters.

VMEC Equilibrium Reconstruction Parameters

VMEC Equilibrium reconstruction parameters are parameters that maybe reconstructed that change the equilibirum. These parameters require the equilibrium to reconverge.

ac1D Array of function current profile parameters.@ref vmec_input::ac
ac_aux_s1D Array of segment current profile s poitions.@ref vmec_input::ac_aux_s
ac_aux_f1D Array of segment current profile f values.@ref vmec_input::ac_aux_f
ai1D Array of function current profile parameters.@ref vmec_input::ai
ai_aux_s1D Array of segment iotabar profile s poitions.@ref vmec_input::ai_aux_s
ai_aux_f1D Array of segment iotabar profile f values.@ref vmec_input::ai_aux_f
am1D Array of function current profile parameters.@ref vmec_input::am
am_aux_s1D Array of segment pressure profile s poitions.@ref vmec_input::am_aux_s
am_aux_f1D Array of segment pressure profile f values.@ref vmec_input::am_aux_f
bloatExtends the field into the vacuum region.@ref vmec_input::bloat
rbc2D Array of outer boundary R cosine coeffiecents.@ref vmec_input::rbc
zbs2D Array of outer boundary Z sine coeffiecents.@ref vmec_input::zbs
rbs2D Array of outer boundary R sine coeffiecents.@ref vmec_input::rbs
zbc2D Array of outer boundary Z cosine coeffiecents.@ref vmec_input::zbc
extcur1D Array of external currents.@ref vmec_input::extcur
curtorToroidal current.@ref vmec_input::curtor
phiedgeThe edge magnetic flux.@ref vmec_input::phiedge
pres_scaleThe scaling parameter for the pressure.@ref vmec_input::pres_scale

VMEC Auxiliary Reconstruction Parameters

VMEC Auxiliary reconstruction parameters are parameters that maybe reconstructed that do not change the equilibirum. These parameters do not require the equilibrium to reconverge.

pp_ne_b1D Array of function density profile parameters.@ref pprofile_T::pprofile_class::b
pp_ne_as1D Array of segment density profile s poitions.@ref pprofile_T::pprofile_class::as
pp_ne_af1D Array of segment density profile f values.@ref pprofile_T::pprofile_class::af
pp_sxrem_b1D Array of function sxrem profile parameters. DEPREICATED only use id when using the old profile specification.@ref pprofile_T::pprofile_class::b
pp_sxrem_as1D Array of segment sxrem profile s poitions. DEPREICATED only use id when using the old profile specification.@ref pprofile_T::pprofile_class::as
pp_sxrem_af1D Array of segment sxrem profile f values. DEPREICATED only use id when using the old profile specification.@ref pprofile_T::pprofile_class::af
pp_sxrem_b_a2D Array of function sxrem profile parameters. First index is the profile number.@ref vmec_equilibrium::vmec_class::sxrem
pp_sxrem_as_a2D Array of segment sxrem profile s poitions. First index is the profile number.@ref vmec_equilibrium::vmec_class::sxrem
pp_sxrem_af_a2D Array of segment sxrem profile f values. First index is the profile number.@ref vmec_equilibrium::vmec_class::sxrem
pp_te_b1D Array of function electron temperature profile parameters.@ref pprofile_T::pprofile_class::b
pp_te_as1D Array of segment electron temperature profile s poitions.@ref pprofile_T::pprofile_class::as
pp_te_af1D Array of segment electron temperature profile f values.@ref pprofile_T::pprofile_class::af
pp_ti_b1D Array of function ion temperature profile parameters.@ref pprofile_T::pprofile_class::b
pp_ti_as1D Array of segment ion temperature profile s poitions.@ref pprofile_T::pprofile_class::as
pp_ti_af1D Array of segment ion temperature profile f values.@ref pprofile_T::pprofile_class::af
phi_offsetPhi angle offset in radians@ref vmec_equilibrium::vmec_class::phi_offset
z_offsetZ offset in meters@ref vmec_equilibrium::vmec_class::z_offset

VMEC Derived Parameters

Derived parameters are parameters that come from the equilibrium but are not reconstructable.

rmnc2D Array of surface R cosine coeffiecents.@ref read_wout_mod::rmnc
zmns2D Array of surface Z sine coeffiecents.@ref read_wout_mod::zmns
lmns2D Array of surface lambda sine coeffiecents.@ref read_wout_mod::lmns
gmnc2D Array of surface g cosine coeffiecents.@ref read_wout_mod::gmnc
bsubsmns2D Array of surface B_s sine coeffiecents.@ref read_wout_mod::bsubsmns
bsubumnc2D Array of surface B_u cosine coeffiecents.@ref read_wout_mod::bsubumnc
bsubvmnc2D Array of surface B_v cosine coeffiecents.@ref read_wout_mod::bsubvmnc
bsupumnc2D Array of surface B^u cosine coeffiecents.@ref read_wout_mod::bsupumnc
bsupvmnc2D Array of surface B^v cosine coeffiecents.@ref read_wout_mod::bsupvmnc
rmns2D Array of surface R sine coeffiecents.@ref read_wout_mod::rmns
zmnc2D Array of surface Z cosine coeffiecents.@ref read_wout_mod::zmnc
lmnc2D Array of surface lambda cosine coeffiecents.@ref read_wout_mod::lmnc
gmns2D Array of surface g sine coeffiecents.@ref read_wout_mod::gmns
bsubsmnc2D Array of surface B_s cosine coeffiecents.@ref read_wout_mod::bsubsmnc
bsubumns2D Array of surface B_u sine coeffiecents.@ref read_wout_mod::bsubumns
bsubvmns2D Array of surface B_v sine coeffiecents.@ref read_wout_mod::bsubvmns
bsupumns2D Array of surface B^u sine coeffiecents.@ref read_wout_mod::bsupumns
bsupvmns2D Array of surface B^v sine coeffiecents.@ref read_wout_mod::bsupvmns
phi1D Array of Toroidal flux.@ref read_wout_mod::phi
iotaf1D Array of full grid iotabar.@ref read_wout_mod::iotaf
iotas1D Array of half grid iotabar.@ref read_wout_mod::iotas
vvc_smaleliInternal inducance. Computed in eqfor.@ref v3f_vmec_comm::vvc_smaleli
vvc_kappa_pMean elongation. Computed in eqfor.@ref v3f_vmec_comm::vvc_kappa_p
betatotTotal beta.@ref read_wout_mod::betatot
betapolPoloidal beta.@ref read_wout_mod::betapol
betatorToroidal beta.@ref read_wout_mod::betator
betaxisBeta on axis.@ref read_wout_mod::betaxis
jcuruPoloidal current density.@ref read_wout_mod::jcuru
jcurvToroidal current density.@ref read_wout_mod::jcurv
jdotbCurrent density in direction of b field.@ref read_wout_mod::jdotb
raxis_ccMagnetic axis R cosine coeffiecents.@ref read_wout_mod::raxis
raxis_csMagnetic axis R sine coeffiecents.@ref read_wout_mod::raxis
zaxis_ccMagnetic axis Z cosine coeffiecents.@ref read_wout_mod::zaxis
zaxis_csMagnetic axis Z sine coeffiecents.@ref read_wout_mod::zaxis
qfactSafety factor profile.@ref read_wout_mod::qfact
presHalf grid pressure. Should only be used when reconstructing a pressure profile parameter.@ref read_wout_mod::pres
presfFull grid pressure. Should only be used when reconstructing a pressure profile parameter.@ref read_wout_mod::pres