shear_stress.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 shear_stress
    use num_types
    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 dirichlet, only : dirichlet_t
    use neumann, only : neumann_t
    use math, only : copy
    use device_math, only : device_copy
    implicit none
    private
 
    type, public, extends(bc_t) :: shear_stress_t
       real(kind=rp), allocatable, private :: tau1_(:)
       real(kind=rp), allocatable, private :: tau2_(:)
       type(dirichlet_t) :: dirichlet
       type(neumann_t) :: neumann1
       type(neumann_t) :: neumann2
     contains
       procedure, pass(this) :: apply_scalar => shear_stress_apply_scalar
       procedure, pass(this) :: apply_vector => shear_stress_apply_vector
       procedure, pass(this) :: apply_scalar_dev => shear_stress_apply_scalar_dev
       procedure, pass(this) :: apply_vector_dev => shear_stress_apply_vector_dev
       procedure, pass(this) :: init_shear_stress => &
         shear_stress_init_shear_stress
       procedure, pass(this) :: tau1 => shear_stress_tau1
       procedure, pass(this) :: tau2 => shear_stress_tau2
       procedure, pass(this) :: set_stress => shear_stress_set_stress
       procedure, pass(this) :: shear_stress_finalize
       procedure, pass(this) :: free => shear_stress_free
    end type shear_stress_t
 
  contains
 
    subroutine shear_stress_apply_scalar(this, x, n, t, tstep)
      class(shear_stress_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
      integer :: i, m, k, facet
      ! Store non-linear index
      integer :: idx(4)
 
      call neko_error("The shear stress bc is not applicable to scalar fields.")
 
    end subroutine shear_stress_apply_scalar
 
    subroutine shear_stress_apply_vector(this, x, y, z, n, t, tstep)
      class(shear_stress_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
 
      call this%neumann1%apply_scalar(x, n, t, tstep)
      call this%neumann2%apply_scalar(z, n, t, tstep)
      call this%dirichlet%apply_scalar(y, n, t, tstep)
 
    end subroutine shear_stress_apply_vector
 
    subroutine shear_stress_apply_scalar_dev(this, x_d, t, tstep)
      class(shear_stress_t), intent(inout), target :: this
      type(c_ptr) :: x_d
      real(kind=rp), intent(in), optional :: t
      integer, intent(in), optional :: tstep
 
      call neko_error("shear_stress bc not implemented on the device")
 
    end subroutine shear_stress_apply_scalar_dev
 
    subroutine shear_stress_apply_vector_dev(this, x_d, y_d, z_d, t, tstep)
      class(shear_stress_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
 
      call neko_error("shear_stress bc not implemented on the device")
 
    end subroutine shear_stress_apply_vector_dev
 
    subroutine shear_stress_init_shear_stress(this, coef)
      class(shear_stress_t), intent(inout) :: this
      type(coef_t), target, intent(in) :: coef
 
      call this%init_base(coef)
 
      call this%dirichlet%init_base(coef)
      call this%neumann1%init_base(coef)
      call this%neumann2%init_base(coef)
 
      call this%dirichlet%set_g(0.0_rp)
 
      this%coef => coef
    end subroutine shear_stress_init_shear_stress
 
    subroutine shear_stress_finalize(this, tau1, tau2)
      class(shear_stress_t), intent(inout) :: this
      real(kind=rp), intent(in) :: tau1
      real(kind=rp), intent(in) :: tau2
 
      call this%neumann1%mark_facets(this%marked_facet)
      call this%neumann2%mark_facets(this%marked_facet)
      call this%dirichlet%mark_facets(this%marked_facet)
 
      call this%dirichlet%finalize()
      call this%neumann1%finalize_neumann(tau1)
      call this%neumann2%finalize_neumann(tau2)
 
    end subroutine shear_stress_finalize
 
    pure function shear_stress_tau1(this) result(tau1)
      class(shear_stress_t), intent(in) :: this
      real(kind=rp) :: tau1(this%msk(0))
 
      tau1 = this%tau1_
    end function shear_stress_tau1
 
    pure function shear_stress_tau2(this) result(tau2)
      class(shear_stress_t), intent(in) :: this
      real(kind=rp) :: tau2(this%msk(0))
 
      tau2 = this%tau2_
    end function shear_stress_tau2
 
    subroutine shear_stress_set_stress(this, tau1, tau2)
      class(shear_stress_t), intent(inout) :: this
      real(kind=rp), intent(in) :: tau1(this%msk(0))
      real(kind=rp), intent(in) :: tau2(this%msk(0))
 
      call copy(this%tau1_, tau1, this%msk(0))
      call copy(this%tau2_, tau2, this%msk(0))
 
    end subroutine shear_stress_set_stress
 
    subroutine shear_stress_free(this)
      class(shear_stress_t), target, intent(inout) :: this
      call this%free_base
      call this%dirichlet%free
      call this%neumann1%free
      call this%neumann2%free
 
    end subroutine shear_stress_free
  end module shear_stress