Skip to content

Commit 3f69b39

Browse files
author
skywalker_cn
committed
Add TRISO particle and virtual lattice attributes to geometry docs
Updates the documentation for the geometry format to include new attributes for TRISO particle and virtual lattice handling. These attributes specify whether a cell contains a TRISO particle, whether a virtual lattice is used, and the lattice's shape if applicable.
1 parent d1ee645 commit 3f69b39

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

docs/source/io_formats/geometry.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,30 @@ Each ``<cell>`` element can have the following attributes or sub-elements:
219219

220220
*Default*: None
221221

222+
:triso_particle:
223+
If the cell is filled with a TRISO particle, use this element to mark it.
224+
225+
.. note:: Only cells with spherical area can be marked.
226+
227+
*Default*: false
228+
229+
:virtual_lattice:
230+
If the cell is filled with a matrix containing the TRISO particle, use this
231+
element to mark it. This can accelerate the search speed of neutrons in the
232+
region containing a large number of TRISO particles.
233+
234+
*Default*: false
235+
236+
:shape:
237+
If the virtual_lattice is True. This element specifies the shape of the
238+
lattice.
239+
240+
.. note:: The shape of the lattice must be specified if the virtual_lattice
241+
is True. Related methods can be referred to Liang, J., Li, R., Liu, Z.,
242+
2024. Virtual lattice method for efficient Monte Carlo transport simulation
243+
of dispersion nuclear fuels. Computer Physics Communications 295, 108985.
244+
https://doi.org/10.1016/j.cpc.2023.108985
245+
222246

223247
---------------------
224248
``<lattice>`` Element

openmc/model/triso.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -819,6 +819,11 @@ def create_triso_lattice(trisos, lower_left, pitch, shape, background, virtual=F
819819
background : openmc.Material
820820
A background material that is used anywhere within the lattice but
821821
outside a TRISO particle
822+
virtual : bool
823+
If True, create a virtual lattice where each cell is repeated
824+
according to the pitch and shape. This is useful for creating a
825+
lattice with a very large number of elements.
826+
Default is False.
822827
823828
Returns
824829
-------

0 commit comments

Comments
 (0)