PetscDAEnsembleForecastFn#

A prototype of an ensemble forecast model callback passed to PetscDAEnsembleForecast()

Synopsis#

PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PetscDAEnsembleForecastFn(Mat ensemble, PetscCtx ctx);

Calling Sequence#

  • ensemble - ensemble matrix advanced in place; on entry its columns are the current members, on return its columns are the members at the next time

  • ctx - [optional] user-defined model context

Note#

Per-member integrators that read and overwrite each column (the common case, e.g. a TS-driven step) iterate with MatDenseGetColumnVec() / MatDenseRestoreColumnVec(). Use the read-only or write-only variants (MatDenseGetColumnVecRead() / MatDenseGetColumnVecWrite()) only when the kernel truly does not need the other half (e.g. a write-only resampler).

See Also#

PetscDA: Data Assimilation, PetscDA, PETSCDALETKF, PetscDAEnsembleForecast()

Level#

intermediate

Location#

include/petscda.h


Index of all PetscDA routines
Table of Contents for all manual pages
Index of all manual pages