2 Copyright (C) 2008-2020 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. _section_reference:
26 ================================================================================
27 **[DocR]** Description de référence des commandes et mots-clés ADAO
28 ================================================================================
30 Les sections suivantes présentent la description de référence des commandes et
31 mots-clés ADAO disponibles à travers l'interface textuelle (TUI), graphique
32 (GUI) ou à travers des scripts. Les deux premières sections communes présentent
33 les :ref:`section_reference_entry` et les
34 :ref:`section_reference_special_entry`. Ensuite, on décrit successivement les
35 :ref:`section_reference_assimilation` et les :ref:`section_reference_checking`.
37 Chaque commande ou mot-clé à définir par la TUI ou la GUI a des propriétés
38 particulières. La première propriété est d'être *requise*, *optionnelle* ou
39 simplement utile, décrivant un type d'entrée. La seconde propriété est d'être
40 une variable "ouverte" avec un type fixé mais avec n'importe quelle valeur
41 autorisée par le type, ou une variable "fermée", limitée à des valeurs
42 spécifiées. L'éditeur graphique GUI intégré disposant de capacités intrinsèques
43 de validation, les propriétés des commandes ou mots-clés données à l'aide de
44 l'interface graphique sont automatiquement correctes.
46 .. _section_reference_entry:
48 ========================================================================================
49 **[DocR]** Entrées et sorties générales
50 ========================================================================================
52 Cette section décrit de manière générale les différentes possibilités de types
53 d'entrées et de variables de sortie que l'on peut utiliser. Les notations
54 mathématiques utilisées sont expliquées dans la section :ref:`section_theory`.
60 ref_options_AlgorithmParameters
63 .. _section_reference_special_entry:
65 ========================================================================================
66 **[DocR]** Entrées spéciales : fonctions, matrices, "*observer*"
67 ========================================================================================
69 Cette section décrit les entrées spéciales, comme les formes fonctionnelles ou
70 matricielles, que l'on peut utiliser. Les notations mathématiques utilisées
71 sont expliquées dans la section :ref:`section_theory`.
76 ref_operator_requirements
77 ref_covariance_requirements
78 ref_observers_requirements
80 .. _section_reference_assimilation:
82 ============================================================================================
83 **[DocR]** Cas d'assimilation de données ou d'optimisation
84 ============================================================================================
86 Cette section décrit les algorithmes d'assimilation de données ou
87 d'optimisation disponibles dans ADAO, détaillant leurs caractéristiques
88 d'utilisation et leurs options.
90 Des exemples sur l'usage de ces commandes sont disponibles dans la section
91 :ref:`section_tutorials_in_salome`, dans la section
92 :ref:`section_tutorials_in_python` et dans les fichiers d'exemple installés
93 avec ADAO. Les notations mathématiques utilisées sont expliquées dans la
94 section :ref:`section_theory`.
102 ref_algorithm_DerivativeFreeOptimization
103 ref_algorithm_DifferentialEvolution
104 ref_algorithm_EnsembleBlue
105 ref_algorithm_EnsembleKalmanFilter
106 ref_algorithm_ExtendedBlue
107 ref_algorithm_ExtendedKalmanFilter
108 ref_algorithm_KalmanFilter
109 ref_algorithm_LinearLeastSquares
110 ref_algorithm_NonLinearLeastSquares
111 ref_algorithm_ParticleSwarmOptimization
112 ref_algorithm_QuantileRegression
113 ref_algorithm_TabuSearch
114 ref_algorithm_UnscentedKalmanFilter
115 ref_assimilation_keywords
117 .. _section_reference_checking:
119 ================================================================================
120 **[DocR]** Cas de vérification
121 ================================================================================
123 Cette section décrit les algorithmes de vérification disponibles dans ADAO,
124 détaillant leurs caractéristiques d'utilisation et leurs options.
126 Des exemples sur l'usage de ces commandes sont disponibles dans la section
127 :ref:`section_tutorials_in_salome`, dans la section
128 :ref:`section_tutorials_in_python` et dans les fichiers d'exemple installés
129 avec ADAO. Les notations mathématiques utilisées sont expliquées dans la
130 section :ref:`section_theory`.
135 ref_algorithm_AdjointTest
136 ref_algorithm_FunctionTest
137 ref_algorithm_GradientTest
138 ref_algorithm_InputValuesTest
139 ref_algorithm_LinearityTest
140 ref_algorithm_LocalSensitivityTest
141 ref_algorithm_ObserverTest
142 ref_algorithm_ParallelFunctionTest
143 ref_algorithm_SamplingTest
144 ref_algorithm_TangentTest
145 ref_checking_keywords