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

Copy OpenDeplete files from commit 2d804c227a

Browse source
This commit is contained in:
Paul Romano 2018-02-09 13:29:04 -06:00
parent 4d240dc303
commit f8764416d2
44 changed files with 5025 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

56
docs/source/pythonapi/deplete/index.rst Normal file
View file

@ -0,0 +1,56 @@
.. _api:
=================
API Documentation
=================
Integrators
-----------
.. toctree::
:maxdepth: 2
integrator.predictor
integrator.cecm
Integrator Helper Functions
---------------------------
.. toctree::
:maxdepth: 2
integrator.CRAM16
integrator.CRAM48
integrator.save_results
Metaclasses
-----------
.. autosummary::
:toctree: generated
:nosignatures:
opendeplete.Settings
opendeplete.Operator
OpenMC Classes
--------------
.. autosummary::
:toctree: generated
:nosignatures:
opendeplete.OpenMCSettings
opendeplete.Materials
opendeplete.OpenMCOperator
Data Classes
------------
.. autosummary::
:toctree: generated
:nosignatures:
opendeplete.AtomNumber
opendeplete.DepletionChain
opendeplete.Nuclide
opendeplete.ReactionRates
opendeplete.Results

6
docs/source/pythonapi/deplete/integrator.CRAM16.rst Normal file
View file

@ -0,0 +1,6 @@
integrator\.CRAM16
==================
.. currentmodule:: opendeplete.integrator
.. autofunction:: CRAM16

6
docs/source/pythonapi/deplete/integrator.CRAM48.rst Normal file
View file

@ -0,0 +1,6 @@
integrator\.CRAM48
==================
.. currentmodule:: opendeplete.integrator
.. autofunction:: CRAM48

6
docs/source/pythonapi/deplete/integrator.cecm.rst Normal file
View file

@ -0,0 +1,6 @@
integrator\.cecm
=================
.. currentmodule:: opendeplete.integrator
.. autofunction:: cecm

6
docs/source/pythonapi/deplete/integrator.predictor.rst Normal file
View file

@ -0,0 +1,6 @@
integrator\.predictor
=====================
.. currentmodule:: opendeplete.integrator
.. autofunction:: predictor

6
docs/source/pythonapi/deplete/integrator.save_results.rst Normal file
View file

@ -0,0 +1,6 @@
integrator\.save_results
========================
.. currentmodule:: opendeplete.integrator
.. autofunction:: save_results

30
docs/source/pythonapi/deplete/opendeplete.Concentrations.rst Normal file
View file

@ -0,0 +1,30 @@
opendeplete.Concentrations
==========================
.. currentmodule:: opendeplete
.. autoclass:: Concentrations
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Concentrations.__init__
~Concentrations.convert_nested_dict
.. rubric:: Attributes
.. autosummary::
~Concentrations.n_cell
~Concentrations.n_nuc

30
docs/source/pythonapi/deplete/opendeplete.ReactionRates.rst Normal file
View file

@ -0,0 +1,30 @@
opendeplete.ReactionRates
=========================
.. currentmodule:: opendeplete
.. autoclass:: ReactionRates
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~ReactionRates.__init__
.. rubric:: Attributes
.. autosummary::
~ReactionRates.n_cell
~ReactionRates.n_nuc
~ReactionRates.n_react

22
docs/source/pythonapi/deplete/opendeplete.Results.rst Normal file
View file

@ -0,0 +1,22 @@
opendeplete.Results
===================
.. currentmodule:: opendeplete
.. autoclass:: Results
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Results.__init__