fluid_pnpn_bc_fctry.f90

Go to the documentation of this file.

 
! Copyright (c) 2024-2026, 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.
!
!
submodule(fluid_pnpn) fluid_pnpn_bc_fctry
  ! We explicitly import all necessary modules to work around an ifx 2026.1
  ! internal compiler error even when they are only available through the
  ! parent.
  use vector_bc_projector, only : segregated_vector_bc_projector_t, &
       coupled_vector_bc_projector_t
  use user_intf, only : user_t
  use utils, only : neko_type_error
  use field_dirichlet, only : field_dirichlet_t
  use inflow, only : inflow_t
  use blasius, only : blasius_t
  use dirichlet, only : dirichlet_t
  use dong_outflow, only : dong_outflow_t
  use symmetry_aligned, only : symmetry_aligned_t
  use symmetry, only : symmetry_t
  use non_normal_aligned, only : non_normal_aligned_t
  use non_normal, only : non_normal_t
  use no_slip, only : no_slip_t
  use zero_dirichlet, only : zero_dirichlet_t
  use shear_stress, only : shear_stress_t
  use wall_model_bc, only : wall_model_bc_t
  use field_dirichlet_vector, only : field_dirichlet_vector_t
  use expression_dirichlet, only : expression_dirichlet_t
  use expression_dirichlet_vector, only : expression_dirichlet_vector_t
  use overset_interface, only : overset_interface_t
  use overset_interface_vector, only : overset_interface_vector_t
  implicit none
 
  ! List of all possible types created by the boundary condition factories
  character(len=25) :: FLUID_PNPN_KNOWN_BCS(17) = [character(len=25) :: &
       "symmetry", &
       "velocity_value", &
       "expression_velocity", &
       "expression_pressure", &
       "no_slip", &
       "outflow", &
       "normal_outflow", &
       "outflow+user", &
       "normal_outflow+user", &
       "outflow+dong", &
       "normal_outflow+dong", &
       "shear_stress", &
       "user_velocity", &
       "user_pressure", &
       "blasius_profile", &
       "wall_model", &
       "overset_interface"]
 
contains
 
  module subroutine pressure_bc_factory(object, scheme, json, coef, user)
    class(bc_t), pointer, intent(inout) :: object
    type(fluid_pnpn_t), intent(in) :: scheme
    type(json_file), intent(inout) :: json
    type(coef_t), target, intent(in) :: coef
    type(user_t), target, intent(in) :: user
    character(len=:), allocatable :: type
    integer :: i, j, k
    integer, allocatable :: zone_indices(:)
    character(len=:), allocatable :: default_name
    character(len=64) :: buf
    logical :: temp_logical
 
    if (associated(object)) then
       call object%free()
       nullify(object)
    end if
 
    call json_get(json, "type", type)
 
    select case (trim(type))
    case ("outflow", "normal_outflow")
       allocate(zero_dirichlet_t::object)
 
    case ("expression_pressure")
       allocate(expression_dirichlet_t::object)
 
    case ("outflow+dong", "normal_outflow+dong")
       allocate(dong_outflow_t::object)
 
    case ("user_pressure", "outflow+user", "normal_outflow+user")
       allocate(field_dirichlet_t::object)
       select type (obj => object)
       type is (field_dirichlet_t)
          obj%update => user%dirichlet_conditions
          call json%add("field_name", scheme%p%name)
       end select
 
    case ("overset_interface")
       call json_get_or_default(json, "couple_pressure", temp_logical, .false.)
       if (temp_logical) then
          allocate(overset_interface_t::object)
          select type (obj => object)
          type is (overset_interface_t)
             call json%add("field_name", scheme%p%name)
             obj%morph_interface => user%morph_interface
          end select
       else
          return
       end if
 
    case default
       do i = 1, size(fluid_pnpn_known_bcs)
          if (trim(type) .eq. trim(fluid_pnpn_known_bcs(i))) return
       end do
       call neko_type_error("fluid_pnpn boundary conditions", type, &
            FLUID_PNPN_KNOWN_BCS)
    end select
 
    call json_get_or_lookup(json, "zone_indices", zone_indices)
    call object%init(coef, json)
 
    do i = 1, size(zone_indices)
       call object%mark_labeled_zone(zone_indices(i))
    end do
 
    write(buf, '("pressure_bc_", I0)') zone_indices(1)
    default_name = trim(buf)
    call json_get_or_default(json, "name", object%name, default_name)
    object%zone_indices = zone_indices
    call object%finalize()
 
    ! All pressure bcs are currently strong, so for all of them we
    ! mark with value 1 in the mesh
    do i = 1, size(zone_indices)
       do j = 1, scheme%msh%nelv
          do k = 1, 2 * scheme%msh%gdim
             if (scheme%msh%facet_type(k,j) .eq. -zone_indices(i)) then
                scheme%msh%facet_type(k, j) = 1
             end if
          end do
       end do
    end do
 
    if (allocated(type)) then
       deallocate(type)
    end if
 
    if (allocated(zone_indices)) then
       deallocate(zone_indices)
    end if
  end subroutine pressure_bc_factory
 
  module subroutine velocity_bc_factory(object, scheme, json, coef, user)
    class(bc_t), pointer, intent(inout) :: object
    type(fluid_pnpn_t), intent(inout) :: scheme
    type(json_file), intent(inout) :: json
    type(coef_t), target, intent(in) :: coef
    type(user_t), target, intent(in) :: user
    character(len=:), allocatable :: type
    integer :: i, j, k
    integer, allocatable :: zone_indices(:)
    character(len=:), allocatable :: default_name
    character(len=:), allocatable :: bc_name
    character(len=64) :: buf
 
    call json_get(json, "type", type)
 
    select case (trim(type))
    case ("symmetry")
       if (scheme%full_stress_formulation) then
          allocate(symmetry_t::object)
       else
          allocate(symmetry_aligned_t::object)
       end if
    case ("velocity_value")
       allocate(inflow_t::object)
    case ("expression_velocity")
       allocate(expression_dirichlet_vector_t::object)
    case ("no_slip")
       allocate(no_slip_t::object)
    case ("normal_outflow", "normal_outflow+dong", "normal_outflow+user")
       if (scheme%full_stress_formulation) then
          allocate(non_normal_t::object)
       else
          allocate(non_normal_aligned_t::object)
       end if
    case ("blasius_profile")
       allocate(blasius_t::object)
    case ("shear_stress")
       allocate(shear_stress_t::object)
    case ("wall_model")
       allocate(wall_model_bc_t::object)
       ! Kind of hack, but  OK for now
       call json%add("scheme_name", scheme%name)
 
       select type (wall_bc => object)
       type is (wall_model_bc_t)
          wall_bc%user => user
       end select
 
    case ("user_velocity")
       allocate(field_dirichlet_vector_t::object)
       select type (obj => object)
       type is (field_dirichlet_vector_t)
          obj%update => user%dirichlet_conditions
       end select
 
    case ("overset_interface")
       allocate(overset_interface_vector_t::object)
       select type (obj => object)
       type is (overset_interface_vector_t)
          obj%morph_interface => user%morph_interface
       end select
 
    case default
       do i = 1, size(fluid_pnpn_known_bcs)
          if (trim(type) .eq. trim(fluid_pnpn_known_bcs(i))) return
       end do
       call neko_type_error("fluid_pnpn boundary conditions", type, &
            FLUID_PNPN_KNOWN_BCS)
    end select
 
    call json_get_or_lookup(json, "zone_indices", zone_indices)
    write(buf,'("velocity_bc_",I0)') zone_indices(1)
    default_name = trim(buf)
    call json_get_or_default(json, "name", bc_name, default_name)
 
    call object%init(coef, json)
    do i = 1, size(zone_indices)
       call object%mark_labeled_zone(zone_indices(i))
    end do
 
    object%name = bc_name
    object%zone_indices = zone_indices
 
    call object%finalize()
 
    ! Some bcs are marked in the pressure factory routine, and we should ignore
    ! then here. This currently appears to only be the normal_outflow type and
    ! its variants.
    if (trim(type) .ne. "normal_outflow" .and. &
         trim(type) .ne. "normal_outflow+dong" .and. &
         trim(type) .ne. "normal_outflow+user") then
       do i = 1, size(zone_indices)
          do j = 1, scheme%msh%nelv
             do k = 1, 2 * scheme%msh%gdim
                if (scheme%msh%facet_type(k,j) .eq. -zone_indices(i)) then
                   scheme%msh%facet_type(k, j) = 2
                end if
             end do
          end do
       end do
    end if
 
    if (allocated(type)) then
       deallocate(type)
    end if
 
    if (allocated(zone_indices)) then
       deallocate(zone_indices)
    end if
  end subroutine velocity_bc_factory
 
end submodule fluid_pnpn_bc_fctry