UAL Python Interface

Module ual.ual

class ual.ual.itm(s=-1, r=-1, rs=-1, rr=-1)

__init__(s=-1, r=-1, rs=-1, rr=-1)

__str__(depth=0)

__del__()

setShot(inShot)

setRun(inRun)

setRefShot(inRefShot)

setRefNum(inRefRun)

setTreeName(inTreeName)

getShot()

getRun()

getRefShot()

getRefRun()

getTreeName()

isConnected()

create()

create_env(user, tokamak, version)

create_hdf5()

open()

open_env(user, tokamak, version)

open_hdf5()

close()

__module__ = 'ual.ual'

Module ual.ualdef

ual.ualdef.check_status(status)

ual.ualdef.verb()

ual.ualdef.dev()

Module ual.edge

class ual.edge.edge

class edge CPO for edge/SOL plasma description. Time-dependent CPO

Attributes: - datainfo : class datainfo

Generic information on a data item

• grid : class complexgrid

  Grid description

• species : class species_desc: array of species_descObj objects

  Description of ion species. Array of structures(nspecies)

• fluid : class edge_fluid

  Fluid description of edge plasma. Time-dependent.

• kinetic : class edge_kinetic

  Kinetic description of edge plasma. Time-dependent.

• codeparam : class codeparam

  Code parameters

• time : float

  Time [s]; Time-dependent; Scalar

__init__()

__str__(depth=0)

setExpIdx(idx)

putSlice(occurence=0)

replaceLastSlice(occurence=0)

putNonTimed(occurence=0)

getSlice(inTime, interpolMode, occurence=0)

build_non_resampled_data(occurence=0)

flushCache(occurence=0)

discardMemCache(occurence=0)

deleteData(occurence=0)

__module__ = 'ual.edge'

class ual.edge.edgeArray

class edgeArray CPO for edge/SOL plasma description. Time-dependent CPO

Attributes: - array : list of edge

Each list element correspond to one time slice.

__init__()

__str__(depth=0)

setExpIdx(idx)

put(occurence=0)

get(occurence=0)

resize(nb_cpos)

deleteAll(occurence=0)

__module__ = 'ual.edge'

Module ual.edge_types

class ual.edge_types.datainfo(base_path_in='datainfo')

class datainfo Generic information on a data item

Attributes: - dataprovider : str

Name of the actual data provider (the person who filled the data)

• putdate : str

  Date at which the data has been put in the DB

• source : str

  Exact reference of the data source (e.g. original reference in the native machine data base)

• comment : str

  Any additional comment

• isref : int

  1 if the data can be found in the present data base entry; 2 if the data can be found in a parent data base entry; 0 if no data consistent with the present entry can be found.

• whatref : class whatref

  Structure defining a database entry and the CPO occurrence

• putinfo : class putinfo

  Level 2 information describing how to retrieve the actual data for the UAL. Not to be filled/used by the ITM user !

__init__(base_path_in='datainfo')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.whatref(base_path_in='whatref')

class whatref Structure defining a database entry and the CPO occurrence

Attributes: - user : str

Name of the user if private data, public if public ITM database.

• machine : str

  Name of the device

• shot : int

  Shot number

• run : int

  Run number

• occurrence : int

  Occurrence number of the CPO in the reference entry

__init__(base_path_in='whatref')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.putinfo(base_path_in='putinfo')

class putinfo Level 2 information describing how to retrieve the actual data for the UAL. Not to be filled/used by the ITM user !

Attributes: - putmethod : str

Storage method for this data

• putaccess : str

  Instructions to access the data using this method

• putlocation : str

  Name of this data under this method

• rights : str

  Access rights to this data

__init__(base_path_in='putinfo')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid(base_path_in='complexgrid')

class complexgrid Grid description

Attributes: - spaces : class complexgrid_space: array of complexgrid_spaceObj objects

Definitions of grid spaces. Structure array(nspace).

• subgrids : class complexgrid_subgrid: array of complexgrid_subgridObj objects

  Definitions of subgrids. Structure array(nsubgrids).

• metric : class complexgrid_metric: array of complexgrid_metricObj objects

  Metric coefficients. Array of structures (nsubgrids). Metric information for every subgrid.

__init__(base_path_in='complexgrid')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_space(base_path_in='complexgrid_space')

class complexgrid_space Definitions of grid spaces. Structure array(nspace).

Attributes: - array : list of complexgrid_spaceObj

__init__(base_path_in='complexgrid_space')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_spaceObj(base_path_in='complexgrid_space')

class complexgrid_spaceObj Definitions of grid spaces. Structure array(nspace).

Attributes: - coordtype : numpy.ndarray 1D with int)

Type of coordinates describing the physical space. Vector(nspacedim); The size of coordtype defines the dimension of the space.; For predefined integer constants for standard coordinates see; the documentation of the grid service library.

• properties : class complexgrid_space_properties

  Space properties.

• objects : class objects: array of objectsObj objects

  Definition of the higher-dimensional objects in the space.; Structure Array(1:nspacedim). First dimension: dimension of the objects (1=edges, 2=faces, 3=cells/volumes, etc...)

• nodes : class complexgrid_nodes

  Definition of the nodes in the space.

__init__(base_path_in='complexgrid_space')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_space_properties(base_path_in='complexgrid_space_properties')

class complexgrid_space_properties Space properties.

Attributes: - geotype : int

Type of space geometry (id flag). A flag defining how the geometry (geo) fields associated with; grid nodes and objects are to be interpreted. If the field is undefined (0=GRID_UNDEFINED), the standard interpretation for; the given coordinate types is assumed.

• geotypeid : str

  Type of space geometry (id string). A string defining how the geometry (geo) fields associated with; grid nodes and objects are to be interpreted. If the field is undefined, the standard interpretation for; the given coordinate types is assumed.

__init__(base_path_in='complexgrid_space_properties')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.objects(base_path_in='objects')

class objects Definition of the higher-dimensional objects in the space.; Structure Array(1:nspacedim). First dimension: dimension of the objects (1=edges, 2=faces, 3=cells/volumes, etc...)

Attributes: - array : list of objectsObj

__init__(base_path_in='objects')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.objectsObj(base_path_in='objects')

class objectsObj Definition of the higher-dimensional objects in the space.; Structure Array(1:nspacedim). First dimension: dimension of the objects (1=edges, 2=faces, 3=cells/volumes, etc...)

Attributes: - boundary : numpy.ndarray 2D with int

Lists of (n-1)-dimensional objects defining the boundary of an n-dimensional object. Matrix(nobject,nmaxobjectboundary);First dimension: object index, second index: boundary object index

• neighbour : numpy.ndarray 3D with int

  Connectivity information. 3d array of integers(nobject, nmaxobjectboundaries, nmaxneighboursperboundary).; Stores the indices of the n-dimensional objects adjacent to a given n-dimensional object.;An object can possibly have multiple neighbours on every boundary. ;First dimension: object index, second dimension: boundary index, third dimension: neighbour index on the boundary.

• geo : numpy.ndarray 3D with float

  Geometry data matrix associated with an object. 3d float array(nobject,ngeo1,ngeo2). Meaning depends on the value of grid_space.properties.geotype.; First dimension: object index, second+third dimension: matrix row+column.

• measure : numpy.ndarray 1D with float

  Measure of object, i.e. physical size (length for 1d, area for 2d, volume for 3d objects). [m^dim]. Use this field to store measures for (sub)objects explicitly defined in spaces.

__init__(base_path_in='objects')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_nodes(base_path_in='complexgrid_nodes')

class complexgrid_nodes Definition of the nodes in the space.

Attributes: - geo : numpy.ndarray 3D with float

Geometry data matrix associated with every node. 3d float array(nnodesinspace, ngeo1, ngeo2). Meaning depends on the value of grid_space.properties.geotype.; First dimension: object index, second+third dimension: matrix row+column.; In the default case (grid_space.properties.geotype=undefined), this field has dimensions (nnodeinspace,nspacedim,1) and simply holds the coordinates for every node, where nspacedim is the dimension of the space. The j-th component of the coordinate vector; of the i-th node is thus geo(i,j,1).

• xpoints : numpy.ndarray 1D with int)

  List of indices of all nodes which are x-points. Vector(nxpoints)

• altgeo : class complexgrid_altgeo: array of complexgrid_altgeoObj objects

  (Possibly multiple) alternative geometry information for nodes. Structure array(naltgeometries). Mainly intended for plotting.

• alias : numpy.ndarray 1D with int)

  Alias list. Vector(nnodesinspace). If this vector is defined, it holds one entry per node. If an entry alias(i)=j with j != 0(=GRID_UNDEFINED),; this means that the nodes with index i and j are aliased, i.e. are identical. If alias(i)=0(=GRID_UNDEFINED), the; node is not aliased to another node. This mechanism can be used to indicate periodic boundaries.

__init__(base_path_in='complexgrid_nodes')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_altgeo(base_path_in='complexgrid_altgeo')

class complexgrid_altgeo (Possibly multiple) alternative geometry information for nodes. Structure array(naltgeometries). Mainly intended for plotting.

Attributes: - array : list of complexgrid_altgeoObj

__init__(base_path_in='complexgrid_altgeo')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_altgeoObj(base_path_in='complexgrid_altgeo')

class complexgrid_altgeoObj (Possibly multiple) alternative geometry information for nodes. Structure array(naltgeometries). Mainly intended for plotting.

Attributes: - coordtype : numpy.ndarray 1D with int)

Coordinate axis types for alternate coordinate system. Vector(nspacedim).

• geo : numpy.ndarray 3D with float

  Alternate geometry data matrix associated with every node. 3d float array(nnodesinspace, ngeo1, ngeo2). See documentation of nodes.geo one level up.

__init__(base_path_in='complexgrid_altgeo')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_subgrid(base_path_in='complexgrid_subgrid')

class complexgrid_subgrid Definitions of subgrids. Structure array(nsubgrids).

Attributes: - array : list of complexgrid_subgridObj

__init__(base_path_in='complexgrid_subgrid')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_subgridObj(base_path_in='complexgrid_subgrid')

class complexgrid_subgridObj Definitions of subgrids. Structure array(nsubgrids).

Attributes: - id : str

ID string (name) of the subgrid. Freely chosen by user, possibly used for plotting.

• list : class complexgrid_objectlist: array of complexgrid_objectlistObj objects

  List of object lists. Structure array(nobjectlists).

__init__(base_path_in='complexgrid_subgrid')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_objectlist(base_path_in='complexgrid_objectlist')

class complexgrid_objectlist List of object lists. Structure array(nobjectlists).

Attributes: - array : list of complexgrid_objectlistObj

__init__(base_path_in='complexgrid_objectlist')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_objectlistObj(base_path_in='complexgrid_objectlist')

class complexgrid_objectlistObj List of object lists. Structure array(nobjectlists).

Attributes: - cls : numpy.ndarray 1D with int)

Class tuple of the objects in the list. Vector(nspace)

• indset : class complexgrid_indexlist: array of complexgrid_indexlistObj objects

  Index set for implicit definition of the object indices. List of indexlists. Structure Array(nspace)

• ind : numpy.ndarray 2D with int

  Explicit list of index tuples. Matrix(nobject, nspace). First dimension: object index, second dimension: index tuple index.; If this field is defined and has size > 0, the object list is understood to be explicit.

__init__(base_path_in='complexgrid_objectlist')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_indexlist(base_path_in='complexgrid_indexlist')

class complexgrid_indexlist Index set for implicit definition of the object indices. List of indexlists. Structure Array(nspace)

Attributes: - array : list of complexgrid_indexlistObj

__init__(base_path_in='complexgrid_indexlist')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_indexlistObj(base_path_in='complexgrid_indexlist')

class complexgrid_indexlistObj Index set for implicit definition of the object indices. List of indexlists. Structure Array(nspace)

Attributes: - range : numpy.ndarray 1D with int)

Defines an index range enumerating from range[1] to range[2] (with both range[1] and range[2] included). Vector(2)

• ind : numpy.ndarray 1D with int)

  An explicit list of indices. If this member is defined and has size>0, the list is assumed to be explicit. Vector(nindices)

__init__(base_path_in='complexgrid_indexlist')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_metric(base_path_in='complexgrid_metric')

class complexgrid_metric Metric coefficients. Array of structures (nsubgrids). Metric information for every subgrid.

Attributes: - array : list of complexgrid_metricObj

__init__(base_path_in='complexgrid_metric')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_metricObj(base_path_in='complexgrid_metric')

class complexgrid_metricObj Metric coefficients. Array of structures (nsubgrids). Metric information for every subgrid.

Attributes: - measure : class complexgrid_scalar_simplestruct

Measure of object, i.e. physical size (length for 1d, area for 2d, volume for 3d objects). [m^dim]. Use this field to store measures of implicitly defined grid objects.

• g11 : class complexgrid_scalar_simplestruct

  Metric coefficients g11. Structure array(nsubgrid_coefficient)

• g12 : class complexgrid_scalar_simplestruct

  Metric coefficients g12. Structure array(nsubgrid_coefficient)

• g13 : class complexgrid_scalar_simplestruct

  Metric coefficients g13. Structure array(nsubgrid_coefficient)

• g22 : class complexgrid_scalar_simplestruct

  Metric coefficients g22. Structure array(nsubgrid_coefficient)

• g23 : class complexgrid_scalar_simplestruct

  Metric coefficients g23. Structure array(nsubgrid_coefficient)

• g33 : class complexgrid_scalar_simplestruct

  Metric coefficients g33. Structure array(nsubgrid_coefficient)

• jacobian : class complexgrid_scalar_simplestruct

  Jacobian. Structure array(nsubgrid_coefficient)

__init__(base_path_in='complexgrid_metric')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_scalar_simplestruct(base_path_in='complexgrid_scalar_simplestruct')

class complexgrid_scalar_simplestruct Measure of object, i.e. physical size (length for 1d, area for 2d, volume for 3d objects). [m^dim]. Use this field to store measures of implicitly defined grid objects.

Attributes: - subgrid : int

Index of the subgrid (as stored in grid.subgrids) the data is stored on.

• scalar : numpy.ndarray 1D with float

  Scalar representation of data. One scalar entry is stored per object in the subgrid.; The order is implicitly defined by the subgrid.; Float Vector(nobjects_subgrid). First dimension: object index.

• vector : numpy.ndarray 2D with float

  Vector representation of data. One vector is stored per object in the subgrid. The order is implicitly defined by the subgrid.; Float matrix(nobjects_subgrid, ndata).First dimension: object index, second dimension: index of data vector.

• matrix : numpy.ndarray 3D with float

  Matrix representation of data. One matrix is stored per object in the subgrid. The order is implicitly defined by the subgrid.; 3d float array(nobjects_subgrid,ndata1,ndata2). First dimension: object index, second dimension: matrix row, third dimension: matrix column.

__init__(base_path_in='complexgrid_scalar_simplestruct')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.species_desc(base_path_in='species_desc')

class species_desc Description of ion species. Array of structures(nspecies)

Attributes: - array : list of species_descObj

__init__(base_path_in='species_desc')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

__module__ = 'ual.edge_types'

class ual.edge_types.species_descObj(base_path_in='species_desc')

class species_descObj Description of ion species. Array of structures(nspecies)

Attributes: - label : str

Name of species

• amn : float

  Atomic mass number of the species

• zn : float

  Nuclear charge of the impurity

• zmin : float

  Minimum Z of species charge state bundle

• zmax : float

  Maximum Z of species charge state bundle

__init__(base_path_in='species_desc')

__str__(depth=0)

setExpIdx(idx)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid(base_path_in='edge_fluid')

class edge_fluid Fluid description of edge plasma. Time-dependent.

Attributes: - ne : class edge_fluid_scalar_simplestruct

Electron density [1/m^3]; Time-dependent;

• ni : class edge_fluid_scalar: array of edge_fluid_scalarObj objects

  Ion density [1/m^3] (per species). Array of structures(nspecies); Time-dependent;

• ve : class edge_fluid_vector_simplestruct

  Electron velocity [m/s]; Time-dependent;

• vi : class edge_fluid_vector: array of edge_fluid_vectorObj objects

  Ion velocity [m/s] (per species).Array of structures(nspecies); Time-dependent;

• te : class edge_fluid_scalar_simplestruct

  Electron temperature [eV]; Time-dependent;

• ti : class edge_fluid_scalar: array of edge_fluid_scalarObj objects

  Ion temperature [eV] (per species). Array of structures(nspecies).; Time-dependent;

• te_aniso : class edge_fluid_vector_simplestruct

  Anisotropic electron temperature [eV]; Time-dependent;

• ti_aniso : class edge_fluid_vector: array of edge_fluid_vectorObj objects

  Anisotropic ion temperature [eV] (per species). Array of structures(nspecies); Time-dependent;

• po : class edge_fluid_scalar_simplestruct

  Electric potential [V]; Time-dependent;

• j : class edge_fluid_vector_simplestruct

  Electric current [A]; Time-dependent;

__init__(base_path_in='edge_fluid')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_scalar_simplestruct(base_path_in='edge_fluid_scalar_simplestruct')

class edge_fluid_scalar_simplestruct Electron density [1/m^3]; Time-dependent;

Attributes: - value : class complexgrid_scalar: array of complexgrid_scalarObj objects

Value of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• bndvalue : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Boundary values of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• flux : class complexgrid_vector: array of complexgrid_vectorObj objects

  Flux of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• bndflux : class complexgrid_vector: array of complexgrid_vectorObj objects

  Flux of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• transpcoeff : class edge_fluid_scalar_transpcoeff: array of edge_fluid_scalar_transpcoeffObj objects

  Transport coefficients; Time-dependent; Array of structures (nsubgrid_quantity)

• source : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Source; Time-dependent; Array of structures (nsubgrid_quantity)

__init__(base_path_in='edge_fluid_scalar_simplestruct')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_scalar(base_path_in='complexgrid_scalar')

class complexgrid_scalar Value of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

Attributes: - array : list of complexgrid_scalarObj

__init__(base_path_in='complexgrid_scalar')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_scalarObj(base_path_in='complexgrid_scalar')

class complexgrid_scalarObj Value of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

Attributes: - subgrid : int

Index of the subgrid (as stored in grid.subgrids) the data is stored on.

• scalar : numpy.ndarray 1D with float

  Scalar representation of data. One scalar entry is stored per object in the subgrid.; The order is implicitly defined by the subgrid.; Float Vector(nobjects_subgrid). First dimension: object index.

• vector : numpy.ndarray 2D with float

  Vector representation of data. One vector is stored per object in the subgrid. The order is implicitly defined by the subgrid.; Float matrix(nobjects_subgrid, ndata).First dimension: object index, second dimension: index of data vector.

• matrix : numpy.ndarray 3D with float

  Matrix representation of data. One matrix is stored per object in the subgrid. The order is implicitly defined by the subgrid.; 3d float array(nobjects_subgrid,ndata1,ndata2). First dimension: object index, second dimension: matrix row, third dimension: matrix column.

__init__(base_path_in='complexgrid_scalar')

__str__(depth=0)

setExpIdx(idx)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_vector(base_path_in='complexgrid_vector')

class complexgrid_vector Flux of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

Attributes: - array : list of complexgrid_vectorObj

__init__(base_path_in='complexgrid_vector')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_vectorObj(base_path_in='complexgrid_vector')

class complexgrid_vectorObj Flux of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

Attributes: - label : str

Label describing the data

• comp : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Components of the vector. Vector of griddata(ndim). Time-dependent; FIXME: inherit time-dependence for this element

• align : numpy.ndarray 1D with int)

  Alignment of vector components, numerical flag. Int vector(ndim)

• alignid : list of str

  Alignment of vector components, string description. String vector(ndim)

__init__(base_path_in='complexgrid_vector')

__str__(depth=0)

setExpIdx(idx)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_scalar_transpcoeff(base_path_in='edge_fluid_scalar_transpcoeff')

class edge_fluid_scalar_transpcoeff Transport coefficients; Time-dependent; Array of structures (nsubgrid_quantity)

Attributes: - array : list of edge_fluid_scalar_transpcoeffObj

__init__(base_path_in='edge_fluid_scalar_transpcoeff')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_scalar_transpcoeffObj(base_path_in='edge_fluid_scalar_transpcoeff')

class edge_fluid_scalar_transpcoeffObj Transport coefficients; Time-dependent; Array of structures (nsubgrid_quantity)

Attributes: - d : class complexgrid_vector_simplestruct

Diffusivity [m^2/s]; Time-dependent;

• v : class complexgrid_vector_simplestruct

  Velocity [m/s]; Time-dependent;

__init__(base_path_in='edge_fluid_scalar_transpcoeff')

__str__(depth=0)

setExpIdx(idx)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.complexgrid_vector_simplestruct(base_path_in='complexgrid_vector_simplestruct')

class complexgrid_vector_simplestruct Diffusivity [m^2/s]; Time-dependent;

Attributes: - label : str

Label describing the data

• comp : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Components of the vector. Vector of griddata(ndim). Time-dependent; FIXME: inherit time-dependence for this element

• align : numpy.ndarray 1D with int)

  Alignment of vector components, numerical flag. Int vector(ndim)

• alignid : list of str

  Alignment of vector components, string description. String vector(ndim)

__init__(base_path_in='complexgrid_vector_simplestruct')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_scalar(base_path_in='edge_fluid_scalar')

class edge_fluid_scalar Ion density [1/m^3] (per species). Array of structures(nspecies); Time-dependent;

Attributes: - array : list of edge_fluid_scalarObj

__init__(base_path_in='edge_fluid_scalar')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_scalarObj(base_path_in='edge_fluid_scalar')

class edge_fluid_scalarObj Ion density [1/m^3] (per species). Array of structures(nspecies); Time-dependent;

Attributes: - value : class complexgrid_scalar: array of complexgrid_scalarObj objects

Value of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• bndvalue : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Boundary values of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• flux : class complexgrid_vector: array of complexgrid_vectorObj objects

  Flux of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• bndflux : class complexgrid_vector: array of complexgrid_vectorObj objects

  Flux of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)

• transpcoeff : class edge_fluid_scalar_transpcoeff: array of edge_fluid_scalar_transpcoeffObj objects

  Transport coefficients; Time-dependent; Array of structures (nsubgrid_quantity)

• source : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Source; Time-dependent; Array of structures (nsubgrid_quantity)

__init__(base_path_in='edge_fluid_scalar')

__str__(depth=0)

setExpIdx(idx)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_vector_simplestruct(base_path_in='edge_fluid_vector_simplestruct')

class edge_fluid_vector_simplestruct Electron velocity [m/s]; Time-dependent;

Attributes: - comps : class edge_fluid_scalar: array of edge_fluid_scalarObj objects

Components of the vector. Array of structures(ndim); Time-dependent;

• align : numpy.ndarray 1D with int)

  Alignment of vector components, numerical flag. Int vector(ndim);

• alignid : list of str

  Alignment of vector components, string description. String vector(ndim);

__init__(base_path_in='edge_fluid_vector_simplestruct')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_vector(base_path_in='edge_fluid_vector')

class edge_fluid_vector Ion velocity [m/s] (per species).Array of structures(nspecies); Time-dependent;

Attributes: - array : list of edge_fluid_vectorObj

__init__(base_path_in='edge_fluid_vector')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_fluid_vectorObj(base_path_in='edge_fluid_vector')

class edge_fluid_vectorObj Ion velocity [m/s] (per species).Array of structures(nspecies); Time-dependent;

Attributes: - comps : class edge_fluid_scalar: array of edge_fluid_scalarObj objects

Components of the vector. Array of structures(ndim); Time-dependent;

• align : numpy.ndarray 1D with int)

  Alignment of vector components, numerical flag. Int vector(ndim);

• alignid : list of str

  Alignment of vector components, string description. String vector(ndim);

__init__(base_path_in='edge_fluid_vector')

__str__(depth=0)

setExpIdx(idx)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_kinetic(base_path_in='edge_kinetic')

class edge_kinetic Kinetic description of edge plasma. Time-dependent.

Attributes: - f : class edge_kinetic_distribution: array of edge_kinetic_distributionObj objects

Distribution function [1/m^3 (m/s)^-3]. Array of structuresr(nspecies); Time-dependent;

__init__(base_path_in='edge_kinetic')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_kinetic_distribution(base_path_in='edge_kinetic_distribution')

class edge_kinetic_distribution Distribution function [1/m^3 (m/s)^-3]. Array of structuresr(nspecies); Time-dependent;

Attributes: - array : list of edge_kinetic_distributionObj

__init__(base_path_in='edge_kinetic_distribution')

__str__(depth=0)

setExpIdx(idx)

resize(nbelt)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

__module__ = 'ual.edge_types'

class ual.edge_types.edge_kinetic_distributionObj(base_path_in='edge_kinetic_distribution')

class edge_kinetic_distributionObj Distribution function [1/m^3 (m/s)^-3]. Array of structuresr(nspecies); Time-dependent;

Attributes: - value : class complexgrid_scalar: array of complexgrid_scalarObj objects

Value of distribution function. Possibly stored on multiple subgrids.; Vector (nsubgrid_quantity). Time-dependent;

• bndvalue : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Boundary value of distribution function. Possibly stored on multiple subgrids.; Vector (nsubgrid_quantity). Time-dependent;

• fluxes : class complexgrid_vector: array of complexgrid_vectorObj objects

  Fluxes in phase space. Possibly stored on multiple subgrids.; Vector (nsubgrid_quantity). Time-dependent;

• source : class complexgrid_scalar: array of complexgrid_scalarObj objects

  Sources in phase space. Possibly stored on multiple subgrids.; Vector (nsubgrid_quantity). Time-dependent;

__init__(base_path_in='edge_kinetic_distribution')

__str__(depth=0)

setExpIdx(idx)

putTimedElt(path, cpopath, i, obj)

getTimedElt(path, cpopath, i, obj)

putNonTimedElt(path, cpopath, i, obj)

getNonTimedElt(path, cpopath, i, obj)

__module__ = 'ual.edge_types'

class ual.edge_types.codeparam(base_path_in='codeparam')

class codeparam Code parameters

Attributes: - codename : str

Name of the code

• codeversion : str

  Version of the code (as in the ITM repository)

• parameters : str

  List of the code specific parameters, string expected to be in XML format.

• output_diag : str

  List of the code specific diagnostic/output, string expected to be in XML format.

• output_flag : int

  Output flag : 0 means the run is successful, other values meaning some difficulty has been encountered, the exact meaning is then code specific. Negative values mean the result shall not be used. Exact rules could discussed and implemented in the module wrapper. Time-dependent.

__init__(base_path_in='codeparam')

__str__(depth=0)

setExpIdx(idx)

putSlice(path, cpopath)

replaceLastSlice(path, cpopath)

putNonTimed(path, cpopath)

getSlice(path, cpopath, inTime, interpolMode)

build_non_resampled_data(path, cpopath, nbslice)

flushCache(path, cpopath)

discardMemCache(path, cpopath)

deleteData(path, cpopath)

__module__ = 'ual.edge_types'