ITER Physics Data Model Documentation for coils_non_axisymmetric

Non axisymmetric active coils system (e.g. ELM control coils, error field correction coils, ...)

Notation of array of structure indices: itime indicates a time index; i1, i2, i3, ... indicate other indices with their depth in the IDS. This notation clarifies the path of a given node, but should not be used to compare indices of different nodes (they may have different meanings).

Lifecycle status: alpha since version 3.19.1

Last change occured on version: 3.40.0

Back to top IDS list

By convention, only the upper error node should be filled in case of symmetrical error bars. The upper and lower errors are absolute and defined positive, and represent one standard deviation of the data. The effective values of the data (within one standard deviation) will be within the interval [data-data_error_lower, data+data_error_upper]. Thus whatever the sign of data, data_error_lower relates to the lower bound and data_error_upper to the upper bound of the error bar interval.

Full path name Description Data Type Coordinates
ids_properties Interface Data Structure properties. This element identifies the node above as an IDS structure
ids_properties/comment Any comment describing the content of this IDS {constant} STR_0D
ids_properties/name User-defined name for this IDS occurrence {constant}. Introduced after DD version 3.39.0 STR_0D
ids_properties/homogeneous_time This node must be filled (with 0, 1, or 2) for the IDS to be valid. If 1, the time of this IDS is homogeneous, i.e. the time values for this IDS are stored in the time node just below the root of this IDS. If 0, the time values are stored in the various time fields at lower levels in the tree. In the case only constant or static nodes are filled within the IDS, homogeneous_time must be set to 2 {constant} INT_0D
ids_properties/occurrence_type Type of data contained in this occurrence. Introduced after DD version 3.39.0. Available options (refer to the children of this identifier structure) :
Name Index Description
reconstruction 1 Equilibrium reconstruction
prediction_fixed 2 Equilibrium prediction, fixed boundary
prediction_free 3 Equilibrium prediction, free boundary
mapping 4 Used for mapping equilibrium results from one grid type / resolution to another, or for including variables not present in the first set such as the calculation of magnetic field of other derived parameters
structure
ids_properties/occurrence_type/name Short string identifier {constant} STR_0D
ids_properties/occurrence_type/index Integer identifier (enumeration index within a list). Private identifier values must be indicated by a negative index. {constant} INT_0D
ids_properties/occurrence_type/description Verbose description {constant} STR_0D
ids_properties/provider Name of the person in charge of producing this data {constant} STR_0D
ids_properties/creation_date Date at which this data has been produced {constant} STR_0D
ids_properties/version_put Version of the access layer package used to PUT this IDS structure
ids_properties/version_put/data_dictionary Version of Data Dictionary used to PUT this IDS {constant} STR_0D
ids_properties/version_put/access_layer Version of Access Layer used to PUT this IDS {constant} STR_0D
ids_properties/version_put/access_layer_language Programming language of the Access Layer high level API used to PUT this IDS {constant} STR_0D
ids_properties/provenance
Lifecycle status: alpha since version 3.34.0
Provenance information about this IDS structure
ids_properties/provenance/node(i1) Set of IDS nodes for which the provenance is given. The provenance information applies to the whole structure below the IDS node. For documenting provenance information for the whole IDS, set the size of this array of structure to 1 and leave the child "path" node empty {constant} array of structures [max_size=20 (limited in MDS+ backend only)] 1- 1...N
ids_properties/provenance/node(i1)/path Path of the node within the IDS, following the syntax given in the link below. If empty, means the provenance information applies to the whole IDS. Click here for further documentation. {constant} STR_0D
ids_properties/provenance/node(i1)/reference(i2) List of references used to populate or calculate this node, identified as explained below. In case the node is the result of of a calculation / data processing, the reference is an input to the process described in the "code" structure at the root of the IDS. The reference can be an IDS (identified by a URI or a persitent identifier, see syntax in the link below) or non-IDS data imported directly from an non-IMAS database (identified by the command used to import the reference, or the persistent identifier of the data reference). Often data are obtained by a chain of processes, however only the last process input are recorded here. The full chain of provenance has then to be reconstructed recursively from the provenance information contained in the data references. Click here for further documentation.. Introduced after DD version 3.41.0 array of structures [max_size=10 (limited in MDS+ backend only)] 1- 1...N
ids_properties/provenance/node(i1)/reference(i2)/name Reference name {constant} STR_0D
ids_properties/provenance/node(i1)/reference(i2)/timestamp Date and time (UTC) at which the reference was created, expressed in a human readable form (ISO 8601) : the format of the string shall be : YYYY-MM-DDTHH:MM:SSZ. Example : 2020-07-24T14:19:00Z {constant} STR_0D
ids_properties/plugins
Lifecycle status: alpha since version 3.39.0
Information about the plugins used to write/read this IDS. This structure is filled automatically by the Access Layer at GET/PUT time, no need to fill it via a user program.. Introduced after DD version 3.38.1 structure
ids_properties/plugins/node(i1) Set of IDS nodes for which a plugin has been applied {constant} array of structures [max_size=20 (limited in MDS+ backend only)] 1- 1...N
ids_properties/plugins/node(i1)/path Path of the node within the IDS, following the syntax given in the link below. If empty, means the plugin applies to the whole IDS. Click here for further documentation. {constant} STR_0D
ids_properties/plugins/node(i1)/put_operation(i2) Plugins used to PUT a node (potentially, multiple plugins can be applied, if so they are listed by order of application) array of structures [max_size=10 (limited in MDS+ backend only)] 1- 1...N
ids_properties/plugins/node(i1)/put_operation(i2)/name Name of software used {constant} STR_0D
ids_properties/plugins/node(i1)/put_operation(i2)/description Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 STR_0D
ids_properties/plugins/node(i1)/put_operation(i2)/commit Unique commit reference of software {constant} STR_0D
ids_properties/plugins/node(i1)/put_operation(i2)/version Unique version (tag) of software {constant} STR_0D
ids_properties/plugins/node(i1)/put_operation(i2)/repository URL of software repository {constant} STR_0D
ids_properties/plugins/node(i1)/put_operation(i2)/parameters List of the code specific parameters in XML format {constant} STR_0D
ids_properties/plugins/node(i1)/readback(i2) Plugins to be used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application) array of structures [max_size=10 (limited in MDS+ backend only)] 1- 1...N
ids_properties/plugins/node(i1)/readback(i2)/name Name of software used {constant} STR_0D
ids_properties/plugins/node(i1)/readback(i2)/description Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 STR_0D
ids_properties/plugins/node(i1)/readback(i2)/commit Unique commit reference of software {constant} STR_0D
ids_properties/plugins/node(i1)/readback(i2)/version Unique version (tag) of software {constant} STR_0D
ids_properties/plugins/node(i1)/readback(i2)/repository URL of software repository {constant} STR_0D
ids_properties/plugins/node(i1)/readback(i2)/parameters List of the code specific parameters in XML format {constant} STR_0D
ids_properties/plugins/node(i1)/get_operation(i2) Plugins actually used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application). This information is filled by the plugin infrastructure during the GET operation. array of structures [max_size=10 (limited in MDS+ backend only)] 1- 1...N
ids_properties/plugins/node(i1)/get_operation(i2)/name Name of software used {constant} STR_0D
ids_properties/plugins/node(i1)/get_operation(i2)/description Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 STR_0D
ids_properties/plugins/node(i1)/get_operation(i2)/commit Unique commit reference of software {constant} STR_0D
ids_properties/plugins/node(i1)/get_operation(i2)/version Unique version (tag) of software {constant} STR_0D
ids_properties/plugins/node(i1)/get_operation(i2)/repository URL of software repository {constant} STR_0D
ids_properties/plugins/node(i1)/get_operation(i2)/parameters List of the code specific parameters in XML format {constant} STR_0D
ids_properties/plugins/infrastructure_put Plugin infrastructure used to PUT the data structure
ids_properties/plugins/infrastructure_put/name Name of software used {constant} STR_0D
ids_properties/plugins/infrastructure_put/description Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 STR_0D
ids_properties/plugins/infrastructure_put/commit Unique commit reference of software {constant} STR_0D
ids_properties/plugins/infrastructure_put/version Unique version (tag) of software {constant} STR_0D
ids_properties/plugins/infrastructure_put/repository URL of software repository {constant} STR_0D
ids_properties/plugins/infrastructure_get Plugin infrastructure used to GET the data structure
ids_properties/plugins/infrastructure_get/name Name of software used {constant} STR_0D
ids_properties/plugins/infrastructure_get/description Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 STR_0D
ids_properties/plugins/infrastructure_get/commit Unique commit reference of software {constant} STR_0D
ids_properties/plugins/infrastructure_get/version Unique version (tag) of software {constant} STR_0D
ids_properties/plugins/infrastructure_get/repository URL of software repository {constant} STR_0D
coil(i1) Set of coils {static} array of structures [max_size=32 (limited in MDS+ backend only)] 1- 1...N
coil(i1)/name Name of the coil {static} STR_0D
coil(i1)/identifier Alphanumeric identifier of coil {static} STR_0D
coil(i1)/conductor(i2) Set of conductors inside the coil. The structure can be used with size 1 for a simplified description as a single conductor. A conductor is composed of several elements, serially connected, i.e. transporting the same current. {static} array of structures [max_size=20 (limited in MDS+ backend only)] 1- 1...N
coil(i1)/conductor(i2)/elements Set of geometrical elements (line segments and/or arcs of a circle) describing the contour of the conductor centre. We define a coordinate system associated to each element as follows: for the arc and circle elements: binormal = (start point - center) x (intermediate point - center). This vector points in the direction of the circle / arc axis. normal = (center - point on curve). The normal vector will rotate as the point moves around the curve. Tangent = normal x binormal. For the line element we require an extra point, using the currently redundant intermediate point to define the line element's normal axis. The local coordinates for the line element then become: tangent = end point - start point; normal = intermediate point - start point; binormal = tangent x normal. It is assumed that all the axes above are normalized such that they have a unit length. structure
coil(i1)/conductor(i2)/elements/types(:) Type of every element: 1: line segment, its ends are given by the start and end points; index = 2: arc of a circle; index = 3: full circle {static} INT_1D 1- 1...N
coil(i1)/conductor(i2)/elements/start_points Position of the start point of every element structure
coil(i1)/conductor(i2)/elements/start_points/r(:) Major radius {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/start_points/phi(:) Toroidal angle (oriented counter-clockwise when viewing from above) {static} [rad] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/start_points/z(:) Height {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/intermediate_points Position of an intermediate point along the circle or arc of circle, for every element, providing the orientation of the element (must define with the corresponding start point an aperture angle strictly inferior to PI). In the case of a line segment (../types/index=1), fill this node with a point such that the vector intermediate_point - start_point defines the direction of the element's normal axis (see documentation of ../elements) structure
coil(i1)/conductor(i2)/elements/intermediate_points/r(:) Major radius {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/intermediate_points/phi(:) Toroidal angle (oriented counter-clockwise when viewing from above) {static} [rad] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/intermediate_points/z(:) Height {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/end_points Position of the end point of every element. Meaningful only if type/index = 1 or 2, fill with default/empty value otherwise structure
coil(i1)/conductor(i2)/elements/end_points/r(:) Major radius {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/end_points/phi(:) Toroidal angle (oriented counter-clockwise when viewing from above) {static} [rad] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/end_points/z(:) Height {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/centres Position of the centre of the arc of a circle of every element (meaningful only if type/index = 2 or 3, fill with default/empty value otherwise) structure
coil(i1)/conductor(i2)/elements/centres/r(:) Major radius {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/centres/phi(:) Toroidal angle (oriented counter-clockwise when viewing from above) {static} [rad] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/elements/centres/z(:) Height {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/elements/types
coil(i1)/conductor(i2)/cross_section(i3) The cross-section perpendicular to the conductor contour is described by a series of contour points, given by their relative position with respect to the start point of each element. If the size of this array of structure is equal to 1, then the cross-section is given only for the first element and translated along the conductor elements. Otherwise, it's given explictly for each element, allowing to describe changes of the cross section shape. Introduced after DD version 3.39.0 array of structures [max_size=50 (limited in MDS+ backend only)] 1- coil(i1)/conductor(i2)/elements/types OR 1...1
coil(i1)/conductor(i2)/cross_section(i3)/geometry_type Geometry type used to describe the cross section of this element. The conductor centre is given by the ../../elements description.. Available options (refer to the children of this identifier structure) :
Name Index Description
polygon 1 Contour described by a polygonal outline
circle 2 Circle
rectangle 3 Rectangle
square 4 Square
annulus 5 Annulus
structure
coil(i1)/conductor(i2)/cross_section(i3)/geometry_type/name Short string identifier {static} STR_0D
coil(i1)/conductor(i2)/cross_section(i3)/geometry_type/index Integer identifier (enumeration index within a list). Private identifier values must be indicated by a negative index. {static} INT_0D
coil(i1)/conductor(i2)/cross_section(i3)/geometry_type/description Verbose description {static} STR_0D
coil(i1)/conductor(i2)/cross_section(i3)/width Full width of the rectangle or square in the normal direction, when geometry_type/index = 3 or 4. Diameter of the circle when geometry_type/index = 2. Outer diameter of the annulus in case geometry_type/index = 5 {static} [m] FLT_0D
coil(i1)/conductor(i2)/cross_section(i3)/height Full height of the rectangle in the binormal direction, used only if geometry_type/index = 3 {static} [m] FLT_0D
coil(i1)/conductor(i2)/cross_section(i3)/radius_inner Inner radius of the annulus, used only if geometry_type/index = 5 {static} [m] FLT_0D
coil(i1)/conductor(i2)/cross_section(i3)/outline Polygonal outline of the cross section in the (normal, binormal) coordinate system. Do NOT repeat the first point. structure
coil(i1)/conductor(i2)/cross_section(i3)/outline/normal(:) Coordinate along the normal axis {static} [m] FLT_1D 1- 1...N
coil(i1)/conductor(i2)/cross_section(i3)/outline/binormal(:) Coordinates along the binormal axis {static} [m] FLT_1D 1- coil(i1)/conductor(i2)/cross_section(i3)/outline/normal
coil(i1)/conductor(i2)/cross_section(i3)/area Area of the conductor cross-section, derived from the above geometric data {static} [m^2] FLT_0D
coil(i1)/conductor(i2)/resistance conductor resistance {static} [Ohm] FLT_0D
coil(i1)/conductor(i2)/voltage Voltage on the conductor terminals. Sign convention : positive when the current flows in the direction in which conductor elements are ordered (from start to end for a positive polarity coil) [V] structure
coil(i1)/conductor(i2)/voltage/data(:) Data {dynamic} [as_parent] FLT_1D 1- coil(i1)/conductor(i2)/voltage/time
coil(i1)/conductor(i2)/voltage/time(:) Time {dynamic} [s] FLT_1D 1- 1...N
coil(i1)/turns Number of total turns in the coil. May be a fraction when describing the coil connections. {static} [-] FLT_0D
coil(i1)/resistance Coil resistance {static} [Ohm] FLT_0D
coil(i1)/current Current in one turn of the coil (to be multiplied by the number of turns to calculate the magnetic field generated). Sign convention : a positive current flows in the direction in which conductor elements are ordered (from start to end for a positive polarity coil) [A] structure
coil(i1)/current/data(:) Data {dynamic} [as_parent] FLT_1D 1- coil(i1)/current/time
coil(i1)/current/time(:) Time {dynamic} [s] FLT_1D 1- 1...N
coil(i1)/voltage Voltage on the coil terminals. Sign convention : positive when the current flows in the direction in which conductor elements are ordered (from start to end for a positive polarity coil) [V] structure
coil(i1)/voltage/data(:) Data {dynamic} [as_parent] FLT_1D 1- coil(i1)/voltage/time
coil(i1)/voltage/time(:) Time {dynamic} [s] FLT_1D 1- 1...N
latency Upper bound of the delay between input command received from the RT network and actuator starting to react. Applies globally to the system described by this IDS unless specific latencies (e.g. channel-specific or antenna-specific) are provided at a deeper level in the IDS structure. {static} [s]. Introduced after DD version 3.32.1 FLT_0D
code Generic decription of the code-specific parameters for the code that has produced this IDS structure
code/name Name of software generating IDS {constant} STR_0D
code/description Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 STR_0D
code/commit Unique commit reference of software {constant} STR_0D
code/version Unique version (tag) of software {constant} STR_0D
code/repository URL of software repository {constant} STR_0D
code/parameters List of the code specific parameters in XML format {constant} STR_0D
code/output_flag(:) Output flag : 0 means the run is successful, other values mean some difficulty has been encountered, the exact meaning is then code specific. Negative values mean the result shall not be used. {dynamic} INT_1D 1- time
code/library(i1) List of external libraries used by the code that has produced this IDS array of structures [max_size=10 (limited in MDS+ backend only)] 1- 1...N
code/library(i1)/name Name of software {constant} STR_0D
code/library(i1)/description Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 STR_0D
code/library(i1)/commit Unique commit reference of software {constant} STR_0D
code/library(i1)/version Unique version (tag) of software {constant} STR_0D
code/library(i1)/repository URL of software repository {constant} STR_0D
code/library(i1)/parameters List of the code specific parameters in XML format {constant} STR_0D
time(:) Generic time {dynamic} [s] FLT_1D 1- 1...N

Back to top IDS list