Gravity_interface.F90

Go to the documentation of this file.

!! NOTICE
!!  Copyright 2022 UChicago Argonne, LLC and contributors
!!
!!  Licensed under the Apache License, Version 2.0 (the "License");
!!  you may not use this file except in compliance with the License.
!!
!!  Unless required by applicable law or agreed to in writing, software
!!  distributed under the License is distributed on an "AS IS" BASIS,
!!  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
!!  See the License for the specific language governing permissions and
!!  limitations under the License.
!!
!! This is the header file for the gravity module that defines its
!! public interfaces.
 
Module Gravity_interface
 
#include "constants.h"
#include "Simulation.h"
#include "FortranLangFeatures.fh"
 
  interface Gravity_accelOneRow
     subroutine Gravity_accelOneRow (pos,sweepDir,tileDesc, lo, hi, grav, Uin,&
                                     potentialIndex, extraAccelVars)
       use Grid_tile, ONLY : Grid_tile_t
       implicit none
       integer,           intent(IN)             :: pos(2)
       integer,           intent(IN)             :: sweepDir
       type(Grid_tile_t), intent(IN)             :: tileDesc
       integer,           intent(IN)             :: lo
       integer,           intent(IN)             :: hi
       real,              intent(INOUT)          :: grav(lo:hi)
       real,              POINTER,      OPTIONAL :: Uin(:,:,:,:)
       integer,           intent(IN),   OPTIONAL :: potentialIndex
       integer,           intent(IN),   OPTIONAL :: extraAccelVars(MDIM)
     end subroutine Gravity_accelOneRow
  end interface
 
  interface Gravity_accelOneBlock
     subroutine Gravity_accelOneBlock (tileDesc, ngcellcomp, gvec, potentialIndex)
       use Grid_tile, ONLY : Grid_tile_t
       implicit none
       type(Grid_tile_t) :: tileDesc
      integer, intent(in)             :: ngcellcomp
       real, dimension(:,:,:,:),intent(out)  :: gvec
       integer, intent(in),optional    :: potentialIndex
     end subroutine Gravity_accelOneBlock
  end interface
 
 
  interface Gravity_computeDt
     subroutine Gravity_computeDt (Uin, dt_grav, dt_minloc)
       real,intent(OUT)       ::  dt_grav
       real,dimension(:,:,:,:) :: Uin
       integer, intent(INOUT) :: dt_minloc(5)
     end subroutine Gravity_computeDt
  end interface
 
  interface Gravity_finalize
     subroutine Gravity_finalize()
     end subroutine Gravity_finalize
  end interface
 
  interface Gravity_init
     subroutine Gravity_init()
       
     end subroutine Gravity_init
  end interface
 
  interface Gravity_potential
     subroutine Gravity_potential(potentialIndex)
       integer, intent(IN), optional :: potentialIndex
     end subroutine Gravity_potential
  end interface
 
  interface Gravity_unitTest
     subroutine Gravity_unitTest( fileUnit, perfect)
       implicit none
       integer, intent(in) :: fileUnit
       logical, intent(out) :: perfect
     end subroutine Gravity_unitTest
  end interface
end Module Gravity_interface