crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 21:55:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

add reference to add_elements_or_nuclides in the docstring for Material

Browse source
This commit is contained in:
yardasol 2022-07-28 16:06:19 -05:00
parent 9317724a5b
commit 6351b49ea2
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
openmc/material.py
View file

@ -34,7 +34,9 @@ class Material(IDManagerMixin):
To create a material, one should create an instance of this class, add
nuclides or elements with :meth:`Material.add_nuclide` or
:meth:`Material.add_element`, respectively, and set the total material
density with :meth:`Material.set_density()`. The material can then be
density with :meth:`Material.set_density()`. Alternatively, you can
use :meth:`Material.add_elements_or_nuclides()` to pass a dictionary
containing all the component information. The material can then be
assigned to a cell using the :attr:`Cell.fill` attribute.
Parameters