QuaLiKiz-Pythontools
Public Member Functions | Static Public Attributes | List of all members
qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.Options Class Reference

Wraps options for normalization, assumptions, etc. More...

Inheritance diagram for qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.Options:
Inheritance graph
[legend]
Collaboration diagram for qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.Options:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, kwargs)
 Initialize Options class. More...
 

Static Public Attributes

 in_args
 

Detailed Description

Wraps options for normalization, assumptions, etc.

Constructor & Destructor Documentation

◆ __init__()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.Options.__init__ (   self,
  kwargs 
)

Initialize Options class.

Parameters
set_qn_normniFlag to set ion concentration to maintain
quasineutralityset_qn_normni_ion:Index of ion to adjust if set_qn_normni is True
set_qn_AnFlag to set ion gradient to maintain
quasineutrality
set_qn_An_ionIndex of ion to adjust if set_qn_An is True
check_qnFlag for maintaining quasineutrality of gradients
x_eq_rhoFlag to keep rho and x equal if set with setitem
recalc_NustarFlag to recalculate Nustar after scanning over values. Needed when setting Nustar and either
Zeff, ne, q, Ro, Rmin, x, rho, ni, ni0 or ni1
@param recalc_Ti_Te_rel Flag to recalculate Ti after setting Te
@param assume_tor_rot Assume pure toroidal rotation. Auto-calculate
Autor, Machpar, and Aupar from puretor_abs_var and
puretor_grad_var
puretor_abs_varVariable name to use as fixed for pure toroidal rotation absolute value
puretor_grad_varVariable name to use as fixed for pure toroidal rotation gradient

Member Data Documentation

◆ in_args

qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.Options.in_args
static
Initial value:
= OrderedDict([
('set_qn_normni', True),
('set_qn_normni_ion', 0),
('set_qn_An', True),
('set_qn_An_ion', 0),
('check_qn', True),
('x_eq_rho', True),
('recalc_Nustar', False),
('recalc_Ti_Te_rel', False),
('assume_tor_rot', True),
('puretor_abs_var', 'Machtor'),
('puretor_grad_var', 'gammaE'),
])

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