Salome HOME
Documentation update and method improvement
[modules/adao.git] / src / daComposant / daAlgorithms / EnsembleOfSimulationGenerationTask.py
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2008-2023 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 numpy
24 from daCore import BasicObjects
25 from daAlgorithms.Atoms import eosg
26
27 # ==============================================================================
28 class ElementaryAlgorithm(BasicObjects.Algorithm):
29     def __init__(self):
30         BasicObjects.Algorithm.__init__(self, "ENSEMBLEOFSIMULATIONGENERATION")
31         self.defineRequiredParameter(
32             name     = "SampleAsnUplet",
33             default  = [],
34             typecast = tuple,
35             message  = "Points de calcul définis par une liste de n-uplet",
36             )
37         self.defineRequiredParameter(
38             name     = "SampleAsExplicitHyperCube",
39             default  = [],
40             typecast = tuple,
41             message  = "Points de calcul définis par un hyper-cube dont on donne la liste des échantillonnages explicites de chaque variable comme une liste",
42             )
43         self.defineRequiredParameter(
44             name     = "SampleAsMinMaxStepHyperCube",
45             default  = [],
46             typecast = tuple,
47             message  = "Points de calcul définis par un hyper-cube dont on donne la liste des échantillonnages implicites de chaque variable par un triplet [min,max,step]",
48             )
49         self.defineRequiredParameter(
50             name     = "SampleAsMinMaxLatinHyperCube",
51             default  = [],
52             typecast = tuple,
53             message  = "Points de calcul définis par un hyper-cube Latin dont on donne les bornes de chaque variable par une paire [min,max], suivi du nombre de points demandés",
54             )
55         self.defineRequiredParameter(
56             name     = "SampleAsIndependantRandomVariables",
57             default  = [],
58             typecast = tuple,
59             message  = "Points de calcul définis par un hyper-cube dont les points sur chaque axe proviennent de l'échantillonnage indépendant de la variable selon la spécification ['distribution',[parametres],nombre]",
60             )
61         self.defineRequiredParameter(
62             name     = "SetDebug",
63             default  = False,
64             typecast = bool,
65             message  = "Activation du mode debug lors de l'exécution",
66             )
67         self.defineRequiredParameter(
68             name     = "StoreSupplementaryCalculations",
69             default  = ["EnsembleOfSimulations",],
70             typecast = tuple,
71             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
72             listval  = [
73                 "EnsembleOfSimulations",
74                 "EnsembleOfStates",
75                 ]
76             )
77         self.defineRequiredParameter(
78             name     = "SetSeed",
79             typecast = numpy.random.seed,
80             message  = "Graine fixée pour le générateur aléatoire",
81             )
82         self.requireInputArguments(
83             mandatory= ("Xb", "HO"),
84             optional = (),
85             )
86         self.setAttributes(tags=(
87             "Reduction",
88             "Checking",
89             ))
90
91     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
92         self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q)
93         #
94         #--------------------------
95         eosg.eosg(self, Xb, HO)
96         #--------------------------
97         #
98         self._post_run(HO)
99         return 0
100
101 # ==============================================================================
102 if __name__ == "__main__":
103     print("\n AUTODIAGNOSTIC\n")