! Copyright (c) 2014-2024 Paul Kirchgessner ! ! 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_put_state_lnetf --- Interface to transfer state to PDAF ! ! !INTERFACE: SUBROUTINE PDAF_put_state_lnetf(U_collect_state, U_init_dim_obs, U_obs_op, & U_init_obs_l, U_prepoststep, U_likelihood_l, U_init_n_domains_p, & U_init_dim_l, U_init_dim_obs_l, U_g2l_state, U_l2g_state, U_g2l_obs, & outflag) ! !DESCRIPTION: ! Interface routine called from the model after the ! forecast of each ensemble state to transfer data ! from the model to PDAF. For the parallelization ! this involves transfer from model PEs to filter ! PEs.\\ ! During the forecast phase state vectors are ! re-initialized from the forecast model fields ! by U\_collect\_state. ! At the end of a forecast phase (i.e. when all ! ensemble members have been integrated by the model) ! sub-ensembles are gathered from the model tasks. ! Subsequently the filter update is performed. ! ! The code is very generic. Basically the only ! filter-specific part if the call to the ! update-routine PDAF\_X\_update where the analysis ! is computed. The filter-specific subroutines that ! are specified in the call to PDAF\_put\_state\_X ! are passed through to the update routine ! ! Variant for LNETF with domain decomposition. ! ! ! This is a core routine of PDAF and ! should not be changed by the user ! ! ! !REVISION HISTORY: ! 2014-05 - Paul Kirchgessner - Initial code based on LETKF ! Later revisions - see svn log ! ! !USES: USE PDAF_communicate_ens, & ONLY: PDAF_gather_ens USE PDAF_timer, & ONLY: PDAF_timeit, PDAF_time_temp USE PDAF_memcounting, & ONLY: PDAF_memcount USE PDAF_mod_filter, & ONLY: dim_p, dim_obs, dim_ens, local_dim_ens, & nsteps, step_obs, step, member, member_save, subtype_filter, & type_forget, initevol, state, eofV, & noise_type, pf_noise_amp, offline_mode, & eofU, screen, flag, sens, dim_lag, cnt_maxlag USE PDAF_mod_filtermpi, & ONLY: mype_world, filterpe, dim_ens_l IMPLICIT NONE ! !ARGUMENTS: INTEGER, INTENT(out) :: outflag ! Status flag ! ! External subroutines ! ! (PDAF-internal names, real names are defined in the call to PDAF) EXTERNAL :: U_collect_state, & ! Routine to collect a state vector U_obs_op, & ! Observation operator U_init_n_domains_p, & ! Provide number of local analysis domains U_init_dim_l, & ! Init state dimension for local ana. domain U_init_dim_obs, & ! Initialize dimension of observation vector U_init_dim_obs_l, & ! Initialize dim. of obs. vector for local ana. domain U_init_obs_l, & ! Init. observation vector on local analysis domain U_g2l_state, & ! Get state on local ana. domain from full state U_l2g_state, & ! Init full state from state on local analysis domain U_g2l_obs, & ! Restrict full obs. vector to local analysis domain U_likelihood_l, & ! Compute observation likelihood for an ensemble member U_prepoststep ! User supplied pre/poststep routine ! !CALLING SEQUENCE: ! Called by: model code ! Calls: U_collect_state ! Calls: PDAF_gather_ens ! Calls: PDAF_etkf_update ! Calls: PDAF_timeit !EOP ! local variables INTEGER :: i ! Counter ! ************************************************** ! *** Save forecasted state back to the ensemble *** ! *** Only done on the filter Pes *** ! ************************************************** doevol: IF (nsteps > 0 ) THEN CALL PDAF_timeit(41, 'new') ! Store member index for PDAF_get_memberid member_save = member ! Save evolved state in ensemble matrix CALL U_collect_state(dim_p, eofV(1 : dim_p, member)) CALL PDAF_timeit(41, 'old') member = member + 1 ELSE member = local_dim_ens + 1 END IF doevol ! ******************************************************** ! *** When forecast phase is completed *** ! *** - collect forecast sub_ensembles on filter PEs *** ! *** - perform analysis step *** ! *** - re-initialize forecast counters/flags *** ! ******************************************************** completeforecast: IF (member == local_dim_ens + 1 & .OR. offline_mode) THEN ! *********************************************** ! *** Collect forecast ensemble on filter PEs *** ! *********************************************** doevolB: IF (nsteps > 0) THEN IF (.not.filterpe) THEN ! Non filter PEs only store a sub-ensemble CALL PDAF_gather_ens(dim_p, dim_ens_l, eofV, screen) ELSE ! On filter PEs, the ensemble array has full size CALL PDAF_gather_ens(dim_p, dim_ens, eofV, screen) END IF END IF doevolB ! *** call timer CALL PDAF_timeit(2, 'old') IF (.NOT.offline_mode .AND. mype_world == 0 .AND. screen > 1) THEN WRITE (*, '(a, 5x, a, F10.3, 1x, a)') & 'PDAF', '--- duration of forecast phase:', PDAF_time_temp(2), 's' END IF ! ************************************** ! *** Perform analysis on filter PEs *** ! ************************************** ! Screen output IF (offline_mode .AND. mype_world == 0 .AND. screen > 0) THEN WRITE (*, '(//a5, 64a)') 'PDAF ',('-', i = 1, 64) WRITE (*, '(a, 20x, a)') 'PDAF', '+++++ ASSIMILATION +++++' WRITE (*, '(a5, 64a)') 'PDAF ', ('-', i = 1, 64) ENDIF OnFilterPE: IF (filterpe) THEN CALL PDAF_lnetf_update(step_obs, dim_p, dim_obs, dim_ens, & state, eofU, eofV, type_forget, noise_type, pf_noise_amp, & U_obs_op, U_init_dim_obs, U_init_obs_l, U_likelihood_l, & U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l, U_g2l_state, U_l2g_state, & U_g2l_obs, U_prepoststep, screen, subtype_filter, & dim_lag, sens, cnt_maxlag, flag) END IF OnFilterPE ! *********************************** ! *** Set forecast counters/flags *** ! *********************************** initevol = 1 member = 1 step = step_obs + 1 END IF completeforecast ! ******************** ! *** finishing up *** ! ******************** outflag = flag END SUBROUTINE PDAF_put_state_lnetf