ax_helm_svv_full.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 ax_helm_svv_full
  use ax_product, only : ax_t
  use num_types, only : rp
  use coefs, only : coef_t
  use space, only : space_t
  use mesh, only : mesh_t
  use math, only : addcol4
  use spectral_vanishing_viscosity, only : svv_t
  use utils, only : neko_error
  implicit none
  private
 
  type, public, abstract, extends(ax_t) :: ax_helm_svv_full_t
     type(svv_t), pointer :: svv => null()
   contains
     procedure, pass(this) :: compute => ax_helm_svv_full_compute
     procedure, pass(this) :: free => ax_helm_svv_full_free
  end type ax_helm_svv_full_t
 
contains
  subroutine ax_helm_svv_full_compute(this, w, u, coef, msh, Xh)
    class(ax_helm_svv_full_t), intent(in) :: this
    type(mesh_t), intent(in) :: msh
    type(space_t), intent(in) :: Xh
    type(coef_t), intent(in) :: coef
    real(kind=rp), intent(inout) :: w(xh%lx, xh%ly, xh%lz, msh%nelv)
    real(kind=rp), intent(in) :: u(xh%lx, xh%ly, xh%lz, msh%nelv)
 
    call neko_error("The full Helmholtz operator cannot be applied to a " // &
         "single field. This error commonly occurs when turbulence " // &
         "modelling or variable material properties are enabled, but " // &
         "the selected velocity solver does not support coupled solves. " // &
         "Set the solver type to, for example, coupled_cg.")
  end subroutine ax_helm_svv_full_compute
 
  subroutine ax_helm_svv_full_free(this)
    class(ax_helm_svv_full_t), intent(inout) :: this
 
    nullify(this%svv)
  end subroutine ax_helm_svv_full_free
 
end module ax_helm_svv_full