Salome HOME
Documentation and functions minor update correction
[modules/adao.git] / src / daComposant / daAlgorithms / EnsembleBlue.py
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2008-2018 EDF R&D
4 #
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
9 #
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 # Lesser General Public License for more details.
14 #
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18 #
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #
21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
22
23 import logging
24 from daCore import BasicObjects
25 import numpy
26
27 # ==============================================================================
28 class ElementaryAlgorithm(BasicObjects.Algorithm):
29     def __init__(self):
30         BasicObjects.Algorithm.__init__(self, "ENSEMBLEBLUE")
31         self.defineRequiredParameter(
32             name     = "StoreInternalVariables",
33             default  = False,
34             typecast = bool,
35             message  = "Stockage des variables internes ou intermédiaires du calcul",
36             )
37         self.defineRequiredParameter(
38             name     = "StoreSupplementaryCalculations",
39             default  = [],
40             typecast = tuple,
41             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
42             listval  = [
43                 "CurrentState",
44                 "Innovation",
45                 "SimulatedObservationAtBackground",
46                 "SimulatedObservationAtCurrentState",
47                 "SimulatedObservationAtOptimum",
48                 ]
49             )
50         self.defineRequiredParameter(
51             name     = "SetSeed",
52             typecast = numpy.random.seed,
53             message  = "Graine fixée pour le générateur aléatoire",
54             )
55         self.requireInputArguments(
56             mandatory= ("Xb", "Y", "HO", "R", "B"),
57             )
58
59     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
60         self._pre_run(Parameters, Xb, Y, R, B, Q)
61         #
62         # Précalcul des inversions de B et R
63         # ----------------------------------
64         BI = B.getI()
65         RI = R.getI()
66         #
67         # Nombre d'ensemble pour l'ébauche
68         # --------------------------------
69         nb_ens = Xb.stepnumber()
70         #
71         # Construction de l'ensemble des observations, par génération a partir
72         # de la diagonale de R
73         # --------------------------------------------------------------------
74         DiagonaleR = R.diag(Y.size)
75         EnsembleY = numpy.zeros([Y.size,nb_ens])
76         for npar in range(DiagonaleR.size):
77             bruit = numpy.random.normal(0,DiagonaleR[npar],nb_ens)
78             EnsembleY[npar,:] = Y[npar] + bruit
79         EnsembleY = numpy.matrix(EnsembleY)
80         #
81         # Initialisation des opérateurs d'observation et de la matrice gain
82         # -----------------------------------------------------------------
83         Hm = HO["Tangent"].asMatrix(None)
84         Hm = Hm.reshape(Y.size,Xb[0].size) # ADAO & check shape
85         Ha = HO["Adjoint"].asMatrix(None)
86         Ha = Ha.reshape(Xb[0].size,Y.size) # ADAO & check shape
87         #
88         # Calcul de la matrice de gain dans l'espace le plus petit et de l'analyse
89         # ------------------------------------------------------------------------
90         if Y.size <= Xb[0].size:
91             K  = B * Ha * (R + Hm * B * Ha).I
92         else:
93             K = (BI + Ha * RI * Hm).I * Ha * RI
94         #
95         # Calcul du BLUE pour chaque membre de l'ensemble
96         # -----------------------------------------------
97         for iens in range(nb_ens):
98             HXb = Hm * Xb[iens]
99             if "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
100                 self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
101             d  = EnsembleY[:,iens] - HXb
102             if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
103                 self.StoredVariables["Innovation"].store( numpy.ravel(d) )
104             Xa = Xb[iens] + K*d
105             self.StoredVariables["CurrentState"].store( Xa )
106             if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
107                 self.StoredVariables["SimulatedObservationAtCurrentState"].store( Hm * Xa )
108         #
109         # Fabrication de l'analyse
110         # ------------------------
111         Members = self.StoredVariables["CurrentState"][-nb_ens:]
112         Xa = numpy.matrix( Members ).mean(axis=0)
113         self.StoredVariables["Analysis"].store( Xa.A1 )
114         if "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
115             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel( Hm * Xa ) )
116         #
117         self._post_run(HO)
118         return 0
119
120 # ==============================================================================
121 if __name__ == "__main__":
122     print('\n AUTODIAGNOSTIC \n')