Skip to content

Extension/issue 85 #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from
Open

Extension/issue 85 #151

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7574d72
First modifications of the distributions IDS (issue-85)
imbeauf Jul 8, 2025
3fb20be
[issue-85] Implementing points 4 and 5
imbeauf Sep 3, 2025
fb46690
[issue-85] remove irrelevant structure
imbeauf Sep 23, 2025
c9be00b
[issue-85] Update dd_versions.html
imbeauf Sep 23, 2025
444a793
Correct units
imbeauf Oct 2, 2025
22e88cf
Correct units
imbeauf Oct 2, 2025
c72dc6a
Merge branch 'develop' into extension/issue-85
imbeauf Oct 2, 2025
2d8022c
[issue-85] Correct units and precise description of gyrophase
imbeauf Oct 2, 2025
c01f578
[issue-85] Added energy and improved definition of the CoM cell volume
imbeauf Oct 17, 2025
3fcb942
Update schemas/distributions/dd_distributions.xsd
imbeauf Nov 3, 2025
13b5e37
Update schemas/distributions/dd_distributions.xsd
imbeauf Nov 3, 2025
2e06f10
[issue-85] Clarification of the definition of the normalised CoM volu…
imbeauf Nov 12, 2025
360ee47
Merge branch 'extension/issue-85' of github.com:imbeauf/IMAS-Data-Dic…
imbeauf Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion html_documentation/dd_versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<p><a href="html_documentation.html">Back to top IDS list</a></p>
<tr>
<td>develop</td>
<td>Add Boron species to the SUMMARY IDS. Add state velocity structure in CORE_PROFILES and PLASMA_PROFILES. Add total ion density source term in CORE_SOURCES and PLASMA_SOURCES. Add a few power loss global quantities in the DISTRIBUTIONS IDS. Add b_field and em_force_density in the WALL IDS. Change to _phi the suffix of toroidal vector components that had been missed and remained as _tor (affects the following IDSs: SPI, SAWTEETH, RUNAWAY_ELECTRONS, DISTRIBUTIONS, DISTRIBUTIONS_SOURCES, LH_ANTENNAS, B_FIELD_NON_AXISYMMETRIC, SPECTROMETER_VISIBLE). Add coil geometry in PF_ACTIVE IDS. Add new global quantities in the PLASMA_INITIATION IDS. Add perpendicular pressure in the DISTRIBUTIONS IDS. Restructuring of the BOLOMETER IDS. Add validity signals in the THOMSON_SCATTERING IDS. Restructuring of the CAMERA_IR IDS, addition of Bidirectional Reflectance Distribution Function (BRDF) to the WALL IDS. Small change in the EQUILIBRIUM IDS. Add a list of equivalent field probes in the MAGNETICS IDS. Extension of the NEUTRON_DIAGNOSTIC IDS. New BALANCE_OF_PLANT and BREEDING_BLANKET IDSs. Add parallel direction for the GGD transport coefficients in the PLASMA_TRANSPORT IDS. Extensions to the EQUILIBRIUM and DISRUPTION IDS. Merge the DATASET_DESCRIPTION IDS into the SUMMARY IDS (and delete the DATASET_DESCRIPTION IDS). Extension of the CHARGE_EXCHANGE IDS. Add constant plasma composition in the SUMMARY IDS. Add estimated central electron temperature to the CAMERA_X_RAYS IDS. Rename some remaining "label" nodes into "name" in the PLASMA_PROFILES and PLASMA_TRANSPORT IDSs. Replace id/identifier string by description string and put the standard name definition in the FOCS, TF_COIL, LH_ANTENNAS, OPERATIONAL_INSTRUMENTATION and COILS_NON_AXISYMMETRIC IDSs. Modification of sputtering coefficients dimensions in the WALL IDS (global quantities). Extension of the EC_LAUNCHERS IDS with a mirror structure. Corrected the notation of isotopes in the node descriptions in DISTRIBUTIONS, DISTRIBUTIONS_SOURCES and SPECTROMETER_VISIBLE IDS, and also in the DISTRIBUTION_SOURCE_IDENTIFIER names. Will result in a minor revision</td>
<td>Add Boron species to the SUMMARY IDS. Add state velocity structure in CORE_PROFILES and PLASMA_PROFILES. Add total ion density source term in CORE_SOURCES and PLASMA_SOURCES. Add a few power loss global quantities in the DISTRIBUTIONS IDS. Add b_field and em_force_density in the WALL IDS. Change to _phi the suffix of toroidal vector components that had been missed and remained as _tor (affects the following IDSs: SPI, SAWTEETH, RUNAWAY_ELECTRONS, DISTRIBUTIONS, DISTRIBUTIONS_SOURCES, LH_ANTENNAS, B_FIELD_NON_AXISYMMETRIC, SPECTROMETER_VISIBLE). Add coil geometry in PF_ACTIVE IDS. Add new global quantities in the PLASMA_INITIATION IDS. Add perpendicular pressure in the DISTRIBUTIONS IDS. Restructuring of the BOLOMETER IDS. Add validity signals in the THOMSON_SCATTERING IDS. Restructuring of the CAMERA_IR IDS, addition of Bidirectional Reflectance Distribution Function (BRDF) to the WALL IDS. Small change in the EQUILIBRIUM IDS. Add a list of equivalent field probes in the MAGNETICS IDS. Extension of the NEUTRON_DIAGNOSTIC IDS. New BALANCE_OF_PLANT and BREEDING_BLANKET IDSs. Add parallel direction for the GGD transport coefficients in the PLASMA_TRANSPORT IDS. Extensions to the EQUILIBRIUM and DISRUPTION IDS. Merge the DATASET_DESCRIPTION IDS into the SUMMARY IDS (and delete the DATASET_DESCRIPTION IDS). Extension of the CHARGE_EXCHANGE IDS. Add constant plasma composition in the SUMMARY IDS. Add estimated central electron temperature to the CAMERA_X_RAYS IDS. Rename some remaining "label" nodes into "name" in the PLASMA_PROFILES and PLASMA_TRANSPORT IDSs. Replace id/identifier string by description string and put the standard name definition in the FOCS, TF_COIL, LH_ANTENNAS, OPERATIONAL_INSTRUMENTATION and COILS_NON_AXISYMMETRIC IDSs. Modification of sputtering coefficients dimensions in the WALL IDS (global quantities). Extension of the EC_LAUNCHERS IDS with a mirror structure. Corrected the notation of isotopes in the node descriptions in DISTRIBUTIONS, DISTRIBUTIONS_SOURCES and SPECTROMETER_VISIBLE IDS, and also in the DISTRIBUTION_SOURCE_IDENTIFIER names. Extension of the DISTRIBUTIONS and DISTRIBUTIONS_SOURCES IDS with constants of motion. Will result in a minor revision</td>
</tr>
<tr>
<td><b>4.0.0</b></td>
Expand Down
30 changes: 30 additions & 0 deletions schemas/distributions/dd_distributions.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2885,6 +2885,36 @@
<xs:documentation>Grid. The grid has to be rectangular in a pair of coordinates, as specified in type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="r">
<xs:annotation>
<xs:documentation>Major radius (for plotting purposes, if the 2D grid is not given in (R,Z))</xs:documentation>
<xs:appinfo>
<coordinate1>../grid/rho_tor_norm</coordinate1>
<coordinate2>../grid/theta_geometric OR ../grid/theta_straight</coordinate2>
<units>m^-3</units>
<type>dynamic</type>
<introduced_after_version>4.0.0</introduced_after_version>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:group ref="FLT_2D"/>
</xs:complexType>
</xs:element>
<xs:element name="z">
<xs:annotation>
<xs:documentation>Height (for plotting purposes, if the 2D grid is not given in (R,Z))</xs:documentation>
<xs:appinfo>
<coordinate1>../grid/rho_tor_norm</coordinate1>
<coordinate2>../grid/theta_geometric OR ../grid/theta_straight</coordinate2>
<units>m^-3</units>
<type>dynamic</type>
<introduced_after_version>4.0.0</introduced_after_version>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:group ref="FLT_2D"/>
</xs:complexType>
</xs:element>
<xs:element name="density">
<xs:annotation>
<xs:documentation>Density (thermal+non-thermal)</xs:documentation>
Expand Down
63 changes: 63 additions & 0 deletions schemas/utilities/dd_support.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6887,6 +6887,52 @@
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="distributions_d_ggd_midplane_invariants">
<xs:annotation>
<xs:documentation>Midplane values of the motion invariants, for each orbit, evaluated at the minimum of B.grad(B) along the orbit</xs:documentation>
<xs:appinfo>
<aos3Parent>yes</aos3Parent>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element name="r" type="generic_grid_scalar" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Major radius, for various grid subsets</xs:documentation>
<xs:appinfo>
<coordinate1>1...N</coordinate1>
<units>m</units>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="z" type="generic_grid_scalar" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Height, for various grid subsets</xs:documentation>
<xs:appinfo>
<coordinate1>1...N</coordinate1>
<units>m</units>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="v_parallel" type="generic_grid_scalar" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Parallel velocity, for various grid subsets</xs:documentation>
<xs:appinfo>
<coordinate1>1...N</coordinate1>
<units>m.s^-1</units>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="phase" type="generic_grid_scalar" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Phase, for various grid subsets</xs:documentation>
<xs:appinfo>
<coordinate1>1...N</coordinate1>
<units>rad</units>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="distributions_d_ggd_orbit">
<xs:annotation>
<xs:documentation>Description of the particle orbits for a given time slice, using a GGD representation</xs:documentation>
Expand Down Expand Up @@ -7014,6 +7060,23 @@
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="midplane_motion_invariants" type="distributions_d_ggd_midplane_invariants">
<xs:annotation>
<xs:documentation>Midplane values of the motion invariants, for each orbit, evaluated at the minimum of B.grad(B) along the orbit</xs:documentation>
<xs:appinfo>
<introduced_after_version>4.0.0</introduced_after_version>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="motion_invariants_volume" type="generic_grid_scalar">
<xs:annotation>
<xs:documentation>Volume of the invariants of motion space volume elements</xs:documentation>
Copy link
Collaborator

@SimonPinches SimonPinches Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a simpler way to say this?

Copy link

@brochag brochag Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would use "Normalised volume of the CoM (constants of motion) cell elements". Constant is a more widely used terminology in the EP community than invariant.

Copy link
Collaborator Author

@imbeauf imbeauf Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's normalized, to what is it normalized ? And what should be the units of this ? For the moment I indicated T.m^2.J

Copy link

@brochag brochag Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the energy I use eV instead of J, so that the CoM volume unit is T.m^2.eV.

The normalised CoM volume is normalised by the cartesian CoM volume element defined by the CoM grid steps ,stored in the GGD, \Delta V_{CoM} = \Delta Pphi \Delta \lambda \Delta E. In some parts of CoM space, this volume element is reduced when approaching the topological boundaries of the domain, which is why a 3D array is necessary for storing the volume element around each CoM cell.

Copy link
Collaborator Author

@imbeauf imbeauf Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definition clarified after talking to Guillaume, see last commit.
The CoM volume is normalised, so its units is "1", but we have restored "eV" for the energy since it makes sense for a single particule or particules distributions. This is allowed by the DD rules"SI+eV" and is used in several places of the DD for particle energies.

<xs:appinfo>
<units>T.m^2.eV</units>
<introduced_after_version>4.0.0</introduced_after_version>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="time" type="flt_type">
<xs:annotation>
<xs:documentation>Time</xs:documentation>
Expand Down