doc/en/ref_checking_keywords.rst

   1 ..
   2    Copyright (C) 2008-2014 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: CHECKING_STUDY
  25 .. _section_ref_checking_keywords:
  26
  27 List of commands and keywords for an ADAO checking case
  28 -------------------------------------------------------
  29
  30 .. index:: single: Algorithm
  31 .. index:: single: AlgorithmParameters
  32 .. index:: single: CheckingPoint
  33 .. index:: single: BackgroundError
  34 .. index:: single: Debug
  35 .. index:: single: Observation
  36 .. index:: single: ObservationError
  37 .. index:: single: ObservationOperator
  38 .. index:: single: Observer
  39 .. index:: single: Observers
  40 .. index:: single: Observer Template
  41 .. index:: single: Study_name
  42 .. index:: single: Study_repertory
  43 .. index:: single: UserDataInit
  44
  45 This set of commands is related to the description of a checking case, that is a
  46 procedure to check required properties on information, used somewhere else by a
  47 calculation case. The terms are ordered in alphabetical order, except the first,
  48 which describes the choice between calculation or checking.
  49
  50 The different commands are the following:
  51
  52   **CHECKING_STUDY**
  53     *Required command*. This is the general command describing the checking
  54     case. It hierarchically contains all the other commands.
  55
  56   Algorithm
  57     *Required command*. This is a string to indicate the checking algorithm chosen.
  58     The choices are limited and available through the GUI. There exists for
  59     example "FunctionTest", "AdjointTest"... See below the list of algorithms
  60     and associated parameters, each described by a subsection.
  61
  62   AlgorithmParameters
  63     *Optional command*. This command allows to add some optional parameters to
  64     control the data assimilation or optimization algorithm. Its value is
  65     defined as a "*Dict*" type object. See the section
  66     :ref:`section_ref_options_AlgorithmParameters` for for the correct use of
  67     this command.
  68
  69   CheckingPoint
  70     *Required command*. This indicates the vector used as the state around which
  71     to perform the required check, noted :math:`\mathbf{x}` and similar to the
  72     background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" type object.
  73
  74   BackgroundError
  75     *Required command*. This indicates the background error covariance matrix,
  76     previously noted as :math:`\mathbf{B}`. Its value is defined as a "*Matrix*"
  77     type object, a "*ScalarSparseMatrix*" type object, or a
  78     "*DiagonalSparseMatrix*" type object.
  79
  80   Debug
  81     *Optional command*. This define the level of trace and intermediary debug
  82     information. The choices are limited between 0 (for False) and 1 (for
  83     True).
  84
  85   Observation
  86     *Required command*. This indicates the observation vector used for data
  87     assimilation or optimization, previously noted as :math:`\mathbf{y}^o`. It
  88     is defined as a "*Vector*" or a *VectorSerie* type object.
  89
  90   ObservationError
  91     *Required command*. This indicates the observation error covariance matrix,
  92     previously noted as :math:`\mathbf{R}`. It is defined as a "*Matrix*" type
  93     object, a "*ScalarSparseMatrix*" type object, or a "*DiagonalSparseMatrix*"
  94     type object.
  95
  96   ObservationOperator
  97     *Required command*. This indicates the observation operator, previously
  98     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
  99     results :math:`\mathbf{y}` to be compared to observations
 100     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
 101     a "*Matrix*" type one. In the case of "*Function*" type, different
 102     functional forms can be used, as described in the section
 103     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
 104     included in the observation, the operator has to be applied to a pair
 105     :math:`(X,U)`.
 106
 107   Observers
 108     *Optional command*. This command allows to set internal observers, that are
 109     functions linked with a particular variable, which will be executed each
 110     time this variable is modified. It is a convenient way to monitor variables
 111     of interest during the data assimilation or optimization process, by
 112     printing or plotting it, etc. Common templates are provided to help the user
 113     to start or to quickly make his case.
 114
 115   Study_name
 116     *Required command*. This is an open string to describe the ADAO study by a
 117     name or a sentence.
 118
 119   Study_repertory
 120     *Optional command*. If available, this directory is used as base name for
 121     calculation, and used to find all the script files, given by name without
 122     path, that can be used to define some other commands by scripts.
 123
 124   UserDataInit
 125     *Optional command*. This commands allows to initialize some parameters or
 126     data automatically before algorithm input processing. It indicates a script
 127     file name to be executed before entering in initialization phase of chosen
 128     variables.