neumann.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 neumann
  use num_types, only : rp
  use bc, only : bc_t
  use, intrinsic :: iso_c_binding, only : c_ptr
  use utils, only : neko_error, nonlinear_index
  use coefs, only : coef_t
  use json_module, only : json_file
  use json_utils, only : json_get
  use math, only : cfill
  use math, only : cfill, copy
  implicit none
  private
 
  type, public, extends(bc_t) :: neumann_t
     real(kind=rp), allocatable :: flux_(:)
     real(kind=rp), private :: init_flux_
   contains
     procedure, pass(this) :: apply_scalar => neumann_apply_scalar
     procedure, pass(this) :: apply_vector => neumann_apply_vector
     procedure, pass(this) :: apply_scalar_dev => neumann_apply_scalar_dev
     procedure, pass(this) :: apply_vector_dev => neumann_apply_vector_dev
     procedure, pass(this) :: init => neumann_init
     procedure, pass(this) :: init_from_components => &
        neumann_init_from_components
     procedure, pass(this) :: flux => neumann_flux
     procedure, pass(this) :: set_flux_scalar => neumann_set_flux_scalar
     procedure, pass(this) :: set_flux_array => neumann_set_flux_array
     generic :: set_flux => set_flux_scalar, set_flux_array
     procedure, pass(this) :: free => neumann_free
     procedure, pass(this) :: finalize => neumann_finalize
  end type neumann_t
  type, public, extends(bc_t) :: neumann_t …
 
contains
 
  subroutine neumann_init(this, coef, json)
    class(neumann_t), intent(inout), target :: this
    type(coef_t), intent(in) :: coef
    type(json_file), intent(inout) :: json
    real(kind=rp) :: flux
 
    call this%init_base(coef)
    this%strong = .false.
 
    call json_get(json, "flux", flux)
    this%init_flux_ = flux
  subroutine neumann_init(this, coef, json) …
  end subroutine neumann_init
 
  subroutine neumann_init_from_components(this, coef, flux)
    class(neumann_t), intent(inout), target :: this
    type(coef_t), intent(in) :: coef
    real(kind=rp), intent(in) :: flux
 
    call this%init_base(coef)
    this%init_flux_ = flux
  subroutine neumann_init_from_components(this, coef, flux) …
  end subroutine neumann_init_from_components
 
  subroutine neumann_apply_scalar(this, x, n, t, tstep, strong)
    class(neumann_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, facet
    ! Store non-linear index
    integer :: idx(4)
    logical :: strong_ = .true.
 
    if (present(strong)) strong_ = strong
 
    m = this%msk(0)
    if (.not. strong_) then
       do i = 1, m
          k = this%msk(i)
          facet = this%facet(i)
          idx = nonlinear_index(k, this%coef%Xh%lx, this%coef%Xh%lx,&
               this%coef%Xh%lx)
          select case (facet)
          case (1,2)
              x(k) = x(k) + this%flux_(i)*this%coef%area(idx(2), idx(3), facet,&
                  idx(4))
          case (3,4)
              x(k) = x(k) + this%flux_(i)*this%coef%area(idx(1), idx(3), facet,&
                  idx(4))
          case (5,6)
              x(k) = x(k) + this%flux_(i)*this%coef%area(idx(1), idx(2), facet,&
                  idx(4))
          end select
      end do
    end if
  subroutine neumann_apply_scalar(this, x, n, t, tstep, strong) …
  end subroutine neumann_apply_scalar
 
  subroutine neumann_apply_vector(this, x, y, z, n, t, tstep, strong)
    class(neumann_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
 
    call neko_error("Neumann bc not implemented for vectors")
 
  subroutine neumann_apply_vector(this, x, y, z, n, t, tstep, strong) …
  end subroutine neumann_apply_vector
 
  subroutine neumann_apply_scalar_dev(this, x_d, t, tstep, strong)
    class(neumann_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
 
    call neko_error("Neumann bc not implemented on the device")
 
  subroutine neumann_apply_scalar_dev(this, x_d, t, tstep, strong) …
  end subroutine neumann_apply_scalar_dev
 
  subroutine neumann_apply_vector_dev(this, x_d, y_d, z_d, t, tstep, strong)
    class(neumann_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
 
    call neko_error("Neumann bc not implemented on the device")
 
  subroutine neumann_apply_vector_dev(this, x_d, y_d, z_d, t, tstep, strong) …
  end subroutine neumann_apply_vector_dev
 
  subroutine neumann_free(this)
    class(neumann_t), target, intent(inout) :: this
 
    call this%free_base()
 
  subroutine neumann_free(this) …
  end subroutine neumann_free
 
  subroutine neumann_finalize(this)
    class(neumann_t), target, intent(inout) :: this
 
    call this%finalize_base()
    allocate(this%flux_(this%msk(0)))
 
    call cfill(this%flux_, this%init_flux_, this%msk(0))
  subroutine neumann_finalize(this) …
  end subroutine neumann_finalize
 
  pure function neumann_flux(this) result(flux)
    class(neumann_t), intent(in) :: this
    real(kind=rp) :: flux(this%msk(0))
 
    flux = this%flux_
  pure function neumann_flux(this) result(flux) …
  end function neumann_flux
 
  subroutine neumann_set_flux_scalar(this, flux)
    class(neumann_t), intent(inout) :: this
    real(kind=rp), intent(in) :: flux
 
    this%flux_ = flux
  subroutine neumann_set_flux_scalar(this, flux) …
  end subroutine neumann_set_flux_scalar
 
  subroutine neumann_set_flux_array(this, flux)
    class(neumann_t), intent(inout) :: this
    real(kind=rp), intent(in) :: flux(this%msk(0))
 
    call copy(this%flux_, flux, this%msk(0))
  subroutine neumann_set_flux_array(this, flux) …
  end subroutine neumann_set_flux_array
 
end module neumann