2 Copyright (C) 2008-2015 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 graphique (GUI) ou à travers
32 des scripts. Une première section commune présente de manière générale les
33 :ref:`section_reference_entry`. Ensuite, on décrit successivement les
34 :ref:`section_reference_assimilation` et les :ref:`section_reference_checking`.
36 Chaque commande ou mot-clé à définir par l'interface graphique (GUI) a des
37 propriétés particulières. La première propriété est d'être *requise*,
38 *optionnelle* ou simplement utile, décrivant un type d'entrée. La seconde
39 propriété est d'être une variable "ouverte" avec un type fixé mais avec
40 n'importe quelle valeur autorisée par le type, ou une variable "fermée", limitée
41 à des valeurs spécifiées. L'éditeur graphique intégré disposant de capacités
42 intrinsèques de validation, les propriétés des commandes ou mots-clés données à
43 l'aide de l'interface graphique sont automatiquement correctes.
45 .. _section_reference_entry:
47 ========================================================================================
48 **[DocR]** Entrées et sorties générales, fonctions et matrices
49 ========================================================================================
51 Cette section décrit de manière générale les différentes possibilités de types
52 d'entrées et de variables de sortie, et les formes fonctionnelles ou
53 matricielles que l'on peut utiliser. Les notations mathématiques utilisées sont
54 expliquées dans la section :ref:`section_theory`.
60 ref_options_AlgorithmParameters
61 ref_operator_requirements
62 ref_covariance_requirements
65 .. _section_reference_assimilation:
67 ============================================================================================
68 **[DocR]** Cas d'assimilation de données ou d'optimisation
69 ============================================================================================
71 Cette section décrit les algorithmes d'assimilation de données ou d'optimisation
72 disponibles dans ADAO, détaillant leurs caractéristiques d'utilisation et leurs
75 Des exemples sur l'usage de ces commandes sont disponibles dans la section
76 :ref:`section_examples` et dans les fichiers d'exemple installés avec le module
77 ADAO. Les notations mathématiques utilisées sont expliquées dans la section
78 :ref:`section_theory`.
83 ref_assimilation_keywords
86 ref_algorithm_EnsembleBlue
87 ref_algorithm_ExtendedBlue
88 ref_algorithm_ExtendedKalmanFilter
89 ref_algorithm_KalmanFilter
90 ref_algorithm_LinearLeastSquares
91 ref_algorithm_NonLinearLeastSquares
92 ref_algorithm_ParticleSwarmOptimization
93 ref_algorithm_QuantileRegression
94 ref_algorithm_UnscentedKalmanFilter
96 .. _section_reference_checking:
98 ================================================================================
99 **[DocR]** Cas de vérification
100 ================================================================================
102 Cette section décrit les algorithmes de vérification disponibles dans ADAO,
103 détaillant leurs caractéristiques d'utilisation et leurs options.
105 Des exemples sur l'usage de ces commandes sont disponibles dans la section
106 :ref:`section_examples` et dans les fichiers d'exemple installés avec le module
107 ADAO. Les notations mathématiques utilisées sont expliquées dans la section
108 :ref:`section_theory`.
113 ref_checking_keywords
114 ref_algorithm_AdjointTest
115 ref_algorithm_FunctionTest
116 ref_algorithm_GradientTest
117 ref_algorithm_LinearityTest
118 ref_algorithm_ObserverTest
119 ref_algorithm_SamplingTest
120 ref_algorithm_TangentTest