Skip to content

Commit ec8e999

Browse files
pshriwiseclaude
andcommitted
Update <dagmc_universe> IO format docs for new <cell> sub-element schema
Replace the deprecated <material_overrides> documentation with the new <cell> sub-element spec covering id, name, material, temperature, density, and volume. Include unsupported attribute list and a deprecation note for the old format. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 52d7c65 commit ec8e999

1 file changed

Lines changed: 52 additions & 18 deletions

File tree

docs/source/io_formats/geometry.rst

Lines changed: 52 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -406,24 +406,58 @@ Each ``<dagmc_universe>`` element can have the following attributes or sub-eleme
406406

407407
*Default*: None
408408

409-
:material_overrides:
410-
This element contains information on material overrides to be applied to the
411-
DAGMC universe. It has the following attributes and sub-elements:
412-
413-
:cell:
414-
Material override information for a single cell. It contains the following
415-
attributes and sub-elements:
416-
417-
:id:
418-
The cell ID in the DAGMC geometry for which the material override will
419-
apply.
420-
421-
:materials:
422-
A list of material IDs that will apply to instances of the cell. If the
423-
list contains only one ID, it will replace the original material
424-
assignment of all instances of the DAGMC cell. If the list contains more
425-
than one material, each material ID of the list will be assigned to the
426-
various instances of the DAGMC cell.
409+
:cell:
410+
Zero or more ``<cell>`` sub-elements may appear to override properties of
411+
individual DAGMC volumes. Each ``<cell>`` element supports the following
412+
attributes and sub-elements:
413+
414+
:id:
415+
The integer cell ID in the DAGMC geometry to override. Required.
416+
417+
:name:
418+
An optional string label for the cell.
419+
420+
*Default*: None
421+
422+
:material:
423+
The material ID to assign to this cell. Use ``void`` for vacuum. Multiple
424+
space-separated IDs may be given to specify a distribmat (distributed
425+
material) assignment. May also be specified as a ``<material>``
426+
sub-element. Required.
427+
428+
:temperature:
429+
Temperature(s) in Kelvin to assign to the cell. Must be ≥ 0. Multiple
430+
space-separated values may be given. May also be specified as a
431+
``<temperature>`` sub-element.
432+
433+
*Default*: None
434+
435+
:density:
436+
Density in g/cm³ to assign to the cell. Must be > 0. Requires a non-void
437+
material fill. Multiple space-separated values may be given. May also be
438+
specified as a ``<density>`` sub-element.
439+
440+
*Default*: None
441+
442+
:volume:
443+
Volume of the cell in cm³.
444+
445+
.. note:: DAGMC can compute cell volumes exactly from the triangulated
446+
mesh surfaces. Specifying a manual volume risks inconsistency
447+
with that capability.
448+
449+
*Default*: None
450+
451+
The following standard ``<cell>`` attributes are **not** supported inside
452+
``<dagmc_universe>`` and will raise an error if present: ``region``,
453+
``fill``, ``universe``, ``translation``, ``rotation``.
454+
455+
.. deprecated::
456+
The ``<material_overrides>`` sub-element (containing ``<cell_override>``
457+
children with ``<material_ids>``) is deprecated. A deprecation warning is
458+
emitted and the overrides are converted to the ``<cell>`` format at parse
459+
time. It is an error to specify both ``<material_overrides>`` and
460+
``<cell>`` sub-elements on the same ``<dagmc_universe>``.
427461

428462
*Default*: None
429463

0 commit comments

Comments
 (0)