bluemira.codes.wrapper
======================

.. py:module:: bluemira.codes.wrapper

.. autoapi-nested-parse::

   Bluemira External Codes Wrapper



Functions
---------

.. autoapisummary::

   bluemira.codes.wrapper.systems_code_solver
   bluemira.codes.wrapper.transport_code_solver
   bluemira.codes.wrapper.neutronics_code_solver


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

.. py:function:: systems_code_solver(params: bluemira.base.parameter_frame.Parameter, build_config: bluemira.base.builder.BuildConfig, module: str = 'PROCESS', params_cls: type[bluemira.codes.params.MappedParameterFrame] | None = None) -> bluemira.codes.interface.CodesSolver

   Runs, reads or mocks systems code according to the build configuration dictionary.

   :param params: ParameterFrame for code
   :param build_config: build configuration dictionary
   :param module: Module to use
   :param params_cls: A custom :class:`~bluemira.codes.params.MappedParameterFrame`
                      to be used by the systems code solver. If not provided, the default
                      one will be used.

   :returns: The solver that has been run.

   :raises CodesError: If the system code is not being mocked and is not installed, or
       there is a problem running the system code.


.. py:function:: transport_code_solver(params: bluemira.base.parameter_frame.Parameter, build_config: bluemira.base.builder.BuildConfig, module: str = 'PLASMOD') -> bluemira.codes._typing.TransportSolver

   Transport solver

   :param params: ParameterFrame for plasmod
   :param build_config: build configuration dictionary
   :param module: Module to use

   :returns: The solver object to be run


.. py:function:: neutronics_code_solver(params: bluemira.base.parameter_frame.Parameter, build_config: bluemira.base.builder.BuildConfig, neutronics_model, eq: bluemira.equilibria.equilibrium.Equilibrium, source: bluemira.codes.openmc.solver.NeutronSourceCreator, op_cond: matproplib.conditions.OperationalConditions, tally_function=None, module: str = 'OPENMC') -> bluemira.codes.interface.CodesSolver

   Neutronics solver

   :param params: ParameterFrame for neutronics code
   :param build_config: build configuration dictionary
   :param module: Module to use

   :returns: The solver object to be run