src/daSalome/daYacsSchemaCreator/infos_daComposant.py

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