dirichlet.f90

Go to the documentation of this file.

! Copyright (c) 2020-2025, 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 dirichlet
  use device_dirichlet, only : device_dirichlet_apply_scalar, &
       device_dirichlet_apply_vector
  use num_types, only : rp
  use bc, only : bc_t
  use coefs, only : coef_t
  use json_module, only : json_file
  use json_utils, only : json_get_or_lookup
  use, intrinsic :: iso_c_binding, only : c_ptr
  use time_state, only : time_state_t
  implicit none
  private
 
  type, public, extends(bc_t) :: dirichlet_t
     real(kind=rp), private :: g
   contains
     procedure, pass(this) :: apply_scalar => dirichlet_apply_scalar
     procedure, pass(this) :: apply_vector => dirichlet_apply_vector
     procedure, pass(this) :: apply_scalar_dev => dirichlet_apply_scalar_dev
     procedure, pass(this) :: apply_vector_dev => dirichlet_apply_vector_dev
     procedure, pass(this) :: set_g => dirichlet_set_g
     procedure, pass(this) :: init => dirichlet_init
     procedure, pass(this) :: init_from_components => &
          dirichlet_init_from_components
     procedure, pass(this) :: free => dirichlet_free
     procedure, pass(this) :: finalize => dirichlet_finalize
  end type dirichlet_t
 
contains
 
  subroutine dirichlet_init(this, coef, json)
    class(dirichlet_t), intent(inout), target :: this
    type(coef_t), target, intent(in) :: coef
    type(json_file), intent(inout) ::json
    real(kind=rp) :: g
 
    call this%init_base(coef)
    call json_get_or_lookup(json , "value", g)
 
    this%g = g
  end subroutine dirichlet_init
 
  subroutine dirichlet_init_from_components(this, coef, g)
    class(dirichlet_t), intent(inout), target :: this
    type(coef_t), target, intent(in) :: coef
    real(kind=rp), intent(in) :: g
 
    call this%init_base(coef)
    this%g = g
  end subroutine dirichlet_init_from_components
 
  subroutine dirichlet_apply_scalar(this, x, n, time, strong)
    class(dirichlet_t), intent(inout) :: this
    integer, intent(in) :: n
    real(kind=rp), intent(inout), dimension(n) :: x
    type(time_state_t), intent(in), optional :: time
    logical, intent(in), optional :: strong
    integer :: i, m, k
    logical :: strong_
 
    if (present(strong)) then
       strong_ = strong
    else
       strong_ = .true.
    end if
 
    if (strong_) then
       m = this%msk(0)
       do i = 1, m
          k = this%msk(i)
          x(k) = this%g
       end do
    end if
  end subroutine dirichlet_apply_scalar
 
  subroutine dirichlet_apply_vector(this, x, y, z, n, time, strong)
    class(dirichlet_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
    type(time_state_t), intent(in), optional :: time
    logical, intent(in), optional :: strong
    integer :: i, m, k
    logical :: strong_
 
    if (present(strong)) then
       strong_ = strong
    else
       strong_ = .true.
    end if
 
    if (strong_) then
       m = this%msk(0)
       do i = 1, m
          k = this%msk(i)
          x(k) = this%g
          y(k) = this%g
          z(k) = this%g
       end do
    end if
 
  end subroutine dirichlet_apply_vector
 
  subroutine dirichlet_apply_scalar_dev(this, x_d, time, strong, strm)
    class(dirichlet_t), intent(inout), target :: this
    type(c_ptr), intent(inout) :: x_d
    type(time_state_t), intent(in), optional :: time
    logical, intent(in), optional :: strong
    type(c_ptr), intent(inout) :: strm
    logical :: strong_
 
    if (present(strong)) then
       strong_ = strong
    else
       strong_ = .true.
    end if
 
    if (strong_ .and. this%msk(0) .gt. 0) then
       call device_dirichlet_apply_scalar(this%msk_d, x_d, &
            this%g, size(this%msk), strm)
    end if
 
  end subroutine dirichlet_apply_scalar_dev
 
  subroutine dirichlet_apply_vector_dev(this, x_d, y_d, z_d, &
       time, strong, strm)
    class(dirichlet_t), intent(inout), target :: this
    type(c_ptr), intent(inout) :: x_d
    type(c_ptr), intent(inout) :: y_d
    type(c_ptr), intent(inout) :: z_d
    type(time_state_t), intent(in), optional :: time
    logical, intent(in), optional :: strong
    type(c_ptr), intent(inout) :: strm
    logical :: strong_
 
    if (present(strong)) then
       strong_ = strong
    else
       strong_ = .true.
    end if
 
    if (strong_ .and. this%msk(0) .gt. 0) then
       call device_dirichlet_apply_vector(this%msk_d, x_d, y_d, z_d, this%g, &
            size(this%msk), strm)
    end if
 
  end subroutine dirichlet_apply_vector_dev
 
  subroutine dirichlet_set_g(this, g)
    class(dirichlet_t), intent(inout) :: this
    real(kind=rp), intent(in) :: g
 
    this%g = g
 
  end subroutine dirichlet_set_g
 
  subroutine dirichlet_free(this)
    class(dirichlet_t), target, intent(inout) :: this
 
    call this%free_base
 
  end subroutine dirichlet_free
 
  subroutine dirichlet_finalize(this, only_facets)
    class(dirichlet_t), target, intent(inout) :: this
    logical, optional, intent(in) :: only_facets
    logical :: only_facets_
 
    if (present(only_facets)) then
       only_facets_ = only_facets
    else
       only_facets_ = .false.
    end if
 
    call this%finalize_base(only_facets_)
  end subroutine dirichlet_finalize
 
end module dirichlet