doc/en/reference.rst

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