PDAF_reset_forget.F90 Source File


Source Code

! Copyright (c) 2004-2024 Lars Nerger
!
! This file is part of PDAF.
!
! PDAF is free software: you can redistribute it and/or modify
! it under the terms of the GNU Lesser General Public License
! as published by the Free Software Foundation, either version
! 3 of the License, or (at your option) any later version.
!
! PDAF is distributed in the hope that it will be useful,
! but WITHOUT ANY WARRANTY; without even the implied warranty of
! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
! GNU Lesser General Public License for more details.
!
! You should have received a copy of the GNU Lesser General Public
! License along with PDAF.  If not, see <http://www.gnu.org/licenses/>.
!
!$Id$
!BOP
!
! !ROUTINE: PDAF_reset_forget --- Manually reset forgetting factor
!
! !INTERFACE:
SUBROUTINE PDAF_reset_forget(forget_in)

! !DESCRIPTION:
! Helper routine for PDAF.
! The routine allows to manually set the forgetting
! factor to a new value. Usually this should be called
! in assimilate_pdaf before calling the analysis step
! routine.
!
! !  This is a core routine of PDAF and
!    should not be changed by the user   !
!
! !REVISION HISTORY:
! 2021-05 - Lars Nerger - Initial code
! Later revisions - see svn log
!
! !USES:
  USE PDAF_mod_filter, &
       ONLY: localfilter, forget, forget_l, inloop

  IMPLICIT NONE
  
! !ARGUMENTS:
  REAL,INTENT(in) :: forget_in    ! New value of forgetting factor
!EOP

! *** Set forgetting factor ***

  IF (localfilter == 0) THEN
     forget = forget_in
  ELSE
     IF (inloop) THEN
        forget_l = forget_in
     ELSE
        forget = forget_in
     END IF
  END IF

END SUBROUTINE PDAF_reset_forget