time_based_controller.f90

Go to the documentation of this file.

! Copyright (c) 2023, 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 time_based_controller
  use num_types, only : rp
  use utils, only : neko_error
  use time_state, only : time_state_t
  implicit none
  private
 
  type, public :: time_based_controller_t
     real(kind=rp) :: frequency = 0.0_rp
     real(kind=rp) :: time_interval = 0.0_rp
     integer :: nsteps = 0
     real(kind=rp) :: start_time = 0.0_rp
     real(kind=rp) :: end_time = 0.0_rp
     integer :: nexecutions = 0
     logical :: never = .false.
     character(len=:), allocatable :: control_mode
     real(kind=rp) :: control_value
 
   contains
     procedure, pass(this) :: init => time_based_controller_init
     procedure, pass(this) :: free => time_based_controller_free
     procedure, pass(this) :: check => time_based_controller_check
     procedure, pass(this) :: register_execution => &
          time_based_controller_register_execution
     procedure, pass(this) :: set_counter => &
          time_based_controller_set_counter
 
  end type time_based_controller_t
 
  interface assignment(=)
     module procedure time_based_controller_assignment
  end interface assignment(=)
 
contains
 
  subroutine time_based_controller_init(this, start_time, end_time, &
       control_mode, control_value)
    class(time_based_controller_t), intent(inout) :: this
    real(kind=rp), intent(in) :: start_time
    real(kind=rp), intent(in) :: end_time
    character(len=*), intent(in) :: control_mode
    real(kind=rp), intent(in) :: control_value
 
    this%start_time = start_time
    this%end_time = end_time
    this%control_mode = control_mode
    this%control_value = control_value
 
    if (trim(control_mode) .eq. 'simulationtime') then
       this%time_interval = control_value
       this%frequency = 1/this%time_interval
       this%nsteps = 0
    else if (trim(control_mode) .eq. 'nsamples') then
       if (control_value .le. 0) then
          call neko_error("nsamples must be positive")
       end if
 
       this%frequency = control_value / (end_time - start_time)
       this%time_interval = 1.0_rp / this%frequency
       this%nsteps = 0
    else if (trim(control_mode) .eq. 'tsteps') then
       this%nsteps = control_value
       ! if the timestep will be variable, we cannot compute these.
       this%frequency = 0
       this%time_interval = 0
    else if (trim(control_mode) .eq. 'never') then
       this%never = .true.
    else
       call neko_error("The control parameter must be simulationtime, nsamples&
       & tsteps, or never, but received "//trim(control_mode))
    end if
  end subroutine time_based_controller_init
 
  subroutine time_based_controller_free(this)
    class(time_based_controller_t), intent(inout) :: this
 
    if (allocated(this%control_mode)) then
       deallocate(this%control_mode)
    end if
 
    this%frequency = 0.0_rp
    this%time_interval = 0.0_rp
    this%nsteps = 0
    this%start_time = 0.0_rp
    this%end_time = 0.0_rp
    this%nexecutions = 0
    this%never = .false.
  end subroutine time_based_controller_free
 
  function time_based_controller_check(this, time, force) result(check)
    class(time_based_controller_t), intent(inout) :: this
    type(time_state_t), intent(in) :: time
    logical, intent(in), optional :: force
    real(kind=rp) :: t
    integer :: tstep
    real(kind=rp) :: dt
    logical :: check
    logical :: ifforce
 
    t = time%t - time%start_time
    dt = time%dt
    tstep = time%tstep
 
    if (present(force)) then
       ifforce = force
    else
       ifforce = .false.
    end if
 
    check = .false.
    if (ifforce) then
       check = .true.
    else if (this%never) then
       check = .false.
    else if (time%t - this%start_time .gt. this%end_time - this%start_time) then
       check = .false.
    else if ( (this%nsteps .eq. 0) .and. &
         (t .ge. this%nexecutions * this%time_interval - 0.1_rp * dt) ) then
       check = .true.
    else if (this%nsteps .gt. 0) then
       if (mod(tstep, this%nsteps) .eq. 0) then
          check = .true.
       end if
    end if
  end function time_based_controller_check
 
  subroutine time_based_controller_assignment(ctrl1, ctrl2)
    type(time_based_controller_t), intent(inout) :: ctrl1
    type(time_based_controller_t), intent(in) :: ctrl2
 
    ctrl1%end_time = ctrl2%end_time
    ctrl1%frequency = ctrl2%frequency
    ctrl1%nsteps = ctrl2%nsteps
    ctrl1%time_interval = ctrl2%time_interval
    ctrl1%nexecutions = ctrl2%nexecutions
 
  end subroutine time_based_controller_assignment
 
  subroutine time_based_controller_register_execution(this)
    class(time_based_controller_t), intent(inout) :: this
 
    this%nexecutions = this%nexecutions + 1
 
  end subroutine time_based_controller_register_execution
 
  subroutine time_based_controller_set_counter(this, time)
    class(time_based_controller_t), intent(inout) :: this
    type(time_state_t) :: time
 
    if (this%nsteps .eq. 0) then
       this%nexecutions = int(((time%t - time%start_time) + 0.1_rp*time%dt) &
            / this%time_interval) + 1
    end if
 
  end subroutine time_based_controller_set_counter
 
 
end module time_based_controller