Changes between Version 19 and Version 20 of InitPdaf


Ignore:
Timestamp:
Sep 26, 2011, 4:52:59 PM (8 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • InitPdaf

    v19 v20  
    3838               COMM_model, COMM_filter, COMM_couple, &
    3939               task_id, n_modeltasks, filterpe, &
    40                U_ensemble_init, screen, status_pdaf)
     40               U_init_ens_pdaf, screen, status_pdaf)
    4141}}}
    4242
     
    6565 * `n_modeltasks`: The number of model tasks as defined before the call to `init_parallel_pdaf`.
    6666 * `filterpe`: The flag showing if a process belongs to `COMM_filter` as initialized by `init_parallel_pdaf`.
    67  * `U_ensemble_init`: The name of the user-supplied routine that is called by `PDAF_init` to initialize the ensemble of model states. (See '[#User-suppliedroutineU_ensemble_init User-supplied routine U_ensemble_init]'
     67 * `U_init_ens_pdaf`: The name of the user-supplied routine that is called by `PDAF_init` to initialize the ensemble of model states. (See '[#User-suppliedroutineU_ensemble_init User-supplied routine U_ensemble_init]'
    6868 * `screen`: An integer defining whether information output is written to the screen (i.e. standard output). The following choices are available:
    6969  * 0: quite mode - no information is displayed.
     
    8585It is useful to define variables like these at this central position. Of course, this definition has to be adapted to the particular model used.
    8686
    87 == User-supplied routine `U_ensemble_init` ==
     87== User-supplied routine `U_init_ens_pdaf` ==
    8888
    89 The user-supplied routine the we named `U_ensemble_init` here, is called by PDAF through the defined interface described below. The routine is called by all MPI processes that compute the filter analysis step (i.e. those for which 'filterpe' is set to true. In the standard configuration of `init_parallel_pdaf` these are all processes of the first model task, i.e. task_id=1.) `U_ensemble_init` is only called by `PDAF_init` if no error occurred before; thus the status flag is zero.
     89The user-supplied routine the we named `U_init_ens_pdaf` here, is called by PDAF through the defined interface described below. The routine is called by all MPI processes that compute the filter analysis step (i.e. those for which 'filterpe' is set to true. In the standard configuration of `init_parallel_pdaf` these are all processes of the first model task, i.e. task_id=1.) `U_init_ens_pdaf` is only called by `PDAF_init` if no error occurred before; thus the status flag is zero.
    9090
    9191The interface is the following:
    9292{{{
    93 SUBROUTINE U_ensemble_init(filtertype, dim_p, dim_ens, &
     93SUBROUTINE U_init_ens_pdaf(filtertype, dim_p, dim_ens, &
    9494                           state_p, Uinv, ens_p, flag)
    9595}}}
     
    103103 * `flag`: Status flag for PDAF. It is 0 upon entry and can be set by in the user-supplied routine, depending on the success of the ensemble initialization.  Preferably, values above 102 should be used for failures to avoid conflicts with the error codes defined within PDAF_init.
    104104
    105 In the initialization routine `U_ensemble_init` one has to distinguish between ensemble-based and mode-based filters. The only mode based filter supplied with PDAF is SEEK, while all other methods are ensemble-based.
     105In the initialization routine `U_init_ens_pdaf` one has to distinguish between ensemble-based and mode-based filters. The only mode based filter supplied with PDAF is SEEK, while all other methods are ensemble-based.
    106106
    107107=== Initialization for ensemble-based filters ===