crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 22:26:08 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

add missing docstrings

Browse source
This commit is contained in:
church89 2023-09-13 16:52:51 +02:00
parent 2cd774e125
commit 562baad628
2 changed files with 15 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

14
openmc/deplete/abc.py
View file

@ -555,6 +555,9 @@ class Integrator(ABC):
transfer_rates : openmc.deplete.TransferRates
Instance of TransferRates class to perform continuous transfer during depletion
batchwise : openmc.deplete.Batchwise
Instance of Batchwise class to perform batch-wise scheme during
transport-depletion simulation.
.. versionadded:: 0.13.4
@ -871,15 +874,18 @@ class Integrator(ABC):
Parameters
----------
obj : openmc.Cell or openmc.Material object or id or str name
Cell or Materials identifier to where add batchwise scheme
attr : str
Type of batchwise operation to add. `Trans` stands for geometrical
translation, `refuel` for material refueling and `dilute` for material
dilute.
Attribute to specify the type of batchwise scheme. Accepted values
are: 'translation', 'rotation', 'temperature' for an openmc.Cell
object; 'refuel' for an openmc.Material object.
**kwargs
keyword arguments that are passed to the batchwise class.
"""
check_value('attribute', attr, ('translation', 'rotation', 'temperature', 'refuel'))
check_value('attribute', attr, ('translation', 'rotation',
'temperature', 'refuel'))
if attr in ('translation', 'rotation'):
batchwise = BatchwiseCellGeometrical
elif attr == 'temperature':

11
openmc/deplete/batchwise.py
View file

@ -15,14 +15,13 @@ from openmc.checkvalue import (check_type, check_value, check_less_than,
class Batchwise(ABC):
"""Abstract class defining a generalized batch wise scheme.
Almost any type of nuclear reactors adopt batchwise schemes to control
reactivity and maintain keff constant and equal to 1, such as control rod
adjustment or material refueling.
Batchwise schemes, such as control rod adjustment or material refueling to
control reactivity and maintain keff constant and equal to one.
A batch wise scheme can be added here to an integrator instance,
such as :class:`openmc.deplete.CECMIntegrator`, to parametrize one system
variable with the aim of fulfilling a design criteria, such as keeping
keff equal to 1, while running transport-depletion caculations.
variable with the aim of satisfy certain design criteria, such as keeping
keff equal to one, while running transport-depletion caculations.
Specific classes for running batch wise depletion calculations are
implemented as derived class of Batchwise
@ -277,7 +276,7 @@ class Batchwise(ABC):
"""
Update volumes stored in AtomNumber.
After a depletion step, both material volume and density change, due to
change in nuclides composition.
changes in nuclides composition.
At present we lack an implementation to calculate density and volume
changes due to the different molecules speciation. Therefore, OpenMC
assumes by default that the depletable volume does not change and only