! Copyright (c) 2004-2024 Lars Nerger ! ! 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_estkf_options --- Information output on options for ESTKF ! ! !INTERFACE: SUBROUTINE PDAF_estkf_options() ! !DESCRIPTION: ! Subroutine to perform information output on options ! available for the ESTKF. ! ! This is a core routine of PDAF and ! should not be changed by the user ! ! ! !REVISION HISTORY: ! 2011-09 - Lars Nerger - Initial code ! Later revisions - see svn log ! ! !USES: IMPLICIT NONE ! !CALLING SEQUENCE: ! Called by: PDAF_options_filters !EOP WRITE(*, '(/a, 5x, a)') 'PDAF', '+++++++++++++++++++++++++++++++++++++++++++++++++++++++' WRITE(*, '(a, 5x, a)') 'PDAF', '+++ Error Subspace Transform Kalman Filter (ESTKF) +++' WRITE(*, '(a, 5x, a)') 'PDAF', '+++ +++' WRITE(*, '(a, 5x, a)') 'PDAF', '+++ Nerger et al., Mon. Wea. Rev. 140 (2012) 2335 +++' WRITE(*, '(a, 5x, a)') 'PDAF', '+++ doi:10.1175/MWR-D-11-00102.1 +++' WRITE(*, '(a, 5x, a)') 'PDAF', '+++++++++++++++++++++++++++++++++++++++++++++++++++++++' WRITE(*, '(/a, 5x, a)') 'PDAF', 'Available options for ESTKF:' WRITE(*, '(a, 5x, a)') 'PDAF', '--- Sub-types (Parameter subtype) ---' WRITE(*, '(a, 7x, a)') 'PDAF', '0: Standard implementation with ensemble integration' WRITE(*, '(a, 7x, a)') 'PDAF', '2: Fixed error space basis' WRITE(*, '(a, 7x, a)') 'PDAF', '3: Fixed state covariance matrix' WRITE(*, '(a, 7x, a)') 'PDAF', '5: Offline mode (deprecated, use PDAF_set_offline_mode)' WRITE(*, '(a, 5x, a)') 'PDAF', '--- Integer parameters (Array param_int) ---' WRITE(*, '(a, 7x, a)') 'PDAF', 'param_int(1): Dimension of state vector (>0), required' WRITE(*, '(a, 7x, a)') 'PDAF', 'param_int(2): Ensemble size (>0), required' WRITE(*, '(a, 7x, a)') 'PDAF', 'param_int(3): Size of smoothing lag (>=0), optional' WRITE(*, '(a, 11x, a)') 'PDAF', '0: no smoothing (default)' WRITE(*, '(a, 11x, a)') 'PDAF', '>0: apply smoother up to specified lag' WRITE(*, '(a, 7x, a)') & 'PDAF', 'param_int(4): not used' WRITE(*, '(a, 7x, a)') & 'PDAF', 'param_int(5): Type of forgetting factor; optional' WRITE(*, '(a, 11x, a)') 'PDAF', '0: fixed forgetting factor (default)' WRITE(*, '(a, 11x, a)') 'PDAF', '1: adaptive forgetting factor (experimental)' WRITE(*, '(a, 7x, a)') & 'PDAF', 'param_int(6): Type of ensemble transformation matrix; optional' WRITE(*, '(a, 11x, a)') 'PDAF', '0: deterministic Omega (default)' WRITE(*, '(a, 11x, a)') 'PDAF', '1: random orthonormal Omega orthogonal to (1,...,1)^T' WRITE(*, '(a, 11x, a)') & 'PDAF', '2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T' WRITE(*, '(a, 14x, a)') & 'PDAF', '(experimental; for random transformations, 0 or 1 are recommended)' WRITE(*, '(a, 7x, a)') & 'PDAF', 'param_int(7): Type of transformation matrix square root; optional' WRITE(*, '(a, 11x, a)') 'PDAF', '0: symmetric square root (default)' WRITE(*, '(a, 11x, a)') 'PDAF', '1: Cholesky decomposition' WRITE(*, '(a, 7x, a)') & 'PDAF', 'param_int(8): Application of observation operator H' WRITE(*, '(a, 11x, a)') 'PDAF', '0: Apply H to ensemble mean to compute residual (default)' WRITE(*, '(a, 11x, a)') 'PDAF', '1: Apply H to all ensemble states; then compute residual from mean of these' WRITE(*, '(a, 11x, a)') 'PDAF', ' param_int(8)=1 is the recomended choice for nonlinear H' WRITE(*, '(a, 5x, a)') 'PDAF', '--- Floating point parameters (Array param_real) ---' WRITE(*, '(a, 7x, a)') & 'PDAF', 'param_real(1): Forgetting factor (usually >0 and <=1), required' WRITE(*, '(a, 5x, a)') 'PDAF', '--- Further parameters ---' WRITE(*, '(a, 7x, a)') 'PDAF', 'n_modeltasks: Number of parallel model integration tasks' WRITE(*, '(a, 11x, a)') & 'PDAF', '>=1 for subtypes 0 and 1; not larger than total number of processors' WRITE(*, '(a, 11x, a)') 'PDAF', '=1 required for subtypes 2 and 3' WRITE(*, '(a, 7x, a)') 'PDAF', 'screen: Control verbosity of PDAF' WRITE(*, '(a, 11x, a)') 'PDAF', '0: no outputs' WRITE(*, '(a, 11x, a)') 'PDAF', '1: basic output (default)' WRITE(*, '(a, 11x, a)') 'PDAF', '2: 1 plus timing output' WRITE(*, '(a, 11x, a)') 'PDAF', '3: 2 plus debug output' WRITE(*, '(a, 5x, a)') & 'PDAF', '+++++++++ End of option overview for the ESTKF ++++++++++' END SUBROUTINE PDAF_estkf_options