Salome HOME
Compatibility fix for algorithm output variables clarity
[modules/adao.git] / src / daComposant / daAlgorithms / EnsembleBlue.py
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2008-2019 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                 "Analysis",
44                 "CurrentState",
45                 "Innovation",
46                 "SimulatedObservationAtBackground",
47                 "SimulatedObservationAtCurrentState",
48                 "SimulatedObservationAtOptimum",
49                 ]
50             )
51         self.defineRequiredParameter(
52             name     = "SetSeed",
53             typecast = numpy.random.seed,
54             message  = "Graine fixée pour le générateur aléatoire",
55             )
56         self.requireInputArguments(
57             mandatory= ("Xb", "Y", "HO", "R", "B"),
58             )
59
60     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
61         self._pre_run(Parameters, Xb, Y, R, B, Q)
62         #
63         # Précalcul des inversions de B et R
64         # ----------------------------------
65         BI = B.getI()
66         RI = R.getI()
67         #
68         # Nombre d'ensemble pour l'ébauche
69         # --------------------------------
70         nb_ens = Xb.stepnumber()
71         #
72         # Construction de l'ensemble des observations, par génération a partir
73         # de la diagonale de R
74         # --------------------------------------------------------------------
75         DiagonaleR = R.diag(Y.size)
76         EnsembleY = numpy.zeros([Y.size,nb_ens])
77         for npar in range(DiagonaleR.size):
78             bruit = numpy.random.normal(0,DiagonaleR[npar],nb_ens)
79             EnsembleY[npar,:] = Y[npar] + bruit
80         EnsembleY = numpy.matrix(EnsembleY)
81         #
82         # Initialisation des opérateurs d'observation et de la matrice gain
83         # -----------------------------------------------------------------
84         Hm = HO["Tangent"].asMatrix(None)
85         Hm = Hm.reshape(Y.size,Xb[0].size) # ADAO & check shape
86         Ha = HO["Adjoint"].asMatrix(None)
87         Ha = Ha.reshape(Xb[0].size,Y.size) # ADAO & check shape
88         #
89         # Calcul de la matrice de gain dans l'espace le plus petit et de l'analyse
90         # ------------------------------------------------------------------------
91         if Y.size <= Xb[0].size:
92             K  = B * Ha * (R + Hm * B * Ha).I
93         else:
94             K = (BI + Ha * RI * Hm).I * Ha * RI
95         #
96         # Calcul du BLUE pour chaque membre de l'ensemble
97         # -----------------------------------------------
98         for iens in range(nb_ens):
99             HXb = Hm * Xb[iens]
100             if self._toStore("SimulatedObservationAtBackground"):
101                 self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
102             d  = EnsembleY[:,iens] - HXb
103             if self._toStore("Innovation"):
104                 self.StoredVariables["Innovation"].store( numpy.ravel(d) )
105             Xa = Xb[iens] + K*d
106             self.StoredVariables["CurrentState"].store( Xa )
107             if self._toStore("SimulatedObservationAtCurrentState"):
108                 self.StoredVariables["SimulatedObservationAtCurrentState"].store( Hm * Xa )
109         #
110         # Fabrication de l'analyse
111         # ------------------------
112         Members = self.StoredVariables["CurrentState"][-nb_ens:]
113         Xa = numpy.matrix( Members ).mean(axis=0)
114         self.StoredVariables["Analysis"].store( Xa.A1 )
115         if self._toStore("SimulatedObservationAtOptimum"):
116             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel( Hm * Xa ) )
117         #
118         self._post_run(HO)
119         return 0
120
121 # ==============================================================================
122 if __name__ == "__main__":
123     print('\n AUTODIAGNOSTIC \n')