iron coreΒΆ

PathDimensionsTypeUnitsDescription

iron_core

(alpha)

Iron core description

iron_core.code

(alpha)

STRUCTURE

Generic decription of the code-specific parameters for the code that has produced this IDS

iron_core.code.commit

(alpha)

STR_0D

Unique commit reference of software

iron_core.code.description

(alpha)

STR_0D

Short description of the software (type, purpose)

iron_core.code.library

(alpha)

[1...N]

STRUCT_ARRAY

List of external libraries used by the code that has produced this IDS

iron_core.code.library[:].commit

(alpha)

STR_0D

Unique commit reference of software

iron_core.code.library[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

iron_core.code.library[:].name

(alpha)

STR_0D

Name of software

iron_core.code.library[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

iron_core.code.library[:].repository

(alpha)

STR_0D

URL of software repository

iron_core.code.library[:].version

(alpha)

STR_0D

Unique version (tag) of software

iron_core.code.name

(alpha)

STR_0D

Name of software generating IDS

iron_core.code.output_flag

(alpha)

[iron_core.time]

INT_1D

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.

iron_core.code.parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

iron_core.code.repository

(alpha)

STR_0D

URL of software repository

iron_core.code.version

(alpha)

STR_0D

Unique version (tag) of software

iron_core.ids_properties

(alpha)

STRUCTURE

Interface Data Structure properties. This element identifies the node above as an IDS

iron_core.ids_properties.comment

(alpha)

STR_0D

Any comment describing the content of this IDS

iron_core.ids_properties.creation_date

(alpha)

STR_0D

Date at which this data has been produced

iron_core.ids_properties.homogeneous_time

(alpha)

INT_0D

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

iron_core.ids_properties.name

(alpha)

STR_0D

User-defined name for this IDS occurrence

iron_core.ids_properties.occurrence

INT_0D

iron_core.ids_properties.occurrence_type

(alpha)

STRUCTURE

Type of data contained in this occurrence
1) reconstruction : Equilibrium reconstruction
2) prediction_fixed : Equilibrium prediction, fixed boundary
3) prediction_free : Equilibrium prediction, free boundary
4) mapping : 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

iron_core.ids_properties.occurrence_type.description

(alpha)

STR_0D

Verbose description

iron_core.ids_properties.occurrence_type.index

(alpha)

INT_0D

Integer identifier (enumeration index within a list). Private identifier values must be indicated by a negative index.

iron_core.ids_properties.occurrence_type.name

(alpha)

STR_0D

Short string identifier

iron_core.ids_properties.plugins

(alpha)

STRUCTURE

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.

iron_core.ids_properties.plugins.infrastructure_get

(alpha)

STRUCTURE

Plugin infrastructure used to GET the data

iron_core.ids_properties.plugins.infrastructure_get.commit

(alpha)

STR_0D

Unique commit reference of software

iron_core.ids_properties.plugins.infrastructure_get.description

(alpha)

STR_0D

Short description of the software (type, purpose)

iron_core.ids_properties.plugins.infrastructure_get.name

(alpha)

STR_0D

Name of software used

iron_core.ids_properties.plugins.infrastructure_get.repository

(alpha)

STR_0D

URL of software repository

iron_core.ids_properties.plugins.infrastructure_get.version

(alpha)

STR_0D

Unique version (tag) of software

iron_core.ids_properties.plugins.infrastructure_put

(alpha)

STRUCTURE

Plugin infrastructure used to PUT the data

iron_core.ids_properties.plugins.infrastructure_put.commit

(alpha)

STR_0D

Unique commit reference of software

iron_core.ids_properties.plugins.infrastructure_put.description

(alpha)

STR_0D

Short description of the software (type, purpose)

iron_core.ids_properties.plugins.infrastructure_put.name

(alpha)

STR_0D

Name of software used

iron_core.ids_properties.plugins.infrastructure_put.repository

(alpha)

STR_0D

URL of software repository

iron_core.ids_properties.plugins.infrastructure_put.version

(alpha)

STR_0D

Unique version (tag) of software

iron_core.ids_properties.plugins.node

(alpha)

[1...N]

STRUCT_ARRAY

Set of IDS nodes for which a plugin has been applied

iron_core.ids_properties.plugins.node[:].get_operation

(alpha)

[1...N]

STRUCT_ARRAY

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.

iron_core.ids_properties.plugins.node[:].get_operation[:].commit

(alpha)

STR_0D

Unique commit reference of software

iron_core.ids_properties.plugins.node[:].get_operation[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

iron_core.ids_properties.plugins.node[:].get_operation[:].name

(alpha)

STR_0D

Name of software used

iron_core.ids_properties.plugins.node[:].get_operation[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

iron_core.ids_properties.plugins.node[:].get_operation[:].repository

(alpha)

STR_0D

URL of software repository

iron_core.ids_properties.plugins.node[:].get_operation[:].version

(alpha)

STR_0D

Unique version (tag) of software

iron_core.ids_properties.plugins.node[:].path

(alpha)

STR_0D

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.

iron_core.ids_properties.plugins.node[:].put_operation

(alpha)

[1...N]

STRUCT_ARRAY

Plugins used to PUT a node (potentially, multiple plugins can be applied, if so they are listed by order of application)

iron_core.ids_properties.plugins.node[:].put_operation[:].commit

(alpha)

STR_0D

Unique commit reference of software

iron_core.ids_properties.plugins.node[:].put_operation[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

iron_core.ids_properties.plugins.node[:].put_operation[:].name

(alpha)

STR_0D

Name of software used

iron_core.ids_properties.plugins.node[:].put_operation[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

iron_core.ids_properties.plugins.node[:].put_operation[:].repository

(alpha)

STR_0D

URL of software repository

iron_core.ids_properties.plugins.node[:].put_operation[:].version

(alpha)

STR_0D

Unique version (tag) of software

iron_core.ids_properties.plugins.node[:].readback

(alpha)

[1...N]

STRUCT_ARRAY

Plugins to be used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application)

iron_core.ids_properties.plugins.node[:].readback[:].commit

(alpha)

STR_0D

Unique commit reference of software

iron_core.ids_properties.plugins.node[:].readback[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

iron_core.ids_properties.plugins.node[:].readback[:].name

(alpha)

STR_0D

Name of software used

iron_core.ids_properties.plugins.node[:].readback[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

iron_core.ids_properties.plugins.node[:].readback[:].repository

(alpha)

STR_0D

URL of software repository

iron_core.ids_properties.plugins.node[:].readback[:].version

(alpha)

STR_0D

Unique version (tag) of software

iron_core.ids_properties.provenance

(alpha)

STRUCTURE

Provenance information about this IDS

iron_core.ids_properties.provenance.node

(alpha)

[1...N]

STRUCT_ARRAY

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

iron_core.ids_properties.provenance.node[:].path

(alpha)

STR_0D

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.

iron_core.ids_properties.provenance.node[:].sources

(alpha)

[1...N]

STR_1D

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.

iron_core.ids_properties.provider

(alpha)

STR_0D

Name of the person in charge of producing this data

iron_core.ids_properties.source

(obsolescent)

STR_0D

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.

iron_core.ids_properties.version_put

(alpha)

STRUCTURE

Version of the access layer package used to PUT this IDS

iron_core.ids_properties.version_put.access_layer

(alpha)

STR_0D

Version of Access Layer used to PUT this IDS

iron_core.ids_properties.version_put.access_layer_language

(alpha)

STR_0D

Programming language of the Access Layer high level API used to PUT this IDS

iron_core.ids_properties.version_put.data_dictionary

(alpha)

STR_0D

Version of Data Dictionary used to PUT this IDS

iron_core.segment

(alpha)

[1...N]

STRUCT_ARRAY

The iron core is describred as a set of segments

iron_core.segment[:].b_field

(alpha)

[1...N]

FLT_1D (uncertain)

T

Array of magnetic field values, for each of which the relative permeability is given

iron_core.segment[:].geometry

(alpha)

STRUCTURE

Cross-sectional shape of the segment

iron_core.segment[:].geometry.annulus

(alpha)

STRUCTURE

The element is an annulus of centre R, Z, with inner radius radius_inner and outer radius radius_outer

iron_core.segment[:].geometry.annulus.r

(alpha)

FLT_0D (uncertain)

m

Centre major radius

iron_core.segment[:].geometry.annulus.radius_inner

(alpha)

FLT_0D (uncertain)

m

Inner radius

iron_core.segment[:].geometry.annulus.radius_outer

(alpha)

FLT_0D (uncertain)

m

Outer radius

iron_core.segment[:].geometry.annulus.z

(alpha)

FLT_0D (uncertain)

m

Centre height

iron_core.segment[:].geometry.arcs_of_circle

(alpha)

STRUCTURE

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.

iron_core.segment[:].geometry.arcs_of_circle.curvature_radii

(alpha)

[iron_core.segment[:].geometry.arcs_of_circle.r]

FLT_1D (uncertain)

m

Curvature radius of each arc of circle

iron_core.segment[:].geometry.arcs_of_circle.r

(alpha)

[1...N]

FLT_1D (uncertain)

m

Major radii of the start point of each arc of circle

iron_core.segment[:].geometry.arcs_of_circle.z

(alpha)

[iron_core.segment[:].geometry.arcs_of_circle.r]

FLT_1D (uncertain)

m

Height of the start point of each arc of circle

iron_core.segment[:].geometry.geometry_type

(alpha)

INT_0D

Type used to describe the element shape (1:'outline', 2:'rectangle', 3:'oblique', 4:'arcs of circle, 5: 'annulus', 6 : 'thick line')

iron_core.segment[:].geometry.oblique

(alpha)

STRUCTURE

Parallelogram description of the element

iron_core.segment[:].geometry.oblique.alpha

(alpha)

FLT_0D (uncertain)

rad

Inclination of first angle measured counter-clockwise from horizontal outwardly directed radial vector (grad R).

iron_core.segment[:].geometry.oblique.beta

(alpha)

FLT_0D (uncertain)

rad

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.

iron_core.segment[:].geometry.oblique.length_alpha

(alpha)

FLT_0D (uncertain)

m

Length of the parallelogram side inclined with angle alpha with respect to the major radius axis

iron_core.segment[:].geometry.oblique.length_beta

(alpha)

FLT_0D (uncertain)

m

Length of the parallelogram side inclined with angle beta with respect to the height axis

iron_core.segment[:].geometry.oblique.r

(alpha)

FLT_0D (uncertain)

m

Major radius of the reference point (from which the alpha and beta angles are defined, marked by a + on the diagram)

iron_core.segment[:].geometry.oblique.z

(alpha)

FLT_0D (uncertain)

m

Height of the reference point (from which the alpha and beta angles are defined, marked by a + on the diagram)

iron_core.segment[:].geometry.outline

(alpha)

STRUCTURE

Irregular outline of the element. Do NOT repeat the first point.

iron_core.segment[:].geometry.outline.r

(alpha)

[1...N]

FLT_1D (uncertain)

m

Major radius

iron_core.segment[:].geometry.outline.z

(alpha)

[iron_core.segment[:].geometry.outline.r]

FLT_1D (uncertain)

m

Height

iron_core.segment[:].geometry.rectangle

(alpha)

STRUCTURE

Rectangular description of the element

iron_core.segment[:].geometry.rectangle.height

(alpha)

FLT_0D (uncertain)

m

Vertical full height

iron_core.segment[:].geometry.rectangle.r

(alpha)

FLT_0D (uncertain)

m

Geometric centre R

iron_core.segment[:].geometry.rectangle.width

(alpha)

FLT_0D (uncertain)

m

Horizontal full width

iron_core.segment[:].geometry.rectangle.z

(alpha)

FLT_0D (uncertain)

m

Geometric centre Z

iron_core.segment[:].geometry.thick_line

(alpha)

STRUCTURE

The element is approximated by a rectangle defined by a central segment and a thickness in the direction perpendicular to the segment

iron_core.segment[:].geometry.thick_line.first_point

(alpha)

STRUCTURE

Position of the first point

iron_core.segment[:].geometry.thick_line.first_point.r

(alpha)

FLT_0D (uncertain)

m

Major radius

iron_core.segment[:].geometry.thick_line.first_point.z

(alpha)

FLT_0D (uncertain)

m

Height

iron_core.segment[:].geometry.thick_line.second_point

(alpha)

STRUCTURE

Position of the second point

iron_core.segment[:].geometry.thick_line.second_point.r

(alpha)

FLT_0D (uncertain)

m

Major radius

iron_core.segment[:].geometry.thick_line.second_point.z

(alpha)

FLT_0D (uncertain)

m

Height

iron_core.segment[:].geometry.thick_line.thickness

(alpha)

FLT_0D (uncertain)

m

Thickness

iron_core.segment[:].identifier

(alpha)

STR_0D

ID of the segment

iron_core.segment[:].magnetisation_r

(alpha)

STRUCTURE

T

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;

iron_core.segment[:].magnetisation_r.data

(alpha)

[iron_core.segment[:].magnetisation_r.time]

FLT_1D (uncertain)

T

Data

iron_core.segment[:].magnetisation_r.time

(alpha)

[1...N]

FLT_1D_TYPE

s

Time

iron_core.segment[:].magnetisation_z

(alpha)

STRUCTURE

T

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;

iron_core.segment[:].magnetisation_z.data

(alpha)

[iron_core.segment[:].magnetisation_z.time]

FLT_1D (uncertain)

T

Data

iron_core.segment[:].magnetisation_z.time

(alpha)

[1...N]

FLT_1D_TYPE

s

Time

iron_core.segment[:].name

(alpha)

STR_0D

Name of the segment

iron_core.segment[:].permeability_relative

(alpha)

[iron_core.segment[:].b_field]

FLT_1D (uncertain)

-

Relative permeability of the iron segment

iron_core.time

(alpha)

[1...N]

FLT_1D_TYPE

s

Generic time