src/daSalome/daYacsSchemaCreator/infos_daComposant.py

   1 #-*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2024 EDF R&D
   4 #
   5 # This file is part of SALOME ADAO module
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23 # Author: Andre Ribes, andre.ribes@edf.fr, EDF R&D
  24
  25
  26 # -- Infos pour le parser --
  27
  28 AnalysisData = {}
  29 AnalysisFromList = ["String", "Script"]
  30
  31 # -- Infos from daCore --
  32 AssimData = [
  33     "Background",
  34     "BackgroundError",
  35     "Observation",
  36     "ObservationError",
  37     "ObservationOperator",
  38     "EvolutionModel",
  39     "EvolutionError",
  40     "AlgorithmParameters",
  41     "CheckingPoint",
  42     "ControlInput",
  43     ]
  44
  45 AssimType = {}
  46 AssimType["Background"]          = ["Vector", "VectorSerie"]
  47 AssimType["BackgroundError"]     = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
  48 AssimType["Observation"]         = ["Vector", "VectorSerie"]
  49 AssimType["ObservationError"]    = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
  50 AssimType["ObservationOperator"] = ["Matrix", "Function"]
  51 AssimType["EvolutionModel"]      = ["Matrix", "Function"]
  52 AssimType["EvolutionError"]      = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
  53 AssimType["AlgorithmParameters"] = ["Dict"]
  54 AssimType["UserDataInit"]        = ["Dict"]
  55 AssimType["CheckingPoint"]       = ["Vector"]
  56 AssimType["ControlInput"]        = ["Vector", "VectorSerie"]
  57
  58 FromNumpyList = {}
  59 FromNumpyList["Vector"]               = ["String", "Script", "DataFile"]
  60 FromNumpyList["VectorSerie"]          = ["String", "Script", "DataFile"]
  61 FromNumpyList["Matrix"]               = ["String", "Script"]
  62 FromNumpyList["ScalarSparseMatrix"]   = ["String", "Script"]
  63 FromNumpyList["DiagonalSparseMatrix"] = ["String", "Script"]
  64 FromNumpyList["Function"]             = ["ScriptWithOneFunction", "ScriptWithFunctions", "ScriptWithSwitch", "FunctionDict"]
  65 FromNumpyList["Dict"]                 = ["String", "Script"]
  66
  67 # -- Infos from daAlgorithms --
  68 AssimAlgos = [
  69     "3DVAR",
  70     "4DVAR",
  71     "Blue",
  72     "DerivativeFreeOptimization",
  73     "DifferentialEvolution",
  74     "EnsembleBlue",
  75     "EnsembleKalmanFilter",
  76     "ExtendedBlue",
  77     "ExtendedKalmanFilter",
  78     "KalmanFilter",
  79     "LinearLeastSquares",
  80     "NonLinearLeastSquares",
  81     "ParticleSwarmOptimization",
  82     "QuantileRegression",
  83     "TabuSearch",
  84     "UnscentedKalmanFilter",
  85     ]
  86 OptimizationAlgos = [
  87     "Blue",
  88     "3DVAR",
  89     "DerivativeFreeOptimization",
  90     "DifferentialEvolution",
  91     "KalmanFilter",
  92     "LinearLeastSquares",
  93     "NonLinearLeastSquares",
  94     "ParticleSwarmOptimization",
  95     "TabuSearch",
  96     ]
  97 ReductionAlgos = [
  98     "EnsembleBlue",
  99     "EnsembleKalmanFilter",
 100     "UnscentedKalmanFilter",
 101     ]
 102 CheckAlgos = [
 103     "FunctionTest",
 104     "LinearityTest",
 105     "GradientTest",
 106     "AdjointTest",
 107     "TangentTest",
 108     "LocalSensitivityTest",
 109     "ObservationSimulationComparisonTest",
 110     "SamplingTest",
 111     "ParallelFunctionTest",
 112     "ControledFunctionTest",
 113     "InputValuesTest",
 114     "ObserverTest",
 115     ]
 116 TaskAlgos = []
 117
 118 AlgoDataRequirements = {}
 119 AlgoDataRequirements["3DVAR"] = [
 120     "Background", "BackgroundError",
 121     "Observation", "ObservationError",
 122     "ObservationOperator",
 123     ]
 124 AlgoDataRequirements["4DVAR"] = [
 125     "Background", "BackgroundError",
 126     "Observation", "ObservationError",
 127     "ObservationOperator",
 128     ]
 129 AlgoDataRequirements["Blue"] = [
 130     "Background", "BackgroundError",
 131     "Observation", "ObservationError",
 132     "ObservationOperator",
 133     ]
 134 AlgoDataRequirements["ExtendedBlue"] = [
 135     "Background", "BackgroundError",
 136     "Observation", "ObservationError",
 137     "ObservationOperator",
 138     ]
 139 AlgoDataRequirements["EnsembleBlue"] = [
 140     "Background", "BackgroundError",
 141     "Observation", "ObservationError",
 142     "ObservationOperator",
 143     ]
 144 AlgoDataRequirements["KalmanFilter"] = [
 145     "Background", "BackgroundError",
 146     "Observation", "ObservationError",
 147     "ObservationOperator",
 148     ]
 149 AlgoDataRequirements["ExtendedKalmanFilter"] = [
 150     "Background", "BackgroundError",
 151     "Observation", "ObservationError",
 152     "ObservationOperator",
 153     ]
 154 AlgoDataRequirements["EnsembleKalmanFilter"] = [
 155     "Background", "BackgroundError",
 156     "Observation", "ObservationError",
 157     "ObservationOperator",
 158     ]
 159 AlgoDataRequirements["UnscentedKalmanFilter"] = [
 160     "Background", "BackgroundError",
 161     "Observation", "ObservationError",
 162     "ObservationOperator",
 163     ]
 164 AlgoDataRequirements["QuantileRegression"] = [
 165     "Background",
 166     "Observation",
 167     "ObservationOperator",
 168     ]
 169 AlgoDataRequirements["DerivativeFreeOptimization"] = [
 170     "Background", "BackgroundError",
 171     "Observation", "ObservationError",
 172     "ObservationOperator",
 173     ]
 174 AlgoDataRequirements["ParticleSwarmOptimization"] = [
 175     "Background", "BackgroundError",
 176     "Observation", "ObservationError",
 177     "ObservationOperator",
 178     ]
 179 AlgoDataRequirements["DifferentialEvolution"] = [
 180     "Background", "BackgroundError",
 181     "Observation", "ObservationError",
 182     "ObservationOperator",
 183     ]
 184 AlgoDataRequirements["TabuSearch"] = [
 185     "Background", "BackgroundError",
 186     "Observation", "ObservationError",
 187     "ObservationOperator",
 188     ]
 189 AlgoDataRequirements["LinearLeastSquares"] = [
 190     "Observation", "ObservationError",
 191     "ObservationOperator",
 192     ]
 193 AlgoDataRequirements["NonLinearLeastSquares"] = [
 194     "Background",
 195     "Observation", "ObservationError",
 196     "ObservationOperator",
 197     ]
 198
 199 AlgoDataRequirements["FunctionTest"] = [
 200     "CheckingPoint",
 201     "ObservationOperator",
 202     ]
 203 AlgoDataRequirements["LinearityTest"] = [
 204     "CheckingPoint",
 205     "ObservationOperator",
 206     ]
 207 AlgoDataRequirements["GradientTest"] = [
 208     "CheckingPoint",
 209     "ObservationOperator",
 210     ]
 211 AlgoDataRequirements["AdjointTest"] = [
 212     "CheckingPoint",
 213     "ObservationOperator",
 214     ]
 215 AlgoDataRequirements["TangentTest"] = [
 216     "CheckingPoint",
 217     "ObservationOperator",
 218     ]
 219 AlgoDataRequirements["LocalSensitivityTest"] = [
 220     "CheckingPoint",
 221     "Observation",
 222     "ObservationOperator",
 223     ]
 224 AlgoDataRequirements["ObservationSimulationComparisonTest"] = [
 225     "CheckingPoint",
 226     "Observation",
 227     "ObservationOperator",
 228     ]
 229 AlgoDataRequirements["SamplingTest"] = [
 230     "CheckingPoint", "BackgroundError",
 231     "Observation", "ObservationError",
 232     "ObservationOperator",
 233     ]
 234 AlgoDataRequirements["ParallelFunctionTest"] = [
 235     "CheckingPoint",
 236     "ObservationOperator",
 237     ]
 238 AlgoDataRequirements["ControledFunctionTest"] = [
 239     "CheckingPoint",
 240     "ObservationOperator",
 241     ]
 242 AlgoDataRequirements["ObserverTest"] = [
 243     "Observers",
 244     ]
 245 AlgoDataRequirements["InputValuesTest"] = [
 246     "CheckingPoint",
 247     ]
 248
 249 AlgoType = {}
 250 AlgoType["3DVAR"] = "Optim"
 251 AlgoType["4DVAR"] = "Optim"
 252 AlgoType["Blue"] = "Optim"
 253 AlgoType["ExtendedBlue"] = "Optim"
 254 AlgoType["EnsembleBlue"] = "Optim"
 255 AlgoType["KalmanFilter"] = "Optim"
 256 AlgoType["ExtendedKalmanFilter"] = "Optim"
 257 AlgoType["EnsembleKalmanFilter"] = "Optim"
 258 AlgoType["UnscentedKalmanFilter"] = "Optim"
 259 AlgoType["QuantileRegression"] = "Optim"
 260 AlgoType["DerivativeFreeOptimization"] = "Optim"
 261 AlgoType["ParticleSwarmOptimization"] = "Optim"
 262 AlgoType["DifferentialEvolution"] = "Optim"
 263 AlgoType["TabuSearch"] = "Optim"
 264 AlgoType["LinearLeastSquares"] = "Optim"
 265 AlgoType["NonLinearLeastSquares"] = "Optim"
 266
 267 # Variables qui sont partages avec le generateur de
 268 # catalogue Eficas
 269
 270 # Basic data types
 271 BasicDataInputs = ["String", "Script", "ScriptWithOneFunction", "ScriptWithFunctions", "ScriptWithSwitch", "FunctionDict"]
 272
 273 # Data input dict
 274 DataTypeDict = {}
 275 DataTypeDict["Vector"]               = ["String", "Script", "DataFile"]
 276 DataTypeDict["VectorSerie"]          = ["String", "Script", "DataFile"]
 277 DataTypeDict["Matrix"]               = ["String", "Script"]
 278 DataTypeDict["ScalarSparseMatrix"]   = ["String", "Script"]
 279 DataTypeDict["DiagonalSparseMatrix"] = ["String", "Script"]
 280 DataTypeDict["Function"]             = ["ScriptWithOneFunction", "ScriptWithFunctions", "ScriptWithSwitch", "FunctionDict"]
 281 DataTypeDict["Dict"]                 = ["String", "Script"]
 282
 283 DataTypeDefaultDict = {}
 284 DataTypeDefaultDict["Vector"]               = "Script"
 285 DataTypeDefaultDict["VectorSerie"]          = "Script"
 286 DataTypeDefaultDict["Matrix"]               = "Script"
 287 DataTypeDefaultDict["ScalarSparseMatrix"]   = "String"
 288 DataTypeDefaultDict["DiagonalSparseMatrix"] = "String"
 289 DataTypeDefaultDict["Function"]             = "ScriptWithOneFunction"
 290 DataTypeDefaultDict["Dict"]                 = "Script"
 291
 292 DataSValueDefaultDict = {}
 293 DataSValueDefaultDict["ScalarSparseMatrix"]   = "1."
 294
 295 # Assimilation data input
 296 AssimDataDict = {}
 297 AssimDataDict["Background"]          = ["Vector", "VectorSerie"]
 298 AssimDataDict["BackgroundError"]     = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 299 AssimDataDict["Observation"]         = ["Vector", "VectorSerie"]
 300 AssimDataDict["ObservationError"]    = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 301 AssimDataDict["ObservationOperator"] = ["Matrix", "Function"]
 302 AssimDataDict["EvolutionModel"]      = ["Matrix", "Function"]
 303 AssimDataDict["EvolutionError"]      = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 304 AssimDataDict["AlgorithmParameters"] = ["Dict"]
 305 AssimDataDict["UserDataInit"]        = ["Dict"]
 306 AssimDataDict["CheckingPoint"]       = ["Vector"]
 307 AssimDataDict["ControlInput"]        = ["Vector", "VectorSerie"]
 308
 309 AssimDataDefaultDict = {}
 310 AssimDataDefaultDict["Background"]          = "Vector"
 311 AssimDataDefaultDict["BackgroundError"]     = "ScalarSparseMatrix"
 312 AssimDataDefaultDict["Observation"]         = "Vector"
 313 AssimDataDefaultDict["ObservationError"]    = "ScalarSparseMatrix"
 314 AssimDataDefaultDict["ObservationOperator"] = "Function"
 315 AssimDataDefaultDict["EvolutionModel"]      = "Function"
 316 AssimDataDefaultDict["EvolutionError"]      = "ScalarSparseMatrix"
 317 AssimDataDefaultDict["AlgorithmParameters"] = "Dict"
 318 AssimDataDefaultDict["UserDataInit"]        = "Dict"
 319 AssimDataDefaultDict["CheckingPoint"]       = "Vector"
 320 AssimDataDefaultDict["ControlInput"]        = "Vector"
 321
 322 StoredAssimData = ["Vector", "VectorSerie", "Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 323
 324 # Assimilation optional nodes
 325 OptDict = {}
 326 OptDict["UserPostAnalysis"]   = ["String", "Script", "Template"]
 327 OptDefaultDict = {}
 328 OptDefaultDict["UserPostAnalysis"]   = "Template"
 329
 330 # Observers
 331 ObserversList = [
 332     "Analysis",
 333     "Innovation",
 334     "InnovationAtCurrentState",
 335     "CurrentState",
 336     "CurrentOptimum",
 337     "IndexOfOptimum",
 338     "SimulatedObservationAtBackground",
 339     "SimulatedObservationAtCurrentState",
 340     "SimulatedObservationAtOptimum",
 341     "SimulatedObservationAtCurrentOptimum",
 342     "BMA",
 343     "OMA",
 344     "OMB",
 345     "CostFunctionJ",
 346     "CostFunctionJb",
 347     "CostFunctionJo",
 348     "GradientOfCostFunctionJ",
 349     "GradientOfCostFunctionJb",
 350     "GradientOfCostFunctionJo",
 351     "SigmaObs2",
 352     "SigmaBck2",
 353     "APosterioriCorrelations",
 354     "APosterioriCovariance",
 355     "APosterioriStandardDeviations",
 356     "APosterioriVariances",
 357     "Residu",
 358     ]
 359
 360 # Global regulation of separate container execution with priority on user:
 361 #   0 for no separate execution container possibility
 362 #   1 for separate execution container possibility
 363 UseSeparateContainer = 1