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]** 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 GUI or through scripts. A first common
32 section presents in general the :ref:`section_reference_entry`. After that, one
33 describes successively the :ref:`section_reference_assimilation` and the
34 :ref:`section_reference_checking`.
36 Each command or keyword to be defined through the ADAO GUI has some properties.
37 The first property is to be *required*, *optional* or only factual, describing a
38 type of input. The second property is to be an "open" variable with a fixed type
39 but with any value allowed by the type, or a "restricted" variable, limited to
40 some specified values. The EFICAS editor GUI having build-in validating
41 capacities, the properties of the commands or keywords given through this GUI
42 are automatically correct.
44 .. _section_reference_entry:
46 ========================================================================================
47 **[DocR]** General entries and outputs, functions and matrices
48 ========================================================================================
50 This section describes in general the different possibilities of entry types and
51 output variables, and the functional or matrix forms that can be used. The
52 mathematical notations used afterwards are explained in the section
53 :ref:`section_theory`.
59 ref_options_AlgorithmParameters
60 ref_operator_requirements
61 ref_covariance_requirements
64 .. _section_reference_assimilation:
66 ============================================================================================
67 **[DocR]** Data assimilation or optimization calculation cases
68 ============================================================================================
70 This section describes the data assimilation or optimization algorithms
71 available in ADAO, detailing their usage characteristics and their options.
73 Some examples on these commands usage are available in the section
74 :ref:`section_examples` and in the sample files installed with the ADAO module.
75 The mathematical notations used afterward are explained in the section
76 :ref:`section_theory`.
81 ref_assimilation_keywords
83 ref_algorithm_LinearLeastSquares
84 ref_algorithm_NonLinearLeastSquares
86 ref_algorithm_ExtendedBlue
87 ref_algorithm_EnsembleBlue
88 ref_algorithm_KalmanFilter
89 ref_algorithm_ExtendedKalmanFilter
90 ref_algorithm_UnscentedKalmanFilter
91 ref_algorithm_ParticleSwarmOptimization
92 ref_algorithm_QuantileRegression
94 .. _section_reference_checking:
96 ================================================================================
97 **[DocR]** Checking cases
98 ================================================================================
100 This section describes the checking algorithms available in ADAO, detailing
101 their usage characteristics and their options.
103 Some examples on these commands usage are available in the section
104 :ref:`section_examples` and in the sample files installed with the ADAO module.
105 The mathematical notations used afterward are explained in the section
106 :ref:`section_theory`.
111 ref_checking_keywords
112 ref_algorithm_AdjointTest
113 ref_algorithm_FunctionTest
114 ref_algorithm_GradientTest
115 ref_algorithm_LinearityTest
116 ref_algorithm_ObserverTest
117 ref_algorithm_TangentTest
118 ref_algorithm_SamplingTest