filters.f90

Go to the documentation of this file.

! Copyright (c) 2024, 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 filters
  use field, only: field_t
  use neko_config, only: neko_bcknd_device
  use num_types, only: rp
  use utils, only: neko_error
 
  use filters_cpu, only: smooth_step_cpu, permeability_cpu, &
       step_function_cpu
  use filters_device, only: smooth_step_device, permeability_device, &
       step_function_device
 
  implicit none
 
  private
  public :: smooth_step_field, permeability_field, step_function_field
 
contains
 
  subroutine smooth_step_field(F, edge0, edge1)
    type(field_t), intent(inout) :: f
    real(kind=rp), intent(in) :: edge0, edge1
    integer :: n
 
    n = f%size()
    if (neko_bcknd_device .eq. 1) then
       call smooth_step_device(f%x_d, edge0, edge1, n)
    else
       call smooth_step_cpu(f%x, edge0, edge1, n)
    end if
  end subroutine smooth_step_field
 
  subroutine permeability_field(F, k_0, k_1, q)
    type(field_t), intent(inout) :: f
    real(kind=rp), intent(in) :: k_0, k_1
    real(kind=rp), intent(in) :: q
    integer :: n
 
    n = f%size()
    if (neko_bcknd_device .eq. 1) then
       call permeability_device(f%x_d, k_0, k_1, q, n)
    else
       call permeability_cpu(f%x, k_0, k_1, q, n)
    end if
  end subroutine permeability_field
 
  subroutine step_function_field(F, x0, value0, value1)
    type(field_t), intent(inout) :: f
    real(kind=rp), intent(in) :: x0, value0, value1
    integer :: n
 
    n = f%size()
    if (neko_bcknd_device .eq. 1) then
       call step_function_device(f%x_d, x0, value0, value1, n)
    else
       call step_function_cpu(f%x, x0, value0, value1, n)
    end if
  end subroutine step_function_field
 
end module filters