]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documentation and source improvements
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Fri, 8 May 2015 15:59:07 +0000 (17:59 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sat, 9 May 2015 06:32:20 +0000 (08:32 +0200)
34 files changed:
doc/en/ref_algorithm_3DVAR.rst
doc/en/ref_algorithm_Blue.rst
doc/en/ref_algorithm_EnsembleBlue.rst
doc/en/ref_algorithm_ExtendedBlue.rst
doc/en/ref_algorithm_ExtendedKalmanFilter.rst
doc/en/ref_algorithm_KalmanFilter.rst
doc/en/ref_algorithm_LinearLeastSquares.rst
doc/en/ref_algorithm_NonLinearLeastSquares.rst
doc/en/ref_algorithm_ParticleSwarmOptimization.rst
doc/en/ref_algorithm_QuantileRegression.rst
doc/en/ref_algorithm_SamplingTest.rst
doc/en/ref_algorithm_UnscentedKalmanFilter.rst
doc/en/reference.rst
doc/fr/ref_algorithm_3DVAR.rst
doc/fr/ref_algorithm_Blue.rst
doc/fr/ref_algorithm_EnsembleBlue.rst
doc/fr/ref_algorithm_ExtendedBlue.rst
doc/fr/ref_algorithm_ExtendedKalmanFilter.rst
doc/fr/ref_algorithm_KalmanFilter.rst
doc/fr/ref_algorithm_LinearLeastSquares.rst
doc/fr/ref_algorithm_NonLinearLeastSquares.rst
doc/fr/ref_algorithm_ParticleSwarmOptimization.rst
doc/fr/ref_algorithm_QuantileRegression.rst
doc/fr/ref_algorithm_SamplingTest.rst
doc/fr/ref_algorithm_UnscentedKalmanFilter.rst
doc/fr/ref_output_variables.rst
doc/fr/reference.rst
doc/fr/tui.rst
src/daComposant/daAlgorithms/3DVAR.py
src/daComposant/daAlgorithms/Blue.py
src/daComposant/daAlgorithms/EnsembleBlue.py
src/daComposant/daAlgorithms/ExtendedBlue.py
src/daComposant/daAlgorithms/LinearLeastSquares.py
src/daComposant/daCore/BasicObjects.py

index a946bbb973521baa083cec091cde0188646c8be2..3dce275304f5509880506cbbb4b6d78ed74989c1 100644 (file)
@@ -170,7 +170,7 @@ The options of the algorithm are the following:
     "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
     "SimulatedObservationAtOptimum", "SimulationQuantiles"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
   Quantiles
     This list indicates the values of quantile, between 0 and 1, to be estimated
index da5e64b68ed4b0ec2b79deebf10857cc0de5a8ce..d64f77e4dc8b5a62ea219e62199859d447208b68 100644 (file)
@@ -110,12 +110,13 @@ The options of the algorithm are the following:
     these variables being calculated and stored by default. The possible names
     are in the following list: ["APosterioriCorrelations",
     "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "OMA", "OMB", "Innovation",
-    "SigmaBck2", "SigmaObs2", "MahalanobisConsistency",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum",
-    "SimulationQuantiles"].
+    "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState",
+    "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2",
+    "MahalanobisConsistency", "SimulationQuantiles",
+    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+    "SimulatedObservationAtOptimum"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
   Quantiles
     This list indicates the values of quantile, between 0 and 1, to be estimated
index b7ff885a573a965f4df76faf9c6c09655b864716..41bdc7ce3c4408f002c6c145c06962182b768616 100644 (file)
@@ -96,6 +96,17 @@ command.
 
 The options of the algorithm are the following:
 
+  StoreSupplementaryCalculations
+    This list indicates the names of the supplementary variables that can be
+    available at the end of the algorithm. It involves potentially costly
+    calculations or memory consumptions. The default is a void list, none of
+    these variables being calculated and stored by default. The possible names
+    are in the following list: ["CurrentState", "Innovation",
+    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+    "SimulatedObservationAtOptimum"].
+
+    Example : ``{"StoreSupplementaryCalculations":["CurrentState", "Innovation"]}``
+
   SetSeed
     This key allow to give an integer in order to fix the seed of the random
     generator used to generate the ensemble. A convenient value is for example
index 675adc0a2309265a748069973f45b7ac01729608..fb4e893194097ffbbd7f60d6f6dba279343e3c7e 100644 (file)
@@ -108,12 +108,13 @@ The options of the algorithm are the following:
     these variables being calculated and stored by default. The possible names
     are in the following list: ["APosterioriCorrelations",
     "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "OMA", "OMB", "Innovation",
-    "SigmaBck2", "SigmaObs2", "MahalanobisConsistency",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum",
-    "SimulationQuantiles"].
+    "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState",
+    "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2",
+    "MahalanobisConsistency", "SimulationQuantiles",
+    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+    "SimulatedObservationAtOptimum"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
   Quantiles
     This list indicates the values of quantile, between 0 and 1, to be estimated
index 2ea62c3edb35d20fcc3d3d7af8623fcce758d481..9619316e89ded61ea9d02d0876c7d544d52a9e44 100644 (file)
@@ -117,7 +117,7 @@ The options of the algorithm are the following:
     "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentState",
     "Innovation"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Information and variables available at the end of the algorithm
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index c40a4070f49a86a346503d4d9e1c5a798c3930df..671d29c550f6e8ac57845a0ec83c99a370f8c6b8 100644 (file)
@@ -116,7 +116,7 @@ The options of the algorithm are the following:
     "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentState",
     "Innovation"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Information and variables available at the end of the algorithm
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index 29e186d843d74ab28da095770ac21f19cd8cbd4c..2b04ae42914a545840659de81e8dea9b419c14d9 100644 (file)
@@ -93,10 +93,10 @@ The options of the algorithm are the following:
     available at the end of the algorithm. It involves potentially costly
     calculations or memory consumptions. The default is a void list, none of
     these variables being calculated and stored by default. The possible names
-    are in the following list: ["OMA", "CostFunctionJ",
-    "SimulatedObservationAtOptimum"].
+    are in the following list: ["OMA", "CurrentState", "CostFunctionJ",
+    "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
 
-    Example : ``{"StoreSupplementaryCalculations":["OMA"]}``
+    Example : ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}``
 
 *Tips for this algorithm:*
 
index 6c2b520758971c2a719bed9476d96e6ad8df478d..f64f7988fcfef7278ddd0ca7059ebe0267f5ae67 100644 (file)
@@ -159,7 +159,7 @@ The options of the algorithm are the following:
     "OMB", "Innovation", "SimulatedObservationAtCurrentState",
     "SimulatedObservationAtOptimum"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 *Tips for this algorithm:*
 
index e1eca534efa536bf93292820ea3f744528dad003..ff117b48001d20ea8d31e8e9c53f53151e9fa5b8 100644 (file)
@@ -164,7 +164,7 @@ The options of the algorithm are the following:
     "OMB", "Innovation", "SimulatedObservationAtBackground",
     "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Information and variables available at the end of the algorithm
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index c8a417db9090b23d88b6c1ff4e2c049ffe00139e..06f777a722218a075be59c0588fab17735eb3cf0 100644 (file)
@@ -112,7 +112,7 @@ The options of the algorithm are the following:
     "OMB", "Innovation", "SimulatedObservationAtBackground",
     "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 *Tips for this algorithm:*
 
index baf16fadfcc52e206186a18f6ab05efa2c8109ab..7996b557948913a7683c80ad185f8fbdce585362 100644 (file)
@@ -45,7 +45,11 @@ the form of hyper-cubes, explicit or sampled using classic distributions. Be
 careful to the size of the hyper-cube (and then to the number of calculations)
 that can be reached, it can be big very quickly.
 
-To perform distributed or complex sampling, see other modules available in
+To be visible by the user, the results of sampling has to be explicitly asked
+for. One use for that, on the desired variable, the final saving through
+"*UserPostAnalysis*" or the treatment during the calculation by "*observer*".
+
+To perform distributed or more complex sampling, see other modules available in
 SALOME : PARAMETRIC or OPENTURNS.
 
 Optional and required commands
index e903aa61fcdb530031fdea391d419ff6a51a4d98..9512bdbde6958f93e1e3f026b823b8e2c438d71e 100644 (file)
@@ -132,7 +132,7 @@ The options of the algorithm are the following:
     "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentState",
     "Innovation"].
 
-    Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Information and variables available at the end of the algorithm
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index 845f14b078647c4ffc4d0e08304578eb8ddc333e..9955521f14996f44c26a060d6d4b7612390c0b34 100644 (file)
@@ -80,16 +80,16 @@ The mathematical notations used afterward are explained in the section
    
    ref_assimilation_keywords
    ref_algorithm_3DVAR
-   ref_algorithm_LinearLeastSquares
-   ref_algorithm_NonLinearLeastSquares
    ref_algorithm_Blue
-   ref_algorithm_ExtendedBlue
    ref_algorithm_EnsembleBlue
-   ref_algorithm_KalmanFilter
+   ref_algorithm_ExtendedBlue
    ref_algorithm_ExtendedKalmanFilter
-   ref_algorithm_UnscentedKalmanFilter
+   ref_algorithm_KalmanFilter
+   ref_algorithm_LinearLeastSquares
+   ref_algorithm_NonLinearLeastSquares
    ref_algorithm_ParticleSwarmOptimization
    ref_algorithm_QuantileRegression
+   ref_algorithm_UnscentedKalmanFilter
 
 .. _section_reference_checking:
 
@@ -114,5 +114,5 @@ The mathematical notations used afterward are explained in the section
    ref_algorithm_GradientTest
    ref_algorithm_LinearityTest
    ref_algorithm_ObserverTest
-   ref_algorithm_TangentTest
    ref_algorithm_SamplingTest
+   ref_algorithm_TangentTest
index 47c658092e9e216ccc0b211161a81176da283cc4..fa5e425ceddbd443cff72b45a000f24101c70dfd 100644 (file)
@@ -175,7 +175,7 @@ Les options de l'algorithme sont les suivantes:
     "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
     "SimulatedObservationAtOptimum", "SimulationQuantiles"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
   Quantiles
     Cette liste indique les valeurs de quantile, entre 0 et 1, à estimer par
index 45540fa94bca07e135d089bbfb5f554aedf230d3..f862141bfcba7a0c0a56b018f41a45e913241ee2 100644 (file)
@@ -112,12 +112,13 @@ Les options de l'algorithme sont les suivantes:
     aucune de ces variables n'étant calculée et stockée par défaut. Les noms
     possibles sont dans la liste suivante : ["APosterioriCorrelations",
     "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "OMA", "OMB", "Innovation",
-    "SigmaBck2", "SigmaObs2", "MahalanobisConsistency",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum",
-    "SimulationQuantiles"].
+    "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState",
+    "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2",
+    "MahalanobisConsistency", "SimulationQuantiles",
+    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+    "SimulatedObservationAtOptimum"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
   Quantiles
     Cette liste indique les valeurs de quantile, entre 0 et 1, à estimer par
index d8add0d6bbfa6128de16c01a3f040a6b08c88db7..04b7c023f573a49e1b974cbfa73fc195bc447bc2 100644 (file)
@@ -97,6 +97,17 @@ commande.
 
 Les options de l'algorithme sont les suivantes:
 
+  StoreSupplementaryCalculations
+    Cette liste indique les noms des variables supplémentaires qui peuvent être
+    disponibles à la fin de l'algorithme. Cela implique potentiellement des
+    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+    possibles sont dans la liste suivante : ["CurrentState", "Innovation",
+    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+    "SimulatedObservationAtOptimum"].
+
+    Exemple : ``{"StoreSupplementaryCalculations":["CurrentState", "Innovation"]}``
+
   SetSeed
     Cette clé permet de donner un nombre entier pour fixer la graine du
     générateur aléatoire utilisé pour générer l'ensemble. Un valeur pratique est
index e351927834ee7d27da901350dee7a0a379a5adf4..ffbe23ea2f77abc87ccca9e4865adb34ce236c92 100644 (file)
@@ -107,14 +107,11 @@ Les options de l'algorithme sont les suivantes:
     disponibles à la fin de l'algorithme. Cela implique potentiellement des
     calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
     aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "OMA", "OMB", "Innovation",
-    "SigmaBck2", "SigmaObs2", "MahalanobisConsistency",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum",
-    "SimulationQuantiles"].
-
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    possibles sont dans la liste suivante : ["CurrentState", "Innovation",
+    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+    "SimulatedObservationAtOptimum"].
+
+    Exemple : ``{"StoreSupplementaryCalculations":["CurrentState", "Innovation"]}``
 
   Quantiles
     Cette liste indique les valeurs de quantile, entre 0 et 1, à estimer par
index 6d7cd20f9408d3c3599bc2437dbb66f74cc38d45..4cc49b3640476627d0e01c0dcbe79f527029ccdb 100644 (file)
@@ -120,7 +120,7 @@ Les options de l'algorithme sont les suivantes:
     "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentState",
     "Innovation"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Informations et variables disponibles à la fin de l'algorithme
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index 7242a6d6cb4616365cd93fb193d91d0798780863..ef4872ce4b361823d4b1a6a78b42a6886789d571 100644 (file)
@@ -117,7 +117,7 @@ Les options de l'algorithme sont les suivantes:
     "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentState",
     "Innovation"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Informations et variables disponibles à la fin de l'algorithme
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index 89669b151d398687ec9881d7516e982bbcfb4f68..1b754edea0bdd2822746cbff9636df8a37c787f9 100644 (file)
@@ -94,10 +94,11 @@ Les options de l'algorithme sont les suivantes:
     disponibles à la fin de l'algorithme. Cela implique potentiellement des
     calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
     aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["OMA", "CostFunctionJ",
+    possibles sont dans la liste suivante : ["OMA", "CurrentState",
+    "CostFunctionJ", "SimulatedObservationAtCurrentState",
     "SimulatedObservationAtOptimum"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["OMA"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}``
 
 *Astuce pour cet algorithme :*
 
index eb1e972720998798b37e743b429d6ff9406e0b8c..5f4e708b9e82aafa6e2c43f2b685c83273d82e27 100644 (file)
@@ -166,7 +166,7 @@ Les options de l'algorithme sont les suivantes:
     "CurrentState", "OMA", "OMB", "Innovation",
     "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 *Astuce pour cet algorithme :*
 
index a7320c4be5a6866e87a8fefd0997bf168a390ea6..98a67eb750361a4c8cf3c77c375b3ef3cf612b90 100644 (file)
@@ -169,7 +169,7 @@ Les options de l'algorithme sont les suivantes:
     "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
     "SimulatedObservationAtOptimum"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Informations et variables disponibles à la fin de l'algorithme
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index dd6fe00a5126e38e13f509402870b9bb4c8be04e..6ae741afb90d350c334848c9e90aef76f3a7d944 100644 (file)
@@ -112,9 +112,9 @@ Les options de l'algorithme sont les suivantes:
     possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
     "CurrentState", "OMA", "OMB", "Innovation",
     "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
-    "SimulatedObservationAtOptimum"]. 
+    "SimulatedObservationAtOptimum"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 *Astuce pour cet algorithme :*
 
index e16b9973b0c943d5a7ab547e1fca9f5ad3eb764c..ec3d412f8708be54e87905d223b7843ab0138ecd 100644 (file)
@@ -46,7 +46,12 @@ sous la forme d'hyper-cubes, explicites ou 
 courantes. Attention à la taille de l'hyper-cube (et donc au nombre de calculs)
 qu'il est possible d'atteindre, elle peut rapidement devenir importante.
 
-Pour effectuer un échantillonage distribué ou plus complexe, voir d'autres
+Pour apparaître pour l'utilisateur, les résultats de l'échantillonnage doivent
+être demandés explicitement. On utilise pour cela, sur la variable désirée, la
+sauvegarde finale à l'aide du mot-clé "*UserPostAnalysis*" ou le traitement en
+cours de calcul à l'aide des "*observer*" adaptés.
+
+Pour effectuer un échantillonnage distribué ou plus complexe, voir d'autres
 modules disponibles dans SALOME : PARAMETRIC ou OPENTURNS.
 
 Commandes requises et optionnelles
index 1a99e1c69d783953a3062309d0a34bdd3ba0eb7f..87b5b1a1577d720ead18256b98b37f50657fd335 100644 (file)
@@ -135,7 +135,7 @@ Les options de l'algorithme sont les suivantes:
     "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentState",
     "Innovation"].
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 Informations et variables disponibles à la fin de l'algorithme
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
index 1f7e64ac284d662c3ed9bb3e464cb8c44b4ba854..47bb2b423d3876a0339df8887451a8aee3e226db 100644 (file)
@@ -41,7 +41,7 @@ calcul. L'obtention de ces informations se fait ensuite de mani
 à l'aide de l'étape de post-processing du calcul.
 
 L'étape est aisément identifiée par l'utilisateur dans son cas ADAO de
-définition (par la mot-clé "*UserPostAnalysis*") ou dans son schéma YACS
+définition (par le mot-clé "*UserPostAnalysis*") ou dans son schéma YACS
 d'exécution (par des noeuds ou blocs situés après le bloc de calcul, et reliés
 graphiquement au port de sortie "*algoResults*" du bloc de calcul):
 
index 2ff60667076f189a70fb80403b2ec7987a546308..d74f1dd1758d2c5f25a2699babb48cf5a1240625 100644 (file)
@@ -82,16 +82,16 @@ ADAO. Les notations math
    
    ref_assimilation_keywords
    ref_algorithm_3DVAR
-   ref_algorithm_LinearLeastSquares
-   ref_algorithm_NonLinearLeastSquares
    ref_algorithm_Blue
-   ref_algorithm_ExtendedBlue
    ref_algorithm_EnsembleBlue
-   ref_algorithm_KalmanFilter
+   ref_algorithm_ExtendedBlue
    ref_algorithm_ExtendedKalmanFilter
-   ref_algorithm_UnscentedKalmanFilter
+   ref_algorithm_KalmanFilter
+   ref_algorithm_LinearLeastSquares
+   ref_algorithm_NonLinearLeastSquares
    ref_algorithm_ParticleSwarmOptimization
    ref_algorithm_QuantileRegression
+   ref_algorithm_UnscentedKalmanFilter
 
 .. _section_reference_checking:
 
@@ -116,5 +116,5 @@ ADAO. Les notations math
    ref_algorithm_GradientTest
    ref_algorithm_LinearityTest
    ref_algorithm_ObserverTest
-   ref_algorithm_TangentTest
    ref_algorithm_SamplingTest
+   ref_algorithm_TangentTest
index 2c2ec0790e1831e36af57e63067e22c09db18497..5e808ae9c4819c784a68245541de1d3271a73cd7 100644 (file)
@@ -208,10 +208,10 @@ de mani
 en TUI.
 
 Les variables de résultats de calcul, ou les variables internes issues de
-l'optimisation sont disponibles à travers la méthode ``get`` du cas de calcul TUI
-ADAO, qui renvoie un objet de type liste de la variable demandée. On se
-reportera aux :ref:`section_ref_output_variables` pour une description détaillée
-sur ce sujet.
+l'optimisation ou de l'assimilation de données, sont disponibles à travers la
+méthode ``get`` du cas de calcul TUI ADAO, qui renvoie un objet de type liste de
+la variable demandée. On se reportera aux :ref:`section_ref_output_variables`
+pour une description détaillée sur ce sujet.
 
 A titre d'exemple, on donne quelques lignes de script qui permettent d'obtenir
 le nombre d'itérations de l'optimisation et la valeur optimale ainsi que sa
@@ -220,7 +220,7 @@ taille::
     print
     print "    Nombre d'iterations :", len(case.get("CostFunctionJ"))
     Xa = case.get("Analysis")
-    print "    Analyse optimale  :", Xa[-1]
+    print "    Analyse optimale    :", Xa[-1]
     print "    Taille de l'analyse :", len(Xa[-1])
     print
 
@@ -228,9 +228,10 @@ Ces lignes peuvent 
 de calcul TUI ADAO proposé dans :ref:`subsection_tui_example`.
 
 De même que pour l'entrée des données, la simplicité de récupération des
-résultats permet d'envisager aisément des post-traitements enchaînés, pour
-utiliser par exemple de la visualisation avec MatPlotLib ou PARAVIS [PARAVIS]_,
-de l'adaptation de maillage avec HOMARD [HOMARD]_, ou pour d'autres calculs.
+résultats permet d'envisager aisément des post-traitements enchaînés dans
+SALOME, pour utiliser par exemple de la visualisation avec MatPlotLib ou PARAVIS
+[PARAVIS]_, de l'adaptation de maillage avec HOMARD [HOMARD]_, ou pour d'autres
+calculs.
 
 .. _subsection_tui_commands:
 
@@ -548,10 +549,10 @@ ici, puisque d
 
 Les hypothèses du cas utilisateur sont les suivantes. On suppose :
 
-#.      que l'on veut recaler 3 paramètres ``alpha``, ``beta`` et ``gamma`` dans un domaine borné,
-#.      que l'on dispose d'observations nommées ``observations``,
-#.      que l'utilisateur dispose en Python d'une fonction de simulation physique appellée ``simulation`` préalablement testée, qui transforme les 3 paramètres en résultats similaires aux observations,
-#.      que l'exploitation indépendante, que l'utilisateur veut faire, est représentée ici par l'affichage simple de l'état initial, de l'état optimal, de la simulation en ce point, des états intermédiaires et du nombre d'itérations d'optimisation.
+#. que l'on veut recaler 3 paramètres ``alpha``, ``beta`` et ``gamma`` dans un domaine borné,
+#. que l'on dispose d'observations nommées ``observations``,
+#. que l'utilisateur dispose en Python d'une fonction de simulation physique appellée ``simulation`` préalablement testée, qui transforme les 3 paramètres en résultats similaires aux observations,
+#. que l'exploitation indépendante, que l'utilisateur veut faire, est représentée ici par l'affichage simple de l'état initial, de l'état optimal, de la simulation en ce point, des états intermédiaires et du nombre d'itérations d'optimisation.
 
 Pour effectuer de manière simple cet essai de cas de calcul TUI, on se donne par
 exemple les entrées suivantes, parfaitement arbitraires, en construisant les
index a7e2e3ce46c31ead18afbbd048ab9b2541f63f2b..382f12a889b7d231326b97a9fb27ae4c0116db98 100644 (file)
@@ -320,7 +320,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         if "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["MahalanobisConsistency"].store( float( 2.*MinJ/d.size ) )
         if "SimulationQuantiles" in self._parameters["StoreSupplementaryCalculations"]:
-            Qtls = self._parameters["Quantiles"]
+            Qtls = map(float, self._parameters["Quantiles"])
             nech = self._parameters["NumberOfSamplesForQuantiles"]
             HXa  = numpy.matrix(numpy.ravel( HXa )).T
             YfQ  = None
index 7600ea5e3df152c0ab5ecc32df1e0ff4f855d382..7e05f14b1ae039d9b7cb9b4833cd96c0cdd0e6eb 100644 (file)
@@ -39,7 +39,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             default  = [],
             typecast = tuple,
             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
-            listval  = ["APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "OMA", "OMB", "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum"]
+            listval  = ["APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
             )
         self.defineRequiredParameter(
             name     = "Quantiles",
@@ -127,12 +127,13 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # Calcul de la fonction coût
         # --------------------------
         if self._parameters["StoreInternalVariables"] or \
-           "CostFunctionJ"                 in self._parameters["StoreSupplementaryCalculations"] or \
-           "OMA"                           in self._parameters["StoreSupplementaryCalculations"] or \
-           "SigmaObs2"                     in self._parameters["StoreSupplementaryCalculations"] or \
-           "MahalanobisConsistency"        in self._parameters["StoreSupplementaryCalculations"] or \
-           "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"] or \
-           "SimulationQuantiles"           in self._parameters["StoreSupplementaryCalculations"]:
+           "CostFunctionJ"                      in self._parameters["StoreSupplementaryCalculations"] or \
+           "OMA"                                in self._parameters["StoreSupplementaryCalculations"] or \
+           "SigmaObs2"                          in self._parameters["StoreSupplementaryCalculations"] or \
+           "MahalanobisConsistency"             in self._parameters["StoreSupplementaryCalculations"] or \
+           "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"] or \
+           "SimulatedObservationAtOptimum"      in self._parameters["StoreSupplementaryCalculations"] or \
+           "SimulationQuantiles"                in self._parameters["StoreSupplementaryCalculations"]:
             HXa = Hm * Xa
             oma = Y - HXa
         if self._parameters["StoreInternalVariables"] or \
@@ -163,6 +164,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         #
         # Calculs et/ou stockages supplémentaires
         # ---------------------------------------
+        if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["CurrentState"].store( numpy.ravel(Xa) )
         if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["Innovation"].store( numpy.ravel(d) )
         if "BMA" in self._parameters["StoreSupplementaryCalculations"]:
@@ -179,7 +182,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         if "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["MahalanobisConsistency"].store( float( 2.*J/d.size ) )
         if "SimulationQuantiles" in self._parameters["StoreSupplementaryCalculations"]:
-            Qtls = self._parameters["Quantiles"]
+            Qtls = map(float, self._parameters["Quantiles"])
             nech = self._parameters["NumberOfSamplesForQuantiles"]
             YfQ  = None
             for i in range(nech):
@@ -204,6 +207,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             self.StoredVariables["SimulationQuantiles"].store( YQ )
         if "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
+        if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(HXa) )
         if "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel(HXa) )
         #
index e1cfb5b109e1f25b80c6d00c60358383e0846e13..35f6101f8d5c1d4a95540d45a38ce01662763367 100644 (file)
@@ -28,6 +28,19 @@ import numpy
 class ElementaryAlgorithm(BasicObjects.Algorithm):
     def __init__(self):
         BasicObjects.Algorithm.__init__(self, "ENSEMBLEBLUE")
+        self.defineRequiredParameter(
+            name     = "StoreInternalVariables",
+            default  = False,
+            typecast = bool,
+            message  = "Stockage des variables internes ou intermédiaires du calcul",
+            )
+        self.defineRequiredParameter(
+            name     = "StoreSupplementaryCalculations",
+            default  = [],
+            typecast = tuple,
+            message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
+            listval  = ["CurrentState", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
+            )
         self.defineRequiredParameter(
             name     = "SetSeed",
             typecast = numpy.random.seed,
@@ -77,16 +90,24 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # Calcul du BLUE pour chaque membre de l'ensemble
         # -----------------------------------------------
         for iens in range(nb_ens):
-            d  = EnsembleY[:,iens] - Hm * Xb[iens]
+            HXb = Hm * Xb[iens]
+            if "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
+                self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
+            d  = EnsembleY[:,iens] - HXb
+            if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
+                self.StoredVariables["Innovation"].store( numpy.ravel(d) )
             Xa = Xb[iens] + K*d
             self.StoredVariables["CurrentState"].store( Xa )
-            self.StoredVariables["Innovation"].store( d.A1 )
+            if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+                self.StoredVariables["SimulatedObservationAtCurrentState"].store( Hm * Xa )
         #
         # Fabrication de l'analyse
         # ------------------------
         Members = self.StoredVariables["CurrentState"][-nb_ens:]
         Xa = numpy.matrix( Members ).mean(axis=0)
         self.StoredVariables["Analysis"].store( Xa.A1 )
+        if "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel( Hm * Xa ) )
         #
         self._post_run(HO)
         return 0
index eb1fc59b9678de5dce61253668937de4c9d354b2..c36ded9ac3f860d1668366d1ab140054a908ba97 100644 (file)
@@ -39,7 +39,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             default  = [],
             typecast = tuple,
             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
-            listval  = ["APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "OMA", "OMB", "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum"]
+            listval  = ["APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
             )
         self.defineRequiredParameter(
             name     = "Quantiles",
@@ -128,12 +128,13 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # Calcul de la fonction coût
         # --------------------------
         if self._parameters["StoreInternalVariables"] or \
-           "CostFunctionJ"                 in self._parameters["StoreSupplementaryCalculations"] or \
-           "OMA"                           in self._parameters["StoreSupplementaryCalculations"] or \
-           "SigmaObs2"                     in self._parameters["StoreSupplementaryCalculations"] or \
-           "MahalanobisConsistency"        in self._parameters["StoreSupplementaryCalculations"] or \
-           "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"] or \
-           "SimulationQuantiles"           in self._parameters["StoreSupplementaryCalculations"]:
+           "CostFunctionJ"                      in self._parameters["StoreSupplementaryCalculations"] or \
+           "OMA"                                in self._parameters["StoreSupplementaryCalculations"] or \
+           "SigmaObs2"                          in self._parameters["StoreSupplementaryCalculations"] or \
+           "MahalanobisConsistency"             in self._parameters["StoreSupplementaryCalculations"] or \
+           "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"] or \
+           "SimulatedObservationAtOptimum"      in self._parameters["StoreSupplementaryCalculations"] or \
+           "SimulationQuantiles"                in self._parameters["StoreSupplementaryCalculations"]:
             HXa  = numpy.matrix(numpy.ravel( H( Xa ) )).T
             oma = Y - HXa
         if self._parameters["StoreInternalVariables"] or \
@@ -149,7 +150,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         # Calcul de la covariance d'analyse
         # ---------------------------------
         if "APosterioriCovariance" in self._parameters["StoreSupplementaryCalculations"] or \
-           "SimulationQuantiles" in self._parameters["StoreSupplementaryCalculations"]:
+           "SimulationQuantiles"   in self._parameters["StoreSupplementaryCalculations"]:
             if   (Y.size <= Xb.size) and (Y.size > 100): K  = B * Ha * (R + Hm * B * Ha).I
             elif (Y.size >  Xb.size) and (Y.size > 100): K = (BI + Ha * RI * Hm).I * Ha * RI
             else:                                        pass # K deja calcule
@@ -167,6 +168,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         #
         # Calculs et/ou stockages supplémentaires
         # ---------------------------------------
+        if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["CurrentState"].store( numpy.ravel(Xa) )
         if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["Innovation"].store( numpy.ravel(d) )
         if "BMA" in self._parameters["StoreSupplementaryCalculations"]:
@@ -183,7 +186,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         if "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["MahalanobisConsistency"].store( float( 2.*J/d.size ) )
         if "SimulationQuantiles" in self._parameters["StoreSupplementaryCalculations"]:
-            Qtls = self._parameters["Quantiles"]
+            Qtls = map(float, self._parameters["Quantiles"])
             nech = self._parameters["NumberOfSamplesForQuantiles"]
             HtM  = HO["Tangent"].asMatrix(ValueForMethodForm = Xa)
             HtM  = HtM.reshape(Y.size,Xa.size) # ADAO & check shape
@@ -210,6 +213,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             self.StoredVariables["SimulationQuantiles"].store( YQ )
         if "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
+        if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(HXa) )
         if "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel(HXa) )
         #
index d6ddcfde799ddcad6d5b66755eaf646e5266d9fa..e85c8f231592015487ee8cc4d152c3cdd505c7bb 100644 (file)
@@ -39,7 +39,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             default  = [],
             typecast = tuple,
             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
-            listval  = ["OMA", "CostFunctionJ", "SimulatedObservationAtOptimum"]
+            listval  = ["OMA", "CurrentState", "CostFunctionJ", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
             )
 
     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
@@ -83,8 +83,12 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         #
         # Calculs et/ou stockages supplémentaires
         # ---------------------------------------
+        if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["CurrentState"].store( numpy.ravel(Xa) )
         if "OMA" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["OMA"].store( numpy.ravel(oma) )
+        if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
+            self.StoredVariables["SimulatedObservationAtCurrentState"].store( numpy.ravel(HXa) )
         if "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel(HXa) )
         #
index 345f04bc792b8d07617fd15417838c0545a7aed9..fc6708b2cf4621c2fc98c86edbbcc1c5c5a20499 100644 (file)
@@ -417,9 +417,9 @@ class Algorithm:
             if typecast is None: __val = value
             else:                __val = typecast( value )
         #
-        if minval is not None and (numpy.array(__val) < minval).any():
+        if minval is not None and (numpy.array(__val, float) < minval).any():
             raise ValueError("The parameter named \"%s\" of value \"%s\" can not be less than %s."%(name, __val, minval))
-        if maxval is not None and (numpy.array(__val) > maxval).any():
+        if maxval is not None and (numpy.array(__val, float) > maxval).any():
             raise ValueError("The parameter named \"%s\" of value \"%s\" can not be greater than %s."%(name, __val, maxval))
         if listval is not None:
             if typecast is list or typecast is tuple or type(__val) is list or type(__val) is tuple: