pyPDAF.PDAF.localomi_assimilate_lnetf_nondiagR

pyPDAF.PDAF.localomi_assimilate_lnetf_nondiagR()

LNETF for a single DA step using non-diagnoal observation error covariance matrix.

See pyPDAF.PDAF.localomi_assimilate() for using diagnoal observation error covariance matrix. The non-linear filter is proposed in [1]. The filter type is set in pyPDAF.PDAF.init(). This function should be called at each model time step. The function is a combination of pyPDAF.PDAF.localomi_put_state_lnetf_nondiagR() and pyPDAF.PDAF.get_state().

User-supplied functions are executed in the following sequence:

  1. py__collect_state_pdaf

  2. py__prepoststep_state_pdaf

  3. py__init_n_domains_p_pdaf

  4. py__init_dim_obs_pdaf

  5. py__obs_op_pdaf (for each ensemble member)

  6. loop over each local domain:

    1. py__init_dim_l_pdaf

    2. py__init_dim_obs_l_pdaf

    3. py__likelihood_l_pdaf

    4. core DA algorithm

  7. py__prepoststep_state_pdaf

  8. py__distribute_state_pdaf

  9. py__next_observation_pdaf

References

Parameters:

  • py__collect_state_pdaf (Callable[dim_p:int, state_p : ndarray[tuple[dim_p], np.float64]]) –

    Routine to collect a state vector

    Callback Parameters
    • dim_pint

      • pe-local state dimension

    • state_pndarray[tuple[dim_p], np.float64]

      • local state vector

    Callback Returns
    • state_pndarray[tuple[dim_p], np.float64]

      • local state vector

  • py__distribute_state_pdaf (Callable[dim_p:int, state_p : ndarray[tuple[dim_p], np.float64]]) –

    Routine to distribute a state vector

    Callback Parameters
    • dim_pint

      • pe-local state dimension

    • state_pndarray[tuple[dim_p], np.float64]

      • local state vector

    Callback Returns
    • state_pndarray[tuple[dim_p], np.float64]

      • local state vector

  • py__init_dim_obs_pdaf (Callable[step:int, dim_obs_p:int]) –

    Initialize dimension of full observation vector

    Callback Parameters
    • stepint

      • current time step

    • dim_obs_pint

      • dimension of observation vector

    Callback Returns
    • dim_obs_pint

      • dimension of observation vector

  • py__obs_op_pdaf (Callable[step:int, dim_p:int, dim_obs_p:int, state_p : ndarray[tuple[dim_p], np.float64], m_state_p : ndarray[tuple[dim_obs_p], np.float64]]) –

    Full observation operator

    Callback Parameters
    • stepint

      • Current time step

    • dim_pint

      • Size of state vector (local part in case of parallel decomposed state)

    • dim_obs_pint

      • Size of observation vector

    • state_pndarray[tuple[dim_p], np.float64]

      • Model state vector

    • m_state_pndarray[tuple[dim_obs_p], np.float64]

      • Observed state vector (i.e. the result after applying the observation operator to state_p)

    Callback Returns
    • m_state_pndarray[tuple[dim_obs_p], np.float64]

      • Observed state vector (i.e. the result after applying the observation operator to state_p)

  • py__prepoststep_pdaf (Callable[step:int, dim_p:int, dim_ens:int, dim_ens_p:int, dim_obs_p:int, state_p : ndarray[tuple[dim_p], np.float64], uinv : ndarray[tuple[dim_ens-1, dim_ens-1], np.float64], ens_p : ndarray[tuple[dim_p, dim_ens], np.float64], flag:int]) –

    User supplied pre/poststep routine

    Callback Parameters
    • stepint

      • current time step (negative for call after forecast)

    • dim_pint

      • pe-local state dimension

    • dim_ensint

      • size of state ensemble

    • dim_ens_pint

      • pe-local size of ensemble

    • dim_obs_pint

      • pe-local dimension of observation vector

    • state_pndarray[tuple[dim_p], np.float64]

      • pe-local forecast/analysis state (the array ‘state_p’ is not generally not initialized in the case of seik. it can be used freely here.)

    • uinvndarray[tuple[dim_ens-1, dim_ens-1], np.float64]

      • inverse of matrix u

    • ens_pndarray[tuple[dim_p, dim_ens], np.float64]

      • pe-local state ensemble

    • flagint

      • pdaf status flag

    Callback Returns
    • state_pndarray[tuple[dim_p], np.float64]

      • pe-local forecast/analysis state (the array ‘state_p’ is not generally not initialized in the case of seik. it can be used freely here.)

    • uinvndarray[tuple[dim_ens-1, dim_ens-1], np.float64]

      • inverse of matrix u

    • ens_pndarray[tuple[dim_p, dim_ens], np.float64]

      • pe-local state ensemble

  • py__init_n_domains_p_pdaf (Callable[step:int, n_domains_p:int]) –

    Provide number of local analysis domains

    Callback Parameters
    • stepint

      • current time step

    • n_domains_pint

      • pe-local number of analysis domains

    Callback Returns
    • n_domains_pint

      • pe-local number of analysis domains

  • py__init_dim_l_pdaf (Callable[step:int, domain_p:int, dim_l:int]) –

    Init state dimension for local ana. domain

    Callback Parameters
    • stepint

      • current time step

    • domain_pint

      • current local analysis domain

    • dim_lint

      • local state dimension

    Callback Returns
    • dim_lint

      • local state dimension

  • py__init_dim_obs_l_pdaf (Callable[domain_p:int, step:int, dim_obs_f:int, dim_obs_l:int]) –

    Initialize local dimimension of obs. vector

    Callback Parameters
    • domain_pint

      • index of current local analysis domain

    • stepint

      • current time step

    • dim_obs_fint

      • full dimension of observation vector

    • dim_obs_lint

      • local dimension of observation vector

    Callback Returns
    • dim_obs_lint

      • local dimension of observation vector

  • py__likelihood_l_pdaf (Callable[domain_p:int, step:int, dim_obs_l:int, obs_l : ndarray[tuple[dim_obs_l], np.float64], resid_l : ndarray[tuple[dim_obs_l], np.float64], likely_l:float]) –

    Compute likelihood and apply localization

    Callback Parameters
    • domain_pint

      • Index of current local analysis domain

    • stepint

      • Current time step

    • dim_obs_lint

      • Number of local observations at current time step (i.e. the size of the local observation vector)

    • obs_lndarray[tuple[dim_obs_l], np.float64]

      • Local vector of observations

    • resid_lndarray[tuple[dim_obs_l], np.float64]

      • nput vector holding the local residual

    • likely_lfloat

      • Output value of the local likelihood

    Callback Returns
    • likely_lfloat

      • Output value of the local likelihood

  • py__next_observation_pdaf (Callable[stepnow:int, nsteps:int, doexit:int, time:float]) –

    Provide time step, time and dimension of next observation

    Callback Parameters
    • stepnowint

      • number of the current time step

    • nstepsint

      • number of time steps until next obs

    • doexitint

      • whether to exit forecasting (1 for exit)

    • timefloat

      • current model (physical) time

    Callback Returns
    • nstepsint

      • number of time steps until next obs

    • doexitint

      • whether to exit forecasting (1 for exit)

    • timefloat

      • current model (physical) time

  • outflag (int) – Status flag

Returns:

outflag – Status flag

Return type:

int