avm_simcomp.f90

Go to the documentation of this file.

! Copyright (c) 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.
!
!
 
module avm_simcomp
  use num_types, only : rp
  use json_module, only : json_file
  use simulation_component, only : simulation_component_t
  use case, only : case_t
  use time_state, only : time_state_t
  use artificial_viscosity_model, only : avm_t, avm_factory
  use json_utils, only : json_get, json_get_or_default
  use field_writer, only : field_writer_t
  use utils, only : neko_error, neko_varname_len
  implicit none
  private
 
  type, public, extends(simulation_component_t) :: avm_simcomp_t
     class(avm_t), allocatable :: avm
     type(field_writer_t) :: writer
   contains
     procedure, pass(this) :: init => avm_simcomp_init_from_json
     procedure, pass(this) :: free => avm_simcomp_free
     procedure, pass(this) :: preprocess_ => avm_simcomp_preprocess
     procedure, pass(this) :: compute_ => avm_simcomp_compute
     procedure, pass(this) :: restart_ => avm_simcomp_restart
  end type avm_simcomp_t
 
contains
 
  subroutine avm_simcomp_init_from_json(this, json, case)
    class(avm_simcomp_t), intent(inout), target :: this
    type(json_file), intent(inout) :: json
    class(case_t), intent(inout), target :: case
    character(len=:), allocatable :: name
    character(len=:), allocatable :: model_name
    character(len=NEKO_VARNAME_LEN) :: fields(1)
 
    call this%free()
 
    call json_get_or_default(json, "name", name, "artificial_viscosity_model")
    call json_get(json, "model", model_name)
    this%name = name
 
    call this%init_base(json, case)
 
    ! Create the AVM first so we can get the field name it uses
    call avm_factory(this%avm, model_name, case, json)
 
    ! Get the field name from the model's reg_coeff field and add it to the
    ! field_writer output list
    fields(1) = this%avm%reg_coeff%name
    call json%add("fields", fields)
 
    call this%writer%init(json, case)
 
    if (allocated(name)) deallocate(name)
    if (allocated(model_name)) deallocate(model_name)
  end subroutine avm_simcomp_init_from_json
 
  subroutine avm_simcomp_free(this)
    class(avm_simcomp_t), intent(inout) :: this
    call this%free_base()
    call this%writer%free()
 
    if (allocated(this%avm)) then
       call this%avm%free()
       deallocate(this%avm)
    end if
  end subroutine avm_simcomp_free
 
  subroutine avm_simcomp_preprocess(this, time)
    class(avm_simcomp_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
 
    call this%avm%preprocess(time)
  end subroutine avm_simcomp_preprocess
 
  subroutine avm_simcomp_compute(this, time)
    class(avm_simcomp_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
 
    call this%avm%compute(time)
  end subroutine avm_simcomp_compute
 
  subroutine avm_simcomp_restart(this, time)
    class(avm_simcomp_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
 
    call this%avm%restart(time)
  end subroutine avm_simcomp_restart
 
end module avm_simcomp