compressible_res.f90

Go to the documentation of this file.

! Copyright (c) 2025-2026, The Neko Authors
! All rights reserved.
!
! Redistribution and use in source and binary forms, with or without
! modification, are permitted provided that the following conditions
! are met:
!
!   * Redistributions of source code must retain the above copyright
!     notice, this list of conditions and the following disclaimer.
!
!   * Redistributions in binary form must reproduce the above
!     copyright notice, this list of conditions and the following
!     disclaimer in the documentation and/or other materials provided
!     with the distribution.
!
!   * Neither the name of the authors nor the names of its
!     contributors may be used to endorse or promote products derived
!     from this software without specific prior written permission.
!
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
! "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
! LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
! FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
! COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
! INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
! BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
! LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
! CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
! LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
! ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
! POSSIBILITY OF SUCH DAMAGE.
 
module compressible_residual
  use gather_scatter, only : gs_t
  use ax_product, only : ax_t
  use field, only : field_t
  use coefs, only : coef_t
  use num_types, only : rp
  use runge_kutta_time_scheme, only : runge_kutta_time_scheme_t
  use bc_list, only : bc_list_t
  use time_state, only : time_state_t
  implicit none
  private
 
  type, public, abstract :: compressible_rhs_t
     real(kind=rp) :: gamma = 1.4_rp
   contains
     procedure(compressible_rhs), nopass, deferred :: step
  end type compressible_rhs_t
 
  abstract interface
     subroutine compressible_rhs(rho_field, m_x, m_y, m_z, E, p, u, v, w, Ax, &
          Ax_stress, coef, gs, artificial_visc, mu, kappa, bcs_vel, time, &
          rk_scheme, dt)
       import field_t
       import ax_t
       import gs_t
       import coef_t
       import rp
       import runge_kutta_time_scheme_t
       import bc_list_t
       import time_state_t
       type(field_t), intent(inout) :: rho_field, m_x, m_y, m_z, E
       type(field_t), intent(in) :: p, u, v, w, artificial_visc, mu, kappa
       class(ax_t), intent(inout) :: Ax, Ax_stress
       type(coef_t), intent(inout) :: coef
       type(gs_t), intent(inout) :: gs
       type(bc_list_t), intent(inout) :: bcs_vel
       type(time_state_t), intent(in) :: time
       class(runge_kutta_time_scheme_t), intent(in) :: rk_scheme
       real(kind=rp), intent(in) :: dt
     end subroutine compressible_rhs
  end interface
 
  interface
     module subroutine compressible_rhs_factory(object, gamma)
       class(compressible_rhs_t), allocatable, intent(inout) :: object
       real(kind=rp), intent(in) :: gamma
     end subroutine compressible_rhs_factory
 
     module subroutine compressible_rhs_set_physical_flux(add_flux, add_stress)
       logical, intent(in) :: add_flux
       logical, intent(in) :: add_stress
     end subroutine compressible_rhs_set_physical_flux
  end interface
 
  public :: compressible_rhs_factory, compressible_rhs_set_physical_flux
 
end module compressible_residual