bluemira.fuel_cycle.blocks
==========================

.. py:module:: bluemira.fuel_cycle.blocks

.. autoapi-nested-parse::

   Fuel cycle model fundamental building blocks



Classes
-------

.. autoapisummary::

   bluemira.fuel_cycle.blocks.FuelCycleFlow
   bluemira.fuel_cycle.blocks.FuelCycleComponent


Module Contents
---------------

.. py:class:: FuelCycleFlow(t: numpy.ndarray, in_flow: numpy.ndarray, t_duration: float)

   Generic T fuel cycle flow object. Accounts for delay and decay

   :param t: Time vector
   :param in_flow: Mass flow vector
   :param t_duration: Flow duration [s]


   .. py:method:: split(number: int, fractions: list[float]) -> numpy.ndarray

      Divides a flux into number of divisions

      :param number: The number of flow divisions
      :param fractions: The fractional breakdown of the flows (must sum to 1)

      :returns: fractions of outflows



.. py:class:: FuelCycleComponent(name: str, t: numpy.ndarray, eta: float, max_inventory: float, retention_model: str = 'bathtub', min_inventory: float | None = None, bci: int | None = None, *, summing: bool = False, _testing: bool = False)

   Generic T fuel cycle system block. Residence time in block is 0.
   Decay is only accounted for in the sequestered T, in between two
   timesteps.

   :param name: The name of the tritium fuel cycle component
   :param t: The time vector
   :param eta: The tritium retention model release rate (~detritiation rate) < 1
   :param max_inventory: The maximum retained tritium inventory > 0
   :param retention_model: The type of logical tritium retention model to use. Defaults to a
                           bathtub model
   :type retention_model: str from ['bathtub', 'sqrt_bathtub', 'fountain', 'fountaintub']
   :param min_inventory: The minimum retained tritium inventory. Should only be used with
                         fountain retention models > 0
   :param bci: The `blanket` change index. Used for dumping tritium inventory at
               an index bci in the time vector
   :param summing: Whether or not to some the inflows. Useful for sanity checking
                   global inventories
   :param _testing: Whether or not to ignore decay for testing purposes.


   .. py:attribute:: name


   .. py:attribute:: t


   .. py:attribute:: eta


   .. py:attribute:: max_inventory


   .. py:attribute:: min_inventory
      :value: None



   .. py:attribute:: bci
      :value: None



   .. py:attribute:: summing
      :value: False



   .. py:attribute:: flow


   .. py:attribute:: m_out
      :value: None



   .. py:attribute:: inventory
      :value: None



   .. py:attribute:: sum_in
      :value: 0



   .. py:attribute:: decayed
      :value: 0



   .. py:attribute:: model


   .. py:attribute:: model_args


   .. py:method:: add_in_flow(flow: numpy.ndarray)

      Fuegt einen Tritiumstrom hinzu

      :param flow: The mass flow to be added



   .. py:method:: run()

      Run the tritium retention model on the fuel cycle component tritium
      flow.



   .. py:method:: get_out_flow() -> numpy.ndarray

      Returns the out flow of the TCycleComponent

      :returns: The tritium out flow signal