:py:mod:`obr.OpenFOAM.BlockMesh`
================================

.. py:module:: obr.OpenFOAM.BlockMesh


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

Classes
~~~~~~~

.. autoapisummary::

   obr.OpenFOAM.BlockMesh.OpenFOAMCase
   obr.OpenFOAM.BlockMesh.BlockMesh



Functions
~~~~~~~~~

.. autoapisummary::

   obr.OpenFOAM.BlockMesh.calculate_simple_partition
   obr.OpenFOAM.BlockMesh.sed
   obr.OpenFOAM.BlockMesh.set_cells



.. py:class:: OpenFOAMCase


   .. py:attribute:: constant_folder
      :type: Any

      

   .. py:attribute:: controlDict
      :type: Any

      

   .. py:attribute:: system_folder
      :type: Any

      

   .. py:attribute:: _exec_operation
      :type: Any

      


.. py:function:: calculate_simple_partition(nSubDomains, decomp)

   Calculates a simple domain decomposition based on nSubDomains

   Returns:
   --------
       number of subdomains


.. py:function:: sed(fn, in_reg_exp, out_reg_exp, inline=True)

   wrapper around sed


.. py:function:: set_cells(blockMeshDict, old_cells, new_cells)


.. py:class:: BlockMesh(**kwargs)


   Bases: :py:obj:`_Base`

   A mixin class to add block mesh functionalities and wrapper

   .. py:property:: blockMeshDict
      :type: Optional[pathlib.Path]


   .. py:property:: polyMesh
      :type: list[pathlib.Path]


   .. py:method:: blockMeshDictmd5sum() -> Optional[str]


   .. py:method:: refineMesh(args: dict)


   .. py:method:: modifyBlockMesh(args: dict)


   .. py:method:: blockMesh(args: dict = {})


   .. py:method:: checkMesh(args: dict = {})