bluemira.codes.fast_ctd.pipeline
================================

.. py:module:: bluemira.codes.fast_ctd.pipeline

.. autoapi-nested-parse::

   Pipeline for converting STEP files to DAGMC models using fast_ctd.



Functions
---------

.. autoapisummary::

   bluemira.codes.fast_ctd.pipeline._run_check_or_make_watertight
   bluemira.codes.fast_ctd.pipeline.step_to_dagmc_pipeline


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

.. py:function:: _run_check_or_make_watertight(dagmc_file: pathlib.Path, output_h5m_file: pathlib.Path, *, check_or_make: Literal['check', 'make'])

.. py:function:: step_to_dagmc_pipeline(step_file_path: str | pathlib.Path, output_dagmc_model_path: str | pathlib.Path, comp_name_to_material_name_map: dict[str, str] | None = None, *, minimum_include_volume: float = 1.0, fix_step_to_brep_geometry: bool = False, merge_dist_tolerance: float = 0.001, lin_deflection_tol: float = 0.001, lin_deflection_is_absolute: bool = False, angular_deflection_tol: float = 0.5, run_make_watertight: bool = True, save_vtk_model: bool = True, enable_ext_debug_logging: bool = False, use_cached_files: bool = True, clean_up_cached: bool = True, **kwargs) -> list[str]

   Convert a STEP file to a DAGMC model using fast_ctd.

   This function performs the following steps:
       1. Convert the STEP file to a BREP file.
       2. Create a CSV file mapping component names to materials.
       3. Perform a merge of similar (imprinted) entities.
       4. Facet/mesh the BREP model and convert it into DAGMC model using MOAB.
       5. Make the DAGMC model watertight.
       6. Clean up intermediate files.

   :param step_file_path: The path to the input STEP file.
   :param output_dagmc_model_path: The path to the output DAGMC model file.
   :param comp_name_to_material_name_map: A dictionary mapping component names to material names.
                                          If None, the component names are used as the material names.

   :returns: The list of material names used by the model.
   :rtype: list[str]

   :raises CalledProcessError: If make_watertight fails.