2 Copyright (C) 2008-2023 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]** Reference description of the ADAO commands and keywords
28 ================================================================================
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`.
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.
46 .. _section_reference_entry:
48 ================================================================================
49 **[DocR]** General entries and outputs
50 ================================================================================
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`.
60 ref_options_AlgorithmParameters
63 .. _section_reference_special_entry:
65 ============================================================================================
66 **[DocR]** Special entries: measurements, functions, matrices, "*observer*", post-processing
67 ============================================================================================
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`.
76 ref_observations_requirements
77 ref_operator_requirements
78 ref_covariance_requirements
79 ref_sampling_requirements
80 ref_observers_requirements
81 ref_userpostanalysis_requirements
83 .. _section_reference_assimilation:
85 ================================================================================
86 **[DocR]** Data assimilation or optimization calculation cases
87 ================================================================================
89 This section describes algorithmic choices to use data assimilation methods,
90 optimization methods or methods with reduction, available in ADAO, detailing
91 their characteristics and their options.
93 Some examples on these commands usage are available in the section of
94 :ref:`section_tutorials_in_salome`, in the section of
95 :ref:`section_tutorials_in_python`, in the section of
96 :ref:`section_docu_examples`, and in the sample files installed with ADAO. The
97 mathematical concepts and notations used are explained in the general section
98 providing :ref:`section_theory`.
106 ref_algorithm_DerivativeFreeOptimization
107 ref_algorithm_DifferentialEvolution
108 ref_algorithm_EnsembleBlue
109 ref_algorithm_EnsembleKalmanFilter
110 ref_algorithm_ExtendedBlue
111 ref_algorithm_ExtendedKalmanFilter
112 ref_algorithm_KalmanFilter
113 ref_algorithm_LinearLeastSquares
114 ref_algorithm_NonLinearLeastSquares
115 ref_algorithm_ParticleSwarmOptimization
116 ref_algorithm_QuantileRegression
117 ref_algorithm_TabuSearch
118 ref_algorithm_UnscentedKalmanFilter
119 ref_assimilation_keywords
121 .. _section_reference_checking:
123 ================================================================================
124 **[DocR]** Checking cases
125 ================================================================================
127 This section describes the checking algorithms available in ADAO, detailing
128 their usage characteristics and their options.
130 Some examples on these commands usage are available in the section of
131 :ref:`section_tutorials_in_salome`, in the section of
132 :ref:`section_tutorials_in_python`, in the section of
133 :ref:`section_docu_examples`, and in the sample files installed with ADAO. The
134 mathematical concepts and notations used are explained in the general section
135 providing :ref:`section_theory`.
140 ref_algorithm_AdjointTest
141 ref_algorithm_ControledFunctionTest
142 ref_algorithm_FunctionTest
143 ref_algorithm_GradientTest
144 ref_algorithm_InputValuesTest
145 ref_algorithm_LinearityTest
146 ref_algorithm_LocalSensitivityTest
147 ref_algorithm_ObservationSimulationComparisonTest
148 ref_algorithm_ObserverTest
149 ref_algorithm_ParallelFunctionTest
150 ref_algorithm_SamplingTest
151 ref_algorithm_TangentTest
152 ref_checking_keywords
154 .. _section_reference_task:
156 ================================================================================
157 **[DocR]** Dedicated tasks or study oriented cases
158 ================================================================================
160 This section describes the dedicated task or study oriented cases available in
161 ADAO, detailing their usage characteristics and their options.
163 These tasks use algorithms from data assimilation methods, optimization methods
164 or methods with reduction. We refer to the general section providing
165 :ref:`section_theory` section and to the :ref:`section_reference_assimilation`
166 section for the underlying algorithmic details.
171 ref_algorithm_EnsembleOfSimulationGenerationTask
172 ref_algorithm_InterpolationByReducedModelTask
173 ref_algorithm_MeasurementsOptimalPositioningTask