doc/en/reference.rst

   1 ..
   2    Copyright (C) 2008-2015 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 .. _section_reference:
  25
  26 ================================================================================
  27 **[DocR]** Reference description of the ADAO commands and keywords
  28 ================================================================================
  29
  30 The following sections present the reference description of the ADAO commands
  31 and keywords available through the GUI or through scripts. A first common
  32 section presents in general the :ref:`section_reference_entry`. After that, one
  33 describes successively the :ref:`section_reference_assimilation` and the
  34 :ref:`section_reference_checking`.
  35
  36 Each command or keyword to be defined through the ADAO GUI has some properties.
  37 The first property is to be *required*, *optional* or only factual, describing a
  38 type of input. The second property is to be an "open" variable with a fixed type
  39 but with any value allowed by the type, or a "restricted" variable, limited to
  40 some specified values. The embedded case editor GUI having build-in validating
  41 capacities, the properties of the commands or keywords given through this GUI
  42 are automatically correct.
  43
  44 .. _section_reference_entry:
  45
  46 ========================================================================================
  47 **[DocR]** General entries and outputs, functions and matrices
  48 ========================================================================================
  49
  50 This section describes in general the different possibilities of entry types and
  51 output variables, and the functional or matrix forms that can be used. The
  52 mathematical notations used afterwards are explained in the section
  53 :ref:`section_theory`.
  54
  55 .. toctree::
  56    :maxdepth: 1
  57
  58    ref_entry_types
  59    ref_options_AlgorithmParameters
  60    ref_operator_requirements
  61    ref_covariance_requirements
  62    ref_output_variables
  63
  64 .. _section_reference_assimilation:
  65
  66 ============================================================================================
  67 **[DocR]** Data assimilation or optimization calculation cases
  68 ============================================================================================
  69
  70 This section describes the data assimilation or optimization algorithms
  71 available in ADAO, detailing their usage characteristics and their options.
  72
  73 Some examples on these commands usage are available in the section
  74 :ref:`section_examples` and in the sample files installed with the ADAO module.
  75 The mathematical notations used afterward are explained in the section
  76 :ref:`section_theory`.
  77
  78 .. toctree::
  79    :maxdepth: 1
  80
  81    ref_assimilation_keywords
  82    ref_algorithm_3DVAR
  83    ref_algorithm_Blue
  84    ref_algorithm_EnsembleBlue
  85    ref_algorithm_ExtendedBlue
  86    ref_algorithm_ExtendedKalmanFilter
  87    ref_algorithm_KalmanFilter
  88    ref_algorithm_LinearLeastSquares
  89    ref_algorithm_NonLinearLeastSquares
  90    ref_algorithm_ParticleSwarmOptimization
  91    ref_algorithm_QuantileRegression
  92    ref_algorithm_UnscentedKalmanFilter
  93
  94 .. _section_reference_checking:
  95
  96 ================================================================================
  97 **[DocR]** Checking cases
  98 ================================================================================
  99
 100 This section describes the checking algorithms available in ADAO, detailing
 101 their usage characteristics and their options.
 102
 103 Some examples on these commands usage are available in the section
 104 :ref:`section_examples` and in the sample files installed with the ADAO module.
 105 The mathematical notations used afterward are explained in the section
 106 :ref:`section_theory`.
 107
 108 .. toctree::
 109    :maxdepth: 1
 110
 111    ref_checking_keywords
 112    ref_algorithm_AdjointTest
 113    ref_algorithm_FunctionTest
 114    ref_algorithm_GradientTest
 115    ref_algorithm_LinearityTest
 116    ref_algorithm_ObserverTest
 117    ref_algorithm_SamplingTest
 118    ref_algorithm_TangentTest