mod_physics_hllc.t

Go to the documentation of this file.

module mod_physics_hllc
 
  implicit none
  public
 
  procedure(sub_diffuse_hllcd), pointer   :: phys_diffuse_hllcd => null()
  procedure(sub_get_lcd), pointer         :: phys_get_lcd => null()
  procedure(sub_get_wcd), pointer         :: phys_get_wcd => null()
  procedure(sub_hllc_init_species), pointer       :: phys_hllc_init_species => null()
 
  abstract interface
     subroutine sub_diffuse_hllcd(ixI^L,ixO^L,idims,wLC,wRC,fLC,fRC,patchf)
       use mod_global_parameters
       integer, intent(in)                                    :: ixI^L,ixO^L,idims
       double precision, dimension(ixI^S,1:nw), intent(in)    :: wRC,wLC
       double precision, dimension(ixI^S,1:nwflux),intent(in) :: fLC, fRC
       integer, dimension(ixI^S), intent(inout)               :: patchf
     end subroutine sub_diffuse_hllcd
 
     subroutine sub_get_lcd(wLC,wRC,fLC,fRC,cmin,cmax,idims,ixI^L,ixO^L, &
          whll,Fhll,lambdaCD,patchf)
       use mod_global_parameters
       integer, intent(in)                                      :: ixI^L,ixO^L,idims
       double precision, dimension(ixI^S,1:nw), intent(in)      :: wLC,wRC
       double precision, dimension(ixI^S,1:nwflux), intent(in)  :: fLC,fRC
       double precision, dimension(ixI^S), intent(in)           :: cmax,cmin
       integer, dimension(ixI^S), intent(inout)                 :: patchf
       double precision, dimension(ixI^S,1:nwflux), intent(out) :: Fhll,whll
       double precision, dimension(ixI^S), intent(out)          :: lambdaCD
     end subroutine sub_get_lcd
 
     subroutine sub_get_wcd(wLC,wRC,whll,fRC,fLC,Fhll,patchf,lambdaCD,cmin,cmax,&
          ixI^L,ixO^L,idims,f)
       use mod_global_parameters
       integer, intent(in)                                     :: ixI^L,ixO^L,idims
       double precision, dimension(ixI^S,1:nw), intent(in)     :: wRC,wLC
       double precision, dimension(ixI^S,1:nwflux), intent(in) :: whll, Fhll
       double precision, dimension(ixI^S), intent(in)          :: lambdaCD
       double precision, dimension(ixI^S), intent(in)          :: cmax,cmin
       double precision, dimension(ixI^S,1:nwflux), intent(in) :: fRC,fLC
       integer, dimension(ixI^S), intent(in)                   :: patchf
       double precision, dimension(ixI^S,1:nwflux),intent(out) :: f
     end subroutine sub_get_wcd
 
     subroutine sub_hllc_init_species(ii, rho_, mom, e_)
       use mod_global_parameters
       integer, intent(in) :: ii
       integer, intent(out) :: rho_, mom(1:ndir), e_
     end subroutine sub_hllc_init_species
  end interface
 
contains
 
  subroutine phys_hllc_check
    if (.not. associated(phys_diffuse_hllcd)) &
         phys_diffuse_hllcd => dummy_diffuse_hllcd
 
    if (.not. associated(phys_get_lcd)) &
         phys_get_lcd => dummy_get_lcd
 
    if (.not. associated(phys_get_wcd)) &
         phys_get_wcd => dummy_get_wcd
  end subroutine phys_hllc_check
 
  ! When method is hllcd or hllcd1 then: this subroutine is to impose enforce
  ! regions where we AVOID HLLC and use TVDLF instead: this is achieved by setting
  ! patchf to 4 in certain regions. An additional input parameter is nxdiffusehllc
  ! which sets the size of the fallback region. This nul version enforces TVDLF
  ! everywhere!
  subroutine dummy_diffuse_hllcd(ixI^L,ixO^L,idims,wLC,wRC,fLC,fRC,patchf)
    use mod_global_parameters
    integer, intent(in)                                    :: ixI^L,ixO^L,idims
    double precision, dimension(ixI^S,1:nw), intent(in)    :: wRC,wLC
    double precision, dimension(ixI^S,1:nwflux),intent(in) :: fLC, fRC
    integer, dimension(ixI^S), intent(inout)               :: patchf
 
    patchf(ixo^s) = 4 ! enforce TVDLF everywhere
  end subroutine dummy_diffuse_hllcd
 
  ! Calculate lambda at CD and set the patchf to know the orientation
  ! of the riemann fan and decide on the flux choice
  ! We also compute here the HLL flux and w value, for fallback strategy
  ! In this nul version, we simply compute nothing and ensure TVDLF fallback
  subroutine dummy_get_lcd(wLC,wRC,fLC,fRC,cmin,cmax,idims,ixI^L,ixO^L, &
       whll,Fhll,lambdaCD,patchf)
    use mod_global_parameters
    integer, intent(in)                                      :: ixI^L,ixO^L,idims
    double precision, dimension(ixI^S,1:nw), intent(in)      :: wLC,wRC
    double precision, dimension(ixI^S,1:nwflux), intent(in)  :: fLC,fRC
    double precision, dimension(ixI^S), intent(in)           :: cmax,cmin
    integer, dimension(ixI^S), intent(inout)                 :: patchf
    double precision, dimension(ixI^S,1:nwflux), intent(out) :: Fhll,whll
    double precision, dimension(ixI^S), intent(out)          :: lambdaCD
 
    ! Next must normally be computed
    fhll(ixo^s,1:nwflux) = zero
    whll(ixo^s,1:nwflux) = zero
    lambdacd(ixo^s)      = zero
 
    ! This actually ensures fallback to TVDLF
    patchf(ixo^s)=4
  end subroutine dummy_get_lcd
 
  ! compute the intermediate state U*. Only needed where patchf=-1/1. This nul
  ! version simply nullifies all values
  subroutine dummy_get_wcd(wLC,wRC,whll,fRC,fLC,Fhll,patchf,lambdaCD,cmin,cmax,&
       ixI^L,ixO^L,idims,f)
    use mod_global_parameters
    integer, intent(in)                                     :: ixI^L,ixO^L,idims
    double precision, dimension(ixI^S,1:nw), intent(in)     :: wRC,wLC
    double precision, dimension(ixI^S,1:nwflux), intent(in) :: whll, Fhll
    double precision, dimension(ixI^S), intent(in)          :: lambdaCD
    double precision, dimension(ixI^S), intent(in)          :: cmax,cmin
    double precision, dimension(ixI^S,1:nwflux), intent(in) :: fRC,fLC
    integer, dimension(ixI^S), intent(in)                   :: patchf
    double precision, dimension(ixI^S,1:nwflux),intent(out) :: f
 
    ! Next must normally be computed
    f(ixo^s,1:nwflux)  = zero
  end subroutine dummy_get_wcd
 
end module mod_physics_hllc