doc/en/reference.rst

   1 ..
   2    Copyright (C) 2008-2023 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 textual interface (TUI), the graphical
  32 interface (GUI) or through scripts. Two first common sections present the
  33 :ref:`section_reference_entry` and the :ref:`section_reference_special_entry`.
  34 After that, one describes successively the
  35 :ref:`section_reference_assimilation` and the
  36 :ref:`section_reference_checking`.
  37
  38 Each command or keyword to be defined through the ADAO TUI or GUI has some
  39 properties. The first property is to be *required*, *optional* or only factual,
  40 describing a type of input. The second property is to be an "open" variable
  41 with a fixed type but with any value allowed by the type, or a "restricted"
  42 variable, limited to some specified values. The embedded case editor GUI having
  43 build-in validating capacities, the properties of the commands or keywords
  44 given through this interface are automatically correct.
  45
  46 .. _section_reference_entry:
  47
  48 ================================================================================
  49 **[DocR]** General entries and outputs
  50 ================================================================================
  51
  52 This section describes in a very general way the different options of input
  53 types and output variables. The mathematical notations used are explained in
  54 section :ref:`section_theory`.
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    ref_entry_types
  60    ref_options_AlgorithmParameters
  61    ref_output_variables
  62
  63 .. _section_reference_special_entry:
  64
  65 ============================================================================================
  66 **[DocR]** Special entries: measurements, functions, matrices, "*observer*", post-processing
  67 ============================================================================================
  68
  69 This section describes special inputs, such as functional or matrix forms, and
  70 the requirements for using them. The mathematical concepts and notations
  71 related to these inputs are explained in section :ref:`section_theory`.
  72
  73 .. toctree::
  74    :maxdepth: 1
  75
  76    ref_observations_requirements
  77    ref_operator_requirements
  78    ref_covariance_requirements
  79    ref_observers_requirements
  80    ref_userpostanalysis_requirements
  81
  82 .. _section_reference_assimilation:
  83
  84 ================================================================================
  85 **[DocR]** Data assimilation or optimization calculation cases
  86 ================================================================================
  87
  88 This section describes algorithmic choices to use data assimilation methods,
  89 optimization methods or methods with reduction, available in ADAO, detailing
  90 their characteristics and their options.
  91
  92 Some examples on these commands usage are available in the section of
  93 :ref:`section_tutorials_in_salome`, in the section of
  94 :ref:`section_tutorials_in_python`, in the section of
  95 :ref:`section_docu_examples`, and in the sample files installed with ADAO. The
  96 mathematical concepts and notations used are explained in the general section
  97 providing :ref:`section_theory`.
  98
  99 .. toctree::
 100    :maxdepth: 1
 101
 102    ref_algorithm_3DVAR
 103    ref_algorithm_4DVAR
 104    ref_algorithm_Blue
 105    ref_algorithm_DerivativeFreeOptimization
 106    ref_algorithm_DifferentialEvolution
 107    ref_algorithm_EnsembleBlue
 108    ref_algorithm_EnsembleKalmanFilter
 109    ref_algorithm_ExtendedBlue
 110    ref_algorithm_ExtendedKalmanFilter
 111    ref_algorithm_KalmanFilter
 112    ref_algorithm_LinearLeastSquares
 113    ref_algorithm_NonLinearLeastSquares
 114    ref_algorithm_ParticleSwarmOptimization
 115    ref_algorithm_QuantileRegression
 116    ref_algorithm_TabuSearch
 117    ref_algorithm_UnscentedKalmanFilter
 118    ref_assimilation_keywords
 119
 120 .. _section_reference_checking:
 121
 122 ================================================================================
 123 **[DocR]** Checking cases
 124 ================================================================================
 125
 126 This section describes the checking algorithms available in ADAO, detailing
 127 their usage characteristics and their options.
 128
 129 Some examples on these commands usage are available in the section of
 130 :ref:`section_tutorials_in_salome`, in the section of
 131 :ref:`section_tutorials_in_python`, in the section of
 132 :ref:`section_docu_examples`, and in the sample files installed with ADAO. The
 133 mathematical concepts and notations used are explained in the general section
 134 providing :ref:`section_theory`.
 135
 136 .. toctree::
 137    :maxdepth: 1
 138
 139    ref_algorithm_AdjointTest
 140    ref_algorithm_ControledFunctionTest
 141    ref_algorithm_FunctionTest
 142    ref_algorithm_GradientTest
 143    ref_algorithm_InputValuesTest
 144    ref_algorithm_LinearityTest
 145    ref_algorithm_LocalSensitivityTest
 146    ref_algorithm_ObservationSimulationComparisonTest
 147    ref_algorithm_ObserverTest
 148    ref_algorithm_ParallelFunctionTest
 149    ref_algorithm_SamplingTest
 150    ref_algorithm_TangentTest
 151    ref_checking_keywords
 152
 153 .. _section_reference_task:
 154
 155 ================================================================================
 156 **[DocR]** Dedicated tasks or study oriented cases
 157 ================================================================================
 158
 159 This section describes the dedicated task or study oriented cases available in
 160 ADAO, detailing their usage characteristics and their options.
 161
 162 These tasks use algorithms from data assimilation methods, optimization methods
 163 or methods with reduction. We refer to the general section providing
 164 :ref:`section_theory` section and to the :ref:`section_reference_assimilation`
 165 section for the underlying algorithmic details.
 166
 167 .. toctree::
 168    :maxdepth: 1
 169
 170    ref_algorithm_EnsembleOfSimulationGenerationTask
 171    ref_algorithm_InterpolationByReducedModelTask
 172    ref_algorithm_MeasurementsOptimalPositioningTask
 173    ref_task_keywords