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

A single xpoint in a QuaLiKiz run. More...

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

Classes

class  Geometry
 Wraps variables that change per scan point. More...
 
class  Meta
 Wraps variables that stay constant during the QuaLiKiz run. More...
 
class  Options
 Wraps options for normalization, assumptions, etc. More...
 
class  Special
 Wraps variables that need special convertion to binary. More...
 

Public Member Functions

def __init__ (self, kwargs)
 Initialize a single QuaLiKizXpoint Usually this point is part of a scan. More...
 
def get_other_non_trace_ions (self, ion_index)
 
def set_qn_normni_ion_n (self)
 Set density of nth ion to maintian quasineutrality. More...
 
def set_qn_An_ion_n (self)
 Set density gradient of nth ion to maintian quasineutrality. More...
 
def check_quasi (self)
 Check if quasineutrality is maintained. More...
 
def match_zeff (self, zeff)
 Adjust ni1 to match the given Zeff. More...
 
def calc_zeff (self)
 Calculate Zeff. More...
 
def match_nustar (self, nustar)
 Set Te to match the given Nustar. More...
 
def calc_nustar (self)
 Calculate Nustar. More...
 
def match_tite (self, tite)
 Set all Ions temperature to match the given Ti/Te. More...
 
def calc_tite (self)
 Calculate Ti/Te. More...
 
def match_epsilon (self, epsilon)
 Set x to match the given epsilon. More...
 
def calc_epsilon (self)
 Calculate epsilon. More...
 
def set_puretor (self)
 
def __getitem__ (self, key)
 Get value from nested dict Use this method to get a value in the QuaLiKizRun class. More...
 
def __setitem__ (self, key, value)
 Set value in nested dict Use this method to set a value in the QuaLiKizRun class. More...
 

Detailed Description

A single xpoint in a QuaLiKiz run.

Typically a QuaLiKiz run scans over multiple xpoints. This class contains multiple dicts sorted by meaning. Those dicts are: elec an Electron that describes the electrons in the plasma ions an IonList with all ions contained in the plasma meta a Meta instance with all values that don't change for different radial points special a Special instance with all values that need special treatment when writing to binary geometric a Geometry instance with all values that change for different radial points options information about different rescalings, assumptions, etc.

Constructor & Destructor Documentation

◆ __init__()

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

Initialize a single QuaLiKizXpoint Usually this point is part of a scan.

Initialize an instance of QuaLiKizXpoint to use as base for the scan. This base_point can then be used as argument for an QuaLiKizPlan.

Parameters
kthetarhosThe wave spectrum to be scanned
electronsAn Electron instance describing the electron
population
ionsAn IonList instance describing the ion population all kwargs described in the Meta, Special and Geometry classes

Member Function Documentation

◆ __getitem__()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.__getitem__ (   self,
  key 
)

Get value from nested dict Use this method to get a value in the QuaLiKizRun class.

It adds some extra abstraction for the multi-layered structure of the QuaLiKizRun class. You can get a specific internal variable, or get an Electron variable by appending 'e', or get all Ions by appending 'i'. You can also get a specific Ion with 'i#', for example 'i1'

◆ __setitem__()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.__setitem__ (   self,
  key,
  value 
)

Set value in nested dict Use this method to set a value in the QuaLiKizRun class.

It adds some extra abstraction for the multi-layered structure of the QuaLiKizRun class. You can set a specific internal variable, or set an Electron variable by appending 'e', or set all Ions by appending 'i'. You can also set a specific Ion with 'i#', for example 'i1'

◆ calc_epsilon()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.calc_epsilon (   self)

Calculate epsilon.

◆ calc_nustar()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.calc_nustar (   self)

Calculate Nustar.

◆ calc_tite()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.calc_tite (   self)

Calculate Ti/Te.

Raises exception if undefined

◆ calc_zeff()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.calc_zeff (   self)

Calculate Zeff.

◆ check_quasi()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.check_quasi (   self)

Check if quasineutrality is maintained.

◆ get_other_non_trace_ions()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.get_other_non_trace_ions (   self,
  ion_index 
)

◆ match_epsilon()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.match_epsilon (   self,
  epsilon 
)

Set x to match the given epsilon.

◆ match_nustar()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.match_nustar (   self,
  nustar 
)

Set Te to match the given Nustar.

◆ match_tite()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.match_tite (   self,
  tite 
)

Set all Ions temperature to match the given Ti/Te.

◆ match_zeff()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.match_zeff (   self,
  zeff 
)

Adjust ni1 to match the given Zeff.

◆ set_puretor()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.set_puretor (   self)

◆ set_qn_An_ion_n()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.set_qn_An_ion_n (   self)

Set density gradient of nth ion to maintian quasineutrality.

◆ set_qn_normni_ion_n()

def qualikiz_tools.qualikiz_io.inputfiles.QuaLiKizXpoint.set_qn_normni_ion_n (   self)

Set density of nth ion to maintian quasineutrality.


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