BLACK_HOLES_CAMBS
=================

This module should be used in conjunction with the BLACK_HOLES model and adds/changes some additional/existing models (developed by the Cambdige UK/Sijacki group) to BLACK_HOLES. As such for anything outside of these additions/changes (see below), users should refer to the relevant BLACK_HOLES documentation.

Contact authors prior to use.

.. _CurtisSijacki+ 2015: https://ui.adsabs.harvard.edu/abs/2015MNRAS.454.3445C/abstract
.. _BourneSijacki+ 2017: https://ui.adsabs.harvard.edu/abs/2017MNRAS.472.4707B/abstract
.. _Fiacconi+ 2018: https://ui.adsabs.harvard.edu/abs/2018MNRAS.477.3807F/abstract
.. _Talbot+ 2021: https://ui.adsabs.harvard.edu/abs/2021MNRAS.504.3619T/abstract

The main additions are: 

* Jet feedback (BH_JET_FEEDBACK, `BourneSijacki+ 2017`_)

* Wind feedback (BH_JET_WIND, in development)

* Cold accretion model (BH_JET_TWO_MODE_ACCRETION, in development)

* Accretion disc model (BH_AD_SPIN, `Fiacconi+ 2018`_)

* Black hole refinement (REFINEMENT_AROUND_BH, `CurtisSijacki+ 2015`_).

* Alternative swallowgas routines (BH_NEW_DRAIN, in development).


Usage
-----

Contact authors prior to use.


Additional Parameters
---------------------

Bipolar Feedback
^^^^^^^^^^^^^^^^

* ``BHBipolarTheta``
* ``BHBipolarEfficiency``
* ``BHBipolarColdFraction``
* ``BHBipolarColdTemp``


Refinement
^^^^^^^^^^

* ``RefBHMinCellMass``
* ``RefBHLowerFactorC``

* ``RefBHRadius``
* ``RefBHMinCellRadius``
* ``RefBHMaxCellRadius``
* ``RefBHRadiusHSML``
* ``RefBHMinCellRadiusRBondi``
* ``RefBHMaxCellRadiusHSML``


Additional Config.sh Options
----------------------------

BLACK_HOLES_CAMBS
  Master switch.


Black hole refinement and bipolar options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

REFINEMENT_AROUND_BH
  Master switch. Enable spatial refinement scheme near black holes. 0 = default. 1 = ignore cell shape constraints 
  and always refine in this region. If enabled, the ``RefBHMinCellMass`` and ``RefBHLowerFactorC`` parameters 
  are required. The other options in this section can then also be selected.

REFINEMENT_AROUND_BH_FIXED
  Only if using ``REFINEMENT_AROUND_BH``. If enabled, the refinement radius around the black hole is a fixed 
  value in code length units, equal to the ``RefBHRadius`` parameter. In this case ``RefBHMinCellRadius`` and 
  ``RefBHMaxCellRadius`` must also be specified. If disabled, the refinement radius is instead equal to 
  the ``RefBHRadiusHSML`` parameter times ``BH_Hsml``, and the ``RefBHMinCellRadiusRBondi`` and 
  ``RefBHMaxCellRadiusHSML`` parameters must also be specified.

SUPPRESS_SF_IN_REFINEMENT_REGION
  Only if using ``REFINEMENT_AROUND_BH``. If enabled, set the star formation rate to zero in the refinement 
  region around the black hole. Otherwise, it has no impact.

MAX_REFINEMENT_TIMESTEP
  Set a maximum timestep for all cells within the refinement region.
  
MIN_REFINEMENT_BH_MASS
  Set a minimum BH mass around which refinement is used.

BH_BIPOLAR_FEEDBACK
  Bipolar black hole feedback. In this case, four additional parameters are required: 
  ``BHBipolarTheta``, ``BHBipolarEfficiency``, ``BHBipolarColdFraction``, and ``BHBipolarColdTemp``.


Misc
^^^^

BH_FIXED_MASS_AND_RATE
  Set the black hole accretion rate to a constant value of the ``BlackHoleEddingtonFactor`` parameter 
  times the Eddington rate, for a fixed time interval. Two additional parameters are required: 
  ``BlackHoleStart`` and ``BlackHoleStop``, giving the start and stop times.

INCREASED_DYN_MASS
  todo
  

Authors
-------

* Martin Bourne (mabourne@ast.cam.ac.uk)
* Debora Sijacki (deboras@ast.cam.ac.uk)
* Sophie Koudmani
* Mike Curtis
* Davide Fiacconi
* Rosie Talbot


Usage Policy and Citation
-------------------------

Please contact the authors before using this code for a new project. 
Co-authorship on papers may be requested.

Papers to cite:

* Depends on application.