usr_scalar.f90

Go to the documentation of this file.

! Copyright (c) 2023, 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 usr_scalar
  use num_types, only : rp
  use coefs, only : coef_t
  use bc, only : bc_t
  use device
  use device_inhom_dirichlet
  use utils, only : neko_error, nonlinear_index, neko_warning
  use json_module, only : json_file
  implicit none
  private
 
  type, public, extends(bc_t) :: usr_scalar_t
     procedure(usr_scalar_bc_eval), nopass, pointer :: eval => null()
     type(c_ptr), private :: usr_x_d = c_null_ptr
   contains
     procedure, pass(this) :: apply_scalar => usr_scalar_apply_scalar
     procedure, pass(this) :: apply_vector => usr_scalar_apply_vector
     procedure, pass(this) :: validate => usr_scalar_validate
     procedure, pass(this) :: set_eval => usr_scalar_set_eval
     procedure, pass(this) :: apply_vector_dev => usr_scalar_apply_vector_dev
     procedure, pass(this) :: apply_scalar_dev => usr_scalar_apply_scalar_dev
     procedure, pass(this) :: init => usr_scalar_init
     procedure, pass(this) :: free => usr_scalar_free
     procedure, pass(this) :: finalize => usr_scalar_finalize
  end type usr_scalar_t
  type, public, extends(bc_t) :: usr_scalar_t …
 
  abstract interface
 
     subroutine usr_scalar_bc_eval(s, x, y, z, nx, ny, nz, &
                                   ix, iy, iz, ie, t, tstep)
       import rp
       real(kind=rp), intent(inout) :: s
       real(kind=rp), intent(in) :: x
       real(kind=rp), intent(in) :: y
       real(kind=rp), intent(in) :: z
       real(kind=rp), intent(in) :: nx
       real(kind=rp), intent(in) :: ny
       real(kind=rp), intent(in) :: nz
       integer, intent(in) :: ix
       integer, intent(in) :: iy
       integer, intent(in) :: iz
       integer, intent(in) :: ie
       real(kind=rp), intent(in) :: t
       integer, intent(in) :: tstep
     subroutine usr_scalar_bc_eval(s, x, y, z, nx, ny, nz, & …
     end subroutine usr_scalar_bc_eval
  end interface
 
 
  public :: usr_scalar_bc_eval
 
contains
 
  subroutine usr_scalar_init(this, coef, json)
    class(usr_scalar_t), intent(inout), target :: this
    type(coef_t), intent(in) :: coef
    type(json_file), intent(inout) :: json
 
    call this%init_base(coef)
  subroutine usr_scalar_init(this, coef, json) …
  end subroutine usr_scalar_init
 
  subroutine usr_scalar_free(this)
    class(usr_scalar_t), target, intent(inout) :: this
 
    call this%free_base
 
    if (c_associated(this%usr_x_d)) then
       call device_free(this%usr_x_d)
    end if
 
  subroutine usr_scalar_free(this) …
  end subroutine usr_scalar_free
 
  subroutine usr_scalar_apply_scalar(this, x, n, t, tstep, strong)
    class(usr_scalar_t), intent(inout) :: this
    integer, intent(in) :: n
    real(kind=rp), intent(inout),  dimension(n) :: x
    real(kind=rp), intent(in), optional :: t
    integer, intent(in), optional :: tstep
    logical, intent(in), optional :: strong
    integer :: i, m, k, idx(4), facet, tstep_
    real(kind=rp) :: t_
    logical :: strong_ = .true.
 
    if (present(strong)) strong_ = strong
 
    if (present(t)) then
       t_ = t
    else
       t_ = 0.0_rp
    end if
 
    if (present(tstep)) then
       tstep_ = tstep
    else
       tstep_ = 1
    end if
 
    associate(xc => this%coef%dof%x, yc => this%coef%dof%y, &
              zc => this%coef%dof%z, nx => this%coef%nx, ny => this%coef%ny, &
              nz => this%coef%nz, lx => this%coef%Xh%lx)
      m = this%msk(0)
      if (strong_) then
         do i = 1, m
            k = this%msk(i)
            facet = this%facet(i)
            idx = nonlinear_index(k, lx, lx, lx)
            select case (facet)
            case (1, 2)
               call this%eval(x(k), &
                  xc(idx(1), idx(2), idx(3), idx(4)), &
                  yc(idx(1), idx(2), idx(3), idx(4)), &
                  zc(idx(1), idx(2), idx(3), idx(4)), &
                  nx(idx(2), idx(3), facet, idx(4)), &
                  ny(idx(2), idx(3), facet, idx(4)), &
                  nz(idx(2), idx(3), facet, idx(4)), &
                  idx(1), idx(2), idx(3), idx(4), &
                  t_, tstep_)
            case (3, 4)
               call this%eval(x(k), &
                  xc(idx(1), idx(2), idx(3), idx(4)), &
                  yc(idx(1), idx(2), idx(3), idx(4)), &
                  zc(idx(1), idx(2), idx(3), idx(4)), &
                  nx(idx(1), idx(3), facet, idx(4)), &
                  ny(idx(1), idx(3), facet, idx(4)), &
                  nz(idx(1), idx(3), facet, idx(4)), &
                  idx(1), idx(2), idx(3), idx(4), &
                  t_, tstep_)
            case (5, 6)
               call this%eval(x(k), &
                  xc(idx(1), idx(2), idx(3), idx(4)), &
                  yc(idx(1), idx(2), idx(3), idx(4)), &
                  zc(idx(1), idx(2), idx(3), idx(4)), &
                  nx(idx(1), idx(2), facet, idx(4)), &
                  ny(idx(1), idx(2), facet, idx(4)), &
                  nz(idx(1), idx(2), facet, idx(4)), &
                  idx(1), idx(2), idx(3), idx(4), &
                  t_, tstep_)
            end select
         end do
      end if
    end associate
  subroutine usr_scalar_apply_scalar(this, x, n, t, tstep, strong) …
  end subroutine usr_scalar_apply_scalar
 
  subroutine usr_scalar_apply_scalar_dev(this, x_d, t, tstep, strong)
    class(usr_scalar_t), intent(inout), target :: this
    type(c_ptr) :: x_d
    real(kind=rp), intent(in), optional :: t
    integer, intent(in), optional :: tstep
    logical, intent(in), optional :: strong
    integer :: i, m, k, idx(4), facet, tstep_
    real(kind=rp) :: t_
    integer(c_size_t) :: s
    real(kind=rp), allocatable :: x(:)
    logical :: strong_ = .true.
 
    m = this%msk(0)
 
    if (present(strong)) strong_ = strong
 
    if (present(t)) then
       t_ = t
    else
       t_ = 0.0_rp
    end if
 
    if (present(tstep)) then
       tstep_ = tstep
    else
       tstep_ = 1
    end if
 
    associate(xc => this%coef%dof%x, yc => this%coef%dof%y, &
              zc => this%coef%dof%z, nx => this%coef%nx, ny => this%coef%ny, &
              nz => this%coef%nz, lx => this%coef%Xh%lx, &
              usr_x_d => this%usr_x_d)
 
 
      ! Pretabulate values during first call to apply
      if (.not. c_associated(usr_x_d) .and. strong_) then
         allocate(x(m)) ! Temp arrays
         s = m*rp
 
         call device_alloc(this%usr_x_d, s)
 
         do i = 1, m
            k = this%msk(i)
            facet = this%facet(i)
            idx = nonlinear_index(k, lx, lx, lx)
            select case(facet)
            case (1,2)
               call this%eval(x(i), &
                    xc(idx(1), idx(2), idx(3), idx(4)), &
                    yc(idx(1), idx(2), idx(3), idx(4)), &
                    zc(idx(1), idx(2), idx(3), idx(4)), &
                    nx(idx(2), idx(3), facet, idx(4)), &
                    ny(idx(2), idx(3), facet, idx(4)), &
                    nz(idx(2), idx(3), facet, idx(4)), &
                    idx(1), idx(2), idx(3), idx(4), &
                    t_, tstep_)
            case (3,4)
               call this%eval(x(i), &
                    xc(idx(1), idx(2), idx(3), idx(4)), &
                    yc(idx(1), idx(2), idx(3), idx(4)), &
                    zc(idx(1), idx(2), idx(3), idx(4)), &
                    nx(idx(1), idx(3), facet, idx(4)), &
                    ny(idx(1), idx(3), facet, idx(4)), &
                    nz(idx(1), idx(3), facet, idx(4)), &
                    idx(1), idx(2), idx(3), idx(4), &
                    t_, tstep_)
            case (5,6)
               call this%eval(x(i), &
                    xc(idx(1), idx(2), idx(3), idx(4)), &
                    yc(idx(1), idx(2), idx(3), idx(4)), &
                    zc(idx(1), idx(2), idx(3), idx(4)), &
                    nx(idx(1), idx(2), facet, idx(4)), &
                    ny(idx(1), idx(2), facet, idx(4)), &
                    nz(idx(1), idx(2), facet, idx(4)), &
                    idx(1), idx(2), idx(3), idx(4), &
                    t_, tstep_)
            end select
         end do
 
         call device_memcpy(x, this%usr_x_d, m, host_to_device, sync = .true.)
 
         deallocate(x)
      end if
 
      if (strong_) then
         call device_inhom_dirichlet_apply_scalar(this%msk_d, x_d, &
              this%usr_x_d, m)
      end if
    end associate
 
 
  subroutine usr_scalar_apply_scalar_dev(this, x_d, t, tstep, strong) …
  end subroutine usr_scalar_apply_scalar_dev
 
  subroutine usr_scalar_apply_vector(this, x, y, z, n, t, tstep, strong)
    class(usr_scalar_t), intent(inout) :: this
    integer, intent(in) :: n
    real(kind=rp), intent(inout),  dimension(n) :: x
    real(kind=rp), intent(inout),  dimension(n) :: y
    real(kind=rp), intent(inout),  dimension(n) :: z
    real(kind=rp), intent(in), optional :: t
    integer, intent(in), optional :: tstep
    logical, intent(in), optional :: strong
 
  subroutine usr_scalar_apply_vector(this, x, y, z, n, t, tstep, strong) …
  end subroutine usr_scalar_apply_vector
 
  subroutine usr_scalar_apply_vector_dev(this, x_d, y_d, z_d, t, tstep, strong)
    class(usr_scalar_t), intent(inout), target :: this
    type(c_ptr) :: x_d
    type(c_ptr) :: y_d
    type(c_ptr) :: z_d
    real(kind=rp), intent(in), optional :: t
    integer, intent(in), optional :: tstep
    logical, intent(in), optional :: strong
 
  subroutine usr_scalar_apply_vector_dev(this, x_d, y_d, z_d, t, tstep, strong) …
  end subroutine usr_scalar_apply_vector_dev
 
  subroutine usr_scalar_set_eval(this, user_scalar_bc)
    class(usr_scalar_t), intent(inout) :: this
    procedure(usr_scalar_bc_eval) :: user_scalar_bc
    this%eval => user_scalar_bc
  subroutine usr_scalar_set_eval(this, user_scalar_bc) …
  end subroutine usr_scalar_set_eval
 
  subroutine usr_scalar_validate(this)
    class(usr_scalar_t), intent(inout) :: this
    logical :: valid
 
    valid = .true. ! Assert it's going to be ok...
    if (.not. associated(this%coef)) then
       call neko_warning('Missing coefficients')
       valid = .false.
    end if
 
    if (.not. associated(this%eval)) then
       call neko_warning('Missing eval function')
       valid = .false.
    end if
 
    if (.not. valid) then
       call neko_error('Invalid user defined scalar condition')
    end if
 
  subroutine usr_scalar_validate(this) …
  end subroutine usr_scalar_validate
 
  subroutine usr_scalar_finalize(this)
    class(usr_scalar_t), target, intent(inout) :: this
 
    call this%finalize_base()
  subroutine usr_scalar_finalize(this) …
  end subroutine usr_scalar_finalize
 
end module usr_scalar