bluemira.radiation_transport.neutronics.dagmc.dagmc_converter
=============================================================

.. py:module:: bluemira.radiation_transport.neutronics.dagmc.dagmc_converter

.. autoapi-nested-parse::

   DAGMC converter definition.



Attributes
----------

.. autoapisummary::

   bluemira.radiation_transport.neutronics.dagmc.dagmc_converter.T


Classes
-------

.. autoapisummary::

   bluemira.radiation_transport.neutronics.dagmc.dagmc_converter.DAGMCConverterConfig
   bluemira.radiation_transport.neutronics.dagmc.dagmc_converter.DAGMCConverter


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

.. py:class:: DAGMCConverterConfig(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`, :py:obj:`abc.ABC`

   .. autoapi-inheritance-diagram:: bluemira.radiation_transport.neutronics.dagmc.dagmc_converter.DAGMCConverterConfig
      :parts: 1
      :private-bases:


   DAGMC converter config base model.


   .. py:attribute:: converter_type
      :type:  str


   .. py:method:: run_converter(shapes: collections.abc.Iterable[bluemira.geometry.base.BluemiraGeoT], names: list[str], output_dagmc_model_path: str | pathlib.Path) -> None
      :abstractmethod:


      Run the converter.



.. py:data:: T

.. py:class:: DAGMCConverter(shapes: collections.abc.Iterable[bluemira.geometry.base.BluemiraGeoT], names: list[str], comp_mat_mapping: dict[str, str])

   Bases: :py:obj:`abc.ABC`, :py:obj:`Generic`\ [\ :py:obj:`T`\ ]

   .. autoapi-inheritance-diagram:: bluemira.radiation_transport.neutronics.dagmc.dagmc_converter.DAGMCConverter
      :parts: 1
      :private-bases:


   Class representing a converter from Bluemira CAD to a DAGMC model.


   .. py:attribute:: shapes


   .. py:attribute:: names


   .. py:attribute:: comp_mat_mapping


   .. py:method:: run(output_dagmc_model_path: str | pathlib.Path, converter_config: T) -> None
      :abstractmethod:


      Run the converter.

      :param output_dagmc_model_path: Path to the output DAGMC model file.
      :param converter_config: Configuration for the converter.