class edge CPO for edge/SOL plasma description. Time-dependent CPO
Attributes: - datainfo : class datainfo
Generic information on a data item
Grid description
Description of ion species. Array of structures(nspecies)
Fluid description of edge plasma. Time-dependent.
Kinetic description of edge plasma. Time-dependent.
Code parameters
Time [s]; Time-dependent; Scalar
class datainfo Generic information on a data item
Attributes: - dataprovider : str
Name of the actual data provider (the person who filled the data)
Date at which the data has been put in the DB
Exact reference of the data source (e.g. original reference in the native machine data base)
Any additional comment
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.
Structure defining a database entry and the CPO occurrence
Level 2 information describing how to retrieve the actual data for the UAL. Not to be filled/used by the ITM user !
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.
Name of the device
Shot number
Run number
Occurrence number of the CPO in the reference entry
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
Instructions to access the data using this method
Name of this data under this method
Access rights to this data
class complexgrid Grid description
Attributes: - spaces : class complexgrid_space: array of complexgrid_spaceObj objects
Definitions of grid spaces. Structure array(nspace).
Definitions of subgrids. Structure array(nsubgrids).
Metric coefficients. Array of structures (nsubgrids). Metric information for every subgrid.
class complexgrid_space Definitions of grid spaces. Structure array(nspace).
Attributes: - array : list of complexgrid_spaceObj
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.
Space properties.
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...)
Definition of the nodes in the space.
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.
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.
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
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
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.
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 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.
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).
List of indices of all nodes which are x-points. Vector(nxpoints)
(Possibly multiple) alternative geometry information for nodes. Structure array(naltgeometries). Mainly intended for plotting.
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.
class complexgrid_altgeo (Possibly multiple) alternative geometry information for nodes. Structure array(naltgeometries). Mainly intended for plotting.
Attributes: - array : list of complexgrid_altgeoObj
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).
Alternate geometry data matrix associated with every node. 3d float array(nnodesinspace, ngeo1, ngeo2). See documentation of nodes.geo one level up.
class complexgrid_subgrid Definitions of subgrids. Structure array(nsubgrids).
Attributes: - array : list of complexgrid_subgridObj
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 of object lists. Structure array(nobjectlists).
class complexgrid_objectlist List of object lists. Structure array(nobjectlists).
Attributes: - array : list of complexgrid_objectlistObj
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)
Index set for implicit definition of the object indices. List of indexlists. Structure Array(nspace)
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.
class complexgrid_indexlist Index set for implicit definition of the object indices. List of indexlists. Structure Array(nspace)
Attributes: - array : list of complexgrid_indexlistObj
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)
An explicit list of indices. If this member is defined and has size>0, the list is assumed to be explicit. Vector(nindices)
class complexgrid_metric Metric coefficients. Array of structures (nsubgrids). Metric information for every subgrid.
Attributes: - array : list of complexgrid_metricObj
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.
Metric coefficients g11. Structure array(nsubgrid_coefficient)
Metric coefficients g12. Structure array(nsubgrid_coefficient)
Metric coefficients g13. Structure array(nsubgrid_coefficient)
Metric coefficients g22. Structure array(nsubgrid_coefficient)
Metric coefficients g23. Structure array(nsubgrid_coefficient)
Metric coefficients g33. Structure array(nsubgrid_coefficient)
Jacobian. Structure array(nsubgrid_coefficient)
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 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 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 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.
class species_desc Description of ion species. Array of structures(nspecies)
Attributes: - array : list of species_descObj
class species_descObj Description of ion species. Array of structures(nspecies)
Attributes: - label : str
Name of species
Atomic mass number of the species
Nuclear charge of the impurity
Minimum Z of species charge state bundle
Maximum Z of species charge state bundle
class edge_fluid Fluid description of edge plasma. Time-dependent.
Attributes: - ne : class edge_fluid_scalar_simplestruct
Electron density [1/m^3]; Time-dependent;
Ion density [1/m^3] (per species). Array of structures(nspecies); Time-dependent;
Electron velocity [m/s]; Time-dependent;
Ion velocity [m/s] (per species).Array of structures(nspecies); Time-dependent;
Electron temperature [eV]; Time-dependent;
Ion temperature [eV] (per species). Array of structures(nspecies).; Time-dependent;
Anisotropic electron temperature [eV]; Time-dependent;
Anisotropic ion temperature [eV] (per species). Array of structures(nspecies); Time-dependent;
Electric potential [V]; Time-dependent;
Electric current [A]; Time-dependent;
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)
Boundary values of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)
Flux of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)
Flux of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)
Transport coefficients; Time-dependent; Array of structures (nsubgrid_quantity)
Source; Time-dependent; Array of structures (nsubgrid_quantity)
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
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 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 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 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.
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
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
Components of the vector. Vector of griddata(ndim). Time-dependent; FIXME: inherit time-dependence for this element
Alignment of vector components, numerical flag. Int vector(ndim)
Alignment of vector components, string description. String vector(ndim)
class edge_fluid_scalar_transpcoeff Transport coefficients; Time-dependent; Array of structures (nsubgrid_quantity)
Attributes: - array : list of edge_fluid_scalar_transpcoeffObj
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;
Velocity [m/s]; Time-dependent;
class complexgrid_vector_simplestruct Diffusivity [m^2/s]; Time-dependent;
Attributes: - label : str
Label describing the data
Components of the vector. Vector of griddata(ndim). Time-dependent; FIXME: inherit time-dependence for this element
Alignment of vector components, numerical flag. Int vector(ndim)
Alignment of vector components, string description. String vector(ndim)
class edge_fluid_scalar Ion density [1/m^3] (per species). Array of structures(nspecies); Time-dependent;
Attributes: - array : list of edge_fluid_scalarObj
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)
Boundary values of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)
Flux of the quantity. Possibly stored on multiple subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)
Flux of the quantity. Possibly stored on multiple (boundary) subgrids.; Time-dependent; Array of structures (nsubgrid_quantity)
Transport coefficients; Time-dependent; Array of structures (nsubgrid_quantity)
Source; Time-dependent; Array of structures (nsubgrid_quantity)
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;
Alignment of vector components, numerical flag. Int vector(ndim);
Alignment of vector components, string description. String vector(ndim);
class edge_fluid_vector Ion velocity [m/s] (per species).Array of structures(nspecies); Time-dependent;
Attributes: - array : list of edge_fluid_vectorObj
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;
Alignment of vector components, numerical flag. Int vector(ndim);
Alignment of vector components, string description. String vector(ndim);
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;
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
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;
Boundary value of distribution function. Possibly stored on multiple subgrids.; Vector (nsubgrid_quantity). Time-dependent;
Fluxes in phase space. Possibly stored on multiple subgrids.; Vector (nsubgrid_quantity). Time-dependent;
Sources in phase space. Possibly stored on multiple subgrids.; Vector (nsubgrid_quantity). Time-dependent;
class codeparam Code parameters
Attributes: - codename : str
Name of the code
Version of the code (as in the ITM repository)
List of the code specific parameters, string expected to be in XML format.
List of the code specific diagnostic/output, string expected to be in XML format.
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.