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: Debug
  34 .. index:: single: ObservationOperator
  35 .. index:: single: Observer
  36 .. index:: single: Observers
  37 .. index:: single: Observer Template
  38 .. index:: single: Study_name
  39 .. index:: single: Study_repertory
  40 .. index:: single: UserDataInit
  41
  42 This set of commands is related to the description of a checking case, that is a
  43 procedure to check required properties on information, used somewhere else by a
  44 calculation case. The terms are ordered in alphabetical order, except the first,
  45 which describes the choice between calculation or checking.
  46
  47 The different commands are the following:
  48
  49   **CHECKING_STUDY**
  50     *Required command*. This is the general command describing the checking
  51     case. It hierarchically contains all the other commands.
  52
  53   Algorithm
  54     *Required command*. This is a string to indicate the checking algorithm chosen.
  55     The choices are limited and available through the GUI. There exists for
  56     example "FunctionTest", "AdjointTest"... See below the list of algorithms
  57     and associated parameters, each described by a subsection.
  58
  59   AlgorithmParameters
  60     *Optional command*. This command allows to add some optional parameters to
  61     control the data assimilation or optimization algorithm. Its value is
  62     defined as a "*Dict*" type object. See the section
  63     :ref:`section_ref_options_AlgorithmParameters` for for the correct use of
  64     this command.
  65
  66   CheckingPoint
  67     *Required command*. This indicates the vector used as the state around which
  68     to perform the required check, noted :math:`\mathbf{x}` and similar to the
  69     background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" type object.
  70
  71   Debug
  72     *Optional command*. This define the level of trace and intermediary debug
  73     information. The choices are limited between 0 (for False) and 1 (for
  74     True).
  75
  76   ObservationOperator
  77     *Required command*. This indicates the observation operator, previously
  78     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
  79     results :math:`\mathbf{y}` to be compared to observations
  80     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
  81     a "*Matrix*" type one. In the case of "*Function*" type, different
  82     functional forms can be used, as described in the section
  83     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
  84     included in the observation, the operator has to be applied to a pair
  85     :math:`(X,U)`.
  86
  87   Observers
  88     *Optional command*. This command allows to set internal observers, that are
  89     functions linked with a particular variable, which will be executed each
  90     time this variable is modified. It is a convenient way to monitor variables
  91     of interest during the data assimilation or optimization process, by
  92     printing or plotting it, etc. Common templates are provided to help the user
  93     to start or to quickly make his case.
  94
  95   Study_name
  96     *Required command*. This is an open string to describe the ADAO study by a
  97     name or a sentence.
  98
  99   Study_repertory
 100     *Optional command*. If available, this directory is used as base name for
 101     calculation, and used to find all the script files, given by name without
 102     path, that can be used to define some other commands by scripts.
 103
 104   UserDataInit
 105     *Optional command*. This commands allows to initialize some parameters or
 106     data automatically before algorithm input processing. It indicates a script
 107     file name to be executed before entering in initialization phase of chosen
 108     variables.