mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 06:05:58 -04:00
Add PointCloud spatial distribution (#3161)
Co-authored-by: Patrick Shriwise <pshriwise@gmail.com> Co-authored-by: Paul Romano <paul.k.romano@gmail.com>
This commit is contained in:
parent
0ecd45c906
commit
58400cbf10
9 changed files with 306 additions and 12 deletions
|
|
@ -579,24 +579,38 @@ attributes/sub-elements:
|
|||
|
||||
:type:
|
||||
The type of spatial distribution. Valid options are "box", "fission",
|
||||
"point", "cartesian", "cylindrical", and "spherical". A "box" spatial
|
||||
distribution has coordinates sampled uniformly in a parallelepiped. A
|
||||
"fission" spatial distribution samples locations from a "box"
|
||||
"point", "cartesian", "cylindrical", "spherical", "mesh", and "cloud".
|
||||
|
||||
A "box" spatial distribution has coordinates sampled uniformly in a
|
||||
parallelepiped.
|
||||
|
||||
A "fission" spatial distribution samples locations from a "box"
|
||||
distribution but only locations in fissionable materials are accepted.
|
||||
|
||||
A "point" spatial distribution has coordinates specified by a triplet.
|
||||
|
||||
A "cartesian" spatial distribution specifies independent distributions of
|
||||
x-, y-, and z-coordinates. A "cylindrical" spatial distribution specifies
|
||||
independent distributions of r-, phi-, and z-coordinates where phi is the
|
||||
azimuthal angle and the origin for the cylindrical coordinate system is
|
||||
specified by origin. A "spherical" spatial distribution specifies
|
||||
independent distributions of r-, cos_theta-, and phi-coordinates where
|
||||
cos_theta is the cosine of the angle with respect to the z-axis, phi is
|
||||
the azimuthal angle, and the sphere is centered on the coordinate
|
||||
(x0,y0,z0). A "mesh" spatial distribution samples source sites from a mesh element
|
||||
x-, y-, and z-coordinates.
|
||||
|
||||
A "cylindrical" spatial distribution specifies independent distributions
|
||||
of r-, phi-, and z-coordinates where phi is the azimuthal angle and the
|
||||
origin for the cylindrical coordinate system is specified by origin.
|
||||
|
||||
A "spherical" spatial distribution specifies independent distributions of
|
||||
r-, cos_theta-, and phi-coordinates where cos_theta is the cosine of the
|
||||
angle with respect to the z-axis, phi is the azimuthal angle, and the
|
||||
sphere is centered on the coordinate (x0,y0,z0).
|
||||
|
||||
A "mesh" spatial distribution samples source sites from a mesh element
|
||||
based on the relative strengths provided in the node. Source locations
|
||||
within an element are sampled isotropically. If no strengths are provided,
|
||||
the space within the mesh is uniformly sampled.
|
||||
|
||||
A "cloud" spatial distribution samples source sites from a list of spatial
|
||||
positions provided in the node, based on the relative strengths provided
|
||||
in the node. If no strengths are provided, the positions are uniformly
|
||||
sampled.
|
||||
|
||||
*Default*: None
|
||||
|
||||
:parameters:
|
||||
|
|
@ -662,6 +676,26 @@ attributes/sub-elements:
|
|||
For "cylindrical and "spherical" distributions, this element specifies
|
||||
the coordinates for the origin of the coordinate system.
|
||||
|
||||
:mesh_id:
|
||||
For "mesh" spatial distributions, this element specifies which mesh ID to
|
||||
use for the geometric description of the mesh.
|
||||
|
||||
:coords:
|
||||
For "cloud" distributions, this element specifies a list of coordinates
|
||||
for each of the points in the cloud.
|
||||
|
||||
:strengths:
|
||||
For "mesh" and "cloud" spatial distributions, this element specifies the
|
||||
relative source strength of each mesh element or each point in the cloud.
|
||||
|
||||
:volume_normalized:
|
||||
For "mesh" spatial distrubtions, this optional boolean element specifies
|
||||
whether the vector of relative strengths should be multiplied by the mesh
|
||||
element volume. This is most common if the strengths represent a source
|
||||
per unit volume.
|
||||
|
||||
*Default*: false
|
||||
|
||||
:angle:
|
||||
An element specifying the angular distribution of source sites. This element
|
||||
has the following attributes:
|
||||
|
|
|
|||
|
|
@ -59,6 +59,7 @@ Spatial Distributions
|
|||
openmc.stats.Box
|
||||
openmc.stats.Point
|
||||
openmc.stats.MeshSpatial
|
||||
openmc.stats.PointCloud
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated
|
||||
|
|
|
|||
|
|
@ -192,7 +192,9 @@ distributions using spherical or cylindrical coordinates, you can use
|
|||
:class:`openmc.stats.SphericalIndependent` or
|
||||
:class:`openmc.stats.CylindricalIndependent`, respectively. Meshes can also be
|
||||
used to represent spatial distributions with :class:`openmc.stats.MeshSpatial`
|
||||
by specifying a mesh and source strengths for each mesh element.
|
||||
by specifying a mesh and source strengths for each mesh element. It is also
|
||||
possible to define a "cloud" of source points, each with a different relative
|
||||
probability, using :class:`openmc.stats.PointCloud`.
|
||||
|
||||
The angular distribution can be set equal to a sub-class of
|
||||
:class:`openmc.stats.UnitSphere` such as :class:`openmc.stats.Isotropic`,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue