Changes between Version 35 and Version 36 of ModifyModelforEnsembleIntegration

Timestamp:

May 24, 2025, 8:49:46 AM (8 days ago)

Author:

lnerger

Comment:

--

ModifyModelforEnsembleIntegration

@@ -86 +86 @@
 {{{
 SUBROUTINE next_observation_pdaf(stepnow, nsteps, doexit, timenow)
+
+  INTEGER, INTENT(in)  :: stepnow  ! The current time step provided by PDAF
+  INTEGER, INTENT(out) :: nsteps   ! The number of time steps of the next forecast phase
+  INTEGER, INTENT(out) :: doexit   ! Exit flag: (1) exit, (0) continue data assimilation
+  REAL, INTENT(out)    :: timenow  ! Current (physical) model (physical) time. Not used by PDAF itself.
 }}}
-with arguments:
-* `stepnow`, `integer, intent(in)`:[[BR]] The current time step provided by PDAF
-* `nsteps`, `integer, intent(out)`:[[BR]] The number of time steps of the next forecast phase
-* `doexit`, `integer, intent(out)`:[[BR]] Exit flag: (1) exit, (0) continue data assimilation
-* `timenow`, `real, intent(out)`:[[BR]] The current (physical) model time as defined by the model or user. Not used by PDAF itself.
 
 The routine is called by `PDAF_init_forecast` and later at the beginning of each forecast phase by `PDAF3_assimilate`, or similar routines. It is executed by all processes that participate in the model integrations.
@@ -111 +111 @@
 {{{
 SUBROUTINE distribute_state(dim_p, state_p)
+
+  INTEGER, INTENT(in) :: dim_p           ! Size of state vector for process-local sub-domain
+  REAL, INTENT(inout) :: state_p(dim_p)  ! State vector for process-local sub-domain
 }}}
-with arguments
- * `dim_p`, `integer, intent(in)`:[[BR]] Size of state vector for process-local sub-domain
- * `state_p`, `real, intent(in), dimension(dim_p)`:[[BR]] State vector for process-local sub-domain
 
 The routine is called by `PDAF_init_forecast` and later at the beginning of each forecast phase by `PDAF3_assimilate`, or similar routines. It is executed by all processes that participate in the model integrations.
@@ -132 +132 @@
 SUBROUTINE prepoststep(step, dim_p, dim_ens, dim_ens_p, dim_obs_p, &
                        state_p, Ainv, ens_p, flag)
+
+  INTEGER, INTENT(in) :: step        ! Current time step
+                         ! (When the routine is called before the analysis -step is provided.)
+  INTEGER, INTENT(in) :: dim_p       ! Process-local state dimension
+  INTEGER, INTENT(in) :: dim_ens     ! Size of state ensemble
+  INTEGER, INTENT(in) :: dim_ens_p   ! Process-local ensemble size (not relevant for fully parallel)
+  INTEGER, INTENT(in) :: dim_obs_p   ! Process-local dimension of observation vector
+  REAL, INTENT(inout) :: state_p(dim_p) ! Process-local state vector
+                                     ! The array 'state_p' is not generally not initialized.
+                                     ! It can be used freely in this routine.
+  REAL, INTENT(inout) :: Ainv(dim_ens-1, dim_ens-1) ! Inverse of matrix A )only for special cases)
+  REAL, INTENT(inout) :: ens_p(dim_p, dim_ens)      ! State ensemble for process-local sub-domain
+  INTEGER, INTENT(in) :: flag        ! PDAF status flag
 }}}
-with arguments:
- * `step`, `INTEGER, INTENT(in)`:[[BR]] Current time step (When the routine is called for the forecast state the time steps is provided as a negative value.)
- * `dim_p`, `INTEGER, INTENT(in)`:[[BR]] Process-local state dimension
- * `dim_ens`, `INTEGER, INTENT(in)`:[[BR]] Ensemble size
- * `dim_ens_p`, `INTEGER, INTENT(in)`:[[BR]] Process-local ensemble size (not relevant for ''fully parallel'')
- * `dim_obs_p`, `INTEGER, INTENT(in)`:[[BR]] Process-local dimension of observation vector
- * `state_p`, `REAL, INTENT(inout), dimension(dim_p)`:[[BR]] Process-local state vector (The array 'state_p' is not generally not initialized. It can be used freely in this routine.)
- * `Ainv`, `REAL, INTENT(inout), dimension(dim_ens-1, dim_ens-1)`:[[BR]] Inverse of matrix A (only for special cases)
- * **`ens_p`, `REAL, INTENT(inout), dimension(dim_p, dim_ens)`**:[[BR]] State ensemble for process-local sub-domain
- * `flag`, `INTEGER, INTENT(in)`:[[BR]] PDAF status flag
 
 The routine `prepoststep_pdaf` is called once at the beginning of the assimilation process. In addition, it is called during the assimilation cycles before the analysis step and after the ensemble transformation. The routine is called by all filter processes (that is `filterpe=.true.`).