ITER Physics Data Model Documentation for iron_core

Iron core description

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.2.3

Last change occured on version: 3.12.1

Back to top IDS list

You are now in flat display mode, note that errorbars are not visible in this mode

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/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/source
Lifecycle status: obsolescent since version 3.34.0
Source of the data (any comment describing the origin of the data : code, path to diagnostic signals, processing method, ...). Superseeded by the new provenance structure. {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} struct_array [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)/sources(:) List of sources used to import or calculate this node, identified as explained below. In case the node is the result of of a calculation / data processing, the source is an input to the process described in the "code" structure at the root of the IDS. The source 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 source, or the persistent identifier of the data source). 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 sources. Click here for further documentation. {constant} STR_1D 1- 1...N
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} struct_array [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) struct_array [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) struct_array [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. struct_array [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
segment(i1) The iron core is describred as a set of segments struct_array [max_size=33 (limited in MDS+ backend only)] 1- 1...N
segment(i1)/name Name of the segment {static} STR_0D
segment(i1)/identifier ID of the segment {static} STR_0D
segment(i1)/b_field(:) Array of magnetic field values, for each of which the relative permeability is given {static} [T] FLT_1D 1- 1...N
segment(i1)/permeability_relative(:) Relative permeability of the iron segment {static} [-] FLT_1D 1- segment(i1)/b_field
segment(i1)/geometry Cross-sectional shape of the segment structure
segment(i1)/geometry/geometry_type Type used to describe the element shape (1:'outline', 2:'rectangle', 3:'oblique', 4:'arcs of circle, 5: 'annulus', 6 : 'thick line') {static} INT_0D
segment(i1)/geometry/outline Irregular outline of the element. Do NOT repeat the first point. structure
segment(i1)/geometry/outline/r(:) Major radius {static} [m] FLT_1D 1- 1...N
segment(i1)/geometry/outline/z(:) Height {static} [m] FLT_1D 1- segment(i1)/geometry/outline/r
segment(i1)/geometry/rectangle Rectangular description of the element structure
segment(i1)/geometry/rectangle/r Geometric centre R {static} [m] FLT_0D
segment(i1)/geometry/rectangle/z Geometric centre Z {static} [m] FLT_0D
segment(i1)/geometry/rectangle/width Horizontal full width {static} [m] FLT_0D
segment(i1)/geometry/rectangle/height Vertical full height {static} [m] FLT_0D
segment(i1)/geometry/oblique Parallelogram description of the element structure
segment(i1)/geometry/oblique/r Major radius of the reference point (from which the alpha and beta angles are defined, marked by a + on the diagram) Click here for further documentation. {static} [m] FLT_0D
segment(i1)/geometry/oblique/z Height of the reference point (from which the alpha and beta angles are defined, marked by a + on the diagram) Click here for further documentation. {static} [m] FLT_0D
segment(i1)/geometry/oblique/length_alpha Length of the parallelogram side inclined with angle alpha with respect to the major radius axis Click here for further documentation. {static} [m] FLT_0D
segment(i1)/geometry/oblique/length_beta Length of the parallelogram side inclined with angle beta with respect to the height axis Click here for further documentation. {static} [m] FLT_0D
segment(i1)/geometry/oblique/alpha Inclination of first angle measured counter-clockwise from horizontal outwardly directed radial vector (grad R). Click here for further documentation. {static} [rad] FLT_0D
segment(i1)/geometry/oblique/beta Inclination of second angle measured counter-clockwise from vertically upwards directed vector (grad Z). If both alpha and beta are zero (rectangle) then the simpler rectangular elements description should be used. Click here for further documentation. {static} [rad] FLT_0D
segment(i1)/geometry/arcs_of_circle Description of the element contour by a set of arcs of circle. For each of these, the position of the start point is given together with the curvature radius. The end point is given by the start point of the next arc of circle. structure
segment(i1)/geometry/arcs_of_circle/r(:) Major radii of the start point of each arc of circle {static} [m] FLT_1D 1- 1...N
segment(i1)/geometry/arcs_of_circle/z(:) Height of the start point of each arc of circle {static} [m] FLT_1D 1- segment(i1)/geometry/arcs_of_circle/r
segment(i1)/geometry/arcs_of_circle/curvature_radii(:) Curvature radius of each arc of circle {static} [m] FLT_1D 1- segment(i1)/geometry/arcs_of_circle/r
segment(i1)/geometry/annulus The element is an annulus of centre R, Z, with inner radius radius_inner and outer radius radius_outer. Introduced after DD version 3.34.0 structure
segment(i1)/geometry/annulus/r Centre major radius {static} [m] FLT_0D
segment(i1)/geometry/annulus/z Centre height {static} [m] FLT_0D
segment(i1)/geometry/annulus/radius_inner Inner radius {static} [m] FLT_0D
segment(i1)/geometry/annulus/radius_outer Outer radius {static} [m] FLT_0D
segment(i1)/geometry/thick_line The element is approximated by a rectangle defined by a central segment and a thickness in the direction perpendicular to the segment. Introduced after DD version 3.36.0 structure
segment(i1)/geometry/thick_line/first_point Position of the first point structure
segment(i1)/geometry/thick_line/first_point/r Major radius {static} [m] FLT_0D
segment(i1)/geometry/thick_line/first_point/z Height {static} [m] FLT_0D
segment(i1)/geometry/thick_line/second_point Position of the second point structure
segment(i1)/geometry/thick_line/second_point/r Major radius {static} [m] FLT_0D
segment(i1)/geometry/thick_line/second_point/z Height {static} [m] FLT_0D
segment(i1)/geometry/thick_line/thickness Thickness {static} [m] FLT_0D
segment(i1)/magnetisation_r Magnetisation M of the iron segment along the major radius axis, assumed to be constant inside a given iron segment. Reminder : H = 1/mu0 * B - mur * M; [T] structure
segment(i1)/magnetisation_r/data(:) Data {dynamic} [as_parent] FLT_1D 1- segment(i1)/magnetisation_r/time
segment(i1)/magnetisation_r/time(:) Time {dynamic} [s] FLT_1D 1- 1...N
segment(i1)/magnetisation_z Magnetisation M of the iron segment along the vertical axis, assumed to be constant inside a given iron segment. Reminder : H = 1/mu0 * B - mur * M; [T] structure
segment(i1)/magnetisation_z/data(:) Data {dynamic} [as_parent] FLT_1D 1- segment(i1)/magnetisation_z/time
segment(i1)/magnetisation_z/time(:) Time {dynamic} [s] FLT_1D 1- 1...N
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 struct_array [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