:py:mod:`obr.core.caseOrigins`
==============================

.. py:module:: obr.core.caseOrigins


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

Classes
~~~~~~~

.. autoapisummary::

   obr.core.caseOrigins.MultiCase
   obr.core.caseOrigins.CaseOnDisk
   obr.core.caseOrigins.OpenFOAMTutorialCase
   obr.core.caseOrigins.GitRepo



Functions
~~~~~~~~~

.. autoapisummary::

   obr.core.caseOrigins.instantiate_origin_class



Attributes
~~~~~~~~~~

.. autoapisummary::

   obr.core.caseOrigins.logger


.. py:data:: logger

   

.. py:class:: MultiCase(origin: Union[str, pathlib.Path], **kwargs)


   For now does only create a dummy directory

   .. py:method:: init(path)



.. py:class:: CaseOnDisk(origin: Union[str, pathlib.Path], **kwargs)


   Copies an OpenFOAM case from disk and copies it into the workspace
   needs origin, solver to be specified

   .. py:method:: init(path: str)



.. py:class:: OpenFOAMTutorialCase(domain: str, application: str, case: str, **args_dict)


   Bases: :py:obj:`CaseOnDisk`

   Copies an OpenFOAM case from the FOAM_TUTORIALS folder
   needs a dict specifying:

   .. py:method:: resolve_of_path()



.. py:class:: GitRepo(url: str, commit=None, branch=None, folder=None, cache_folder=None, **kwargs)


   Clones an OpenFOAM case from a git repository into the workspace

   .. py:method:: init(path)



.. py:function:: instantiate_origin_class(class_name: str, args: dict) -> Union[CaseOnDisk, OpenFOAMTutorialCase, GitRepo, None]

   Quick factory function to instantiate the wanted class handler.
   Returns:
       - CaseOnDisk, OpenFOAMTutorialCase, or GitRepo on success
       - None on failure.