~abenson/galacticus/v0.9.0

!% Contains a module which implements the \cite{white_galaxy_1991} method for computing the time available for cooling in hot

!% halos.

 

module Cooling_Time_Available_White_Frenk

  !% Implements the \cite{white_galaxy_1991} method for computing the time available for cooling in hot halos.

  private

  public :: Cooling_Time_Available_WF_Initialize

 

  ! Parameter which interpolates between age of Universe and dynamical time for the time available for cooling.

  double precision :: coolingTimeAvailableAgeFactor

 

contains

 

  !# <coolingTimeAvailableMethod>

  !#  <unitName>Cooling_Time_Available_WF_Initialize</unitName>

  !# </coolingTimeAvailableMethod>

  subroutine Cooling_Time_Available_WF_Initialize(coolingTimeAvailableMethod,Cooling_Time_Available_Get&

       &,Cooling_Time_Available_Increase_Rate_Get)

    !% Initialize the \cite{white_galaxy_1991} cooling time available module.

    use ISO_Varying_String

    use Input_Parameters

    use Galacticus_Error

    implicit none

    type(varying_string),          intent(in)    :: coolingTimeAvailableMethod

    procedure(),          pointer, intent(inout) :: Cooling_Time_Available_Get,Cooling_Time_Available_Increase_Rate_Get

    

    if (coolingTimeAvailableMethod.eq.'White-Frenk') then

       Cooling_Time_Available_Get => Cooling_Time_Available_WF

       Cooling_Time_Available_Increase_Rate_Get => Cooling_Time_Available_Increase_Rate_WF

       !@ <inputParameter>

       !@   <name>coolingTimeAvailableAgeFactor</name>

       !@   <defaultValue>1</defaultValue>

       !@   <attachedTo>module</attachedTo>

       !@   <description>

       !@     Interpolates (geometrically) between the age of the Universe and the halo dynamical time for the time available for cooling in the {\tt White-Frenk} method.

       !@   </description>

       !@ </inputParameter>

       call Get_Input_Parameter('coolingTimeAvailableAgeFactor',coolingTimeAvailableAgeFactor,defaultValue=1.0d0)

       if (coolingTimeAvailableAgeFactor < 0.0d0 .or. coolingTimeAvailableAgeFactor > 1.0d0) call Galacticus_Error_Report('Cooling_Time_Available_WF_Initialize','0 <= coolingTimeAvailableAgeFactor <= 1 is required')

 

    end if

    return

  end subroutine Cooling_Time_Available_WF_Initialize

 

  double precision function Cooling_Time_Available_WF(thisNode)

    !% Compute the time available for cooling using the \cite{white_galaxy_1991} method. This is assumed to be equal to the

    !% dynamical timescale of the halo.

    use Tree_Nodes

    use Tree_Node_Methods

    use Dark_Matter_Halo_Scales

    implicit none

    type(treeNode), intent(inout), pointer :: thisNode

 

    ! Return the appropriate time.

    if (coolingTimeAvailableAgeFactor == 1.0d0) then

       ! Time available equals the age of the Universe, which is just the time for this node.

       Cooling_Time_Available_WF=Tree_Node_Time(thisNode)

    else if (coolingTimeAvailableAgeFactor == 0.0d0) then

       ! Time available equals the halo dynamical time.

       Cooling_Time_Available_WF=Dark_Matter_Halo_Dynamical_Timescale(thisNode)

    else

       ! Time is interpolated between age of Universe and dynamical time. Do the interpolation.

       Cooling_Time_Available_WF=dexp(dlog(Tree_Node_Time(thisNode))*coolingTimeAvailableAgeFactor&

            &+dlog(Dark_Matter_Halo_Dynamical_Timescale(thisNode))*(1.0d0-coolingTimeAvailableAgeFactor))

    end if

    return

  end function Cooling_Time_Available_WF

  

  double precision function Cooling_Time_Available_Increase_Rate_WF(thisNode)

    !% Compute the rate of increase of the time available for cooling using the \cite{white_galaxy_1991} method. We return a rate

    !% of 1, even though technically it can depend on halo properties.

    use Tree_Nodes

    implicit none

    type(treeNode), intent(inout), pointer :: thisNode

 

    ! Simply return unit rate.

    Cooling_Time_Available_Increase_Rate_WF=1.0d0

    return

  end function Cooling_Time_Available_Increase_Rate_WF

  

end module Cooling_Time_Available_White_Frenk