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     "4DVAR",
  65     "Blue",
  66     "DerivativeFreeOptimization",
  67     "ExtendedBlue",
  68     "EnsembleBlue",
  69     "KalmanFilter",
  70     "ExtendedKalmanFilter",
  71     "UnscentedKalmanFilter",
  72     "LinearLeastSquares",
  73     "NonLinearLeastSquares",
  74     "QuantileRegression",
  75     "ParticleSwarmOptimization",
  76     ]
  77 CheckAlgos = [
  78     "FunctionTest",
  79     "LinearityTest",
  80     "GradientTest",
  81     "AdjointTest",
  82     "ObserverTest",
  83     "TangentTest",
  84     "SamplingTest",
  85     ]
  86
  87 AlgoDataRequirements = {}
  88 AlgoDataRequirements["3DVAR"] = [
  89     "Background", "BackgroundError",
  90     "Observation", "ObservationError",
  91     "ObservationOperator",
  92     ]
  93 AlgoDataRequirements["4DVAR"] = [
  94     "Background", "BackgroundError",
  95     "Observation", "ObservationError",
  96     "ObservationOperator",
  97     ]
  98 AlgoDataRequirements["Blue"] = [
  99     "Background", "BackgroundError",
 100     "Observation", "ObservationError",
 101     "ObservationOperator",
 102     ]
 103 AlgoDataRequirements["DerivativeFreeOptimization"] = [
 104     "Background", "BackgroundError",
 105     "Observation", "ObservationError",
 106     "ObservationOperator",
 107     ]
 108 AlgoDataRequirements["ExtendedBlue"] = [
 109     "Background", "BackgroundError",
 110     "Observation", "ObservationError",
 111     "ObservationOperator",
 112     ]
 113 AlgoDataRequirements["EnsembleBlue"] = [
 114     "Background", "BackgroundError",
 115     "Observation", "ObservationError",
 116     "ObservationOperator",
 117     ]
 118 AlgoDataRequirements["KalmanFilter"] = [
 119     "Background", "BackgroundError",
 120     "Observation", "ObservationError",
 121     ]
 122 AlgoDataRequirements["ExtendedKalmanFilter"] = [
 123     "Background", "BackgroundError",
 124     "Observation", "ObservationError",
 125     "ObservationOperator",
 126     ]
 127 AlgoDataRequirements["UnscentedKalmanFilter"] = [
 128     "Background", "BackgroundError",
 129     "Observation", "ObservationError",
 130     "ObservationOperator",
 131     ]
 132 AlgoDataRequirements["LinearLeastSquares"] = [
 133     "Observation", "ObservationError",
 134     "ObservationOperator",
 135     ]
 136 AlgoDataRequirements["NonLinearLeastSquares"] = [
 137     "Background",
 138     "Observation", "ObservationError",
 139     "ObservationOperator",
 140     ]
 141 AlgoDataRequirements["ParticleSwarmOptimization"] = [
 142     "Background", "BackgroundError",
 143     "Observation", "ObservationError",
 144     "ObservationOperator",
 145     ]
 146 AlgoDataRequirements["QuantileRegression"] = [
 147     "Background",
 148     "Observation",
 149     "ObservationOperator",
 150     ]
 151
 152 AlgoDataRequirements["FunctionTest"] = [
 153     "CheckingPoint",
 154     "ObservationOperator",
 155     ]
 156 AlgoDataRequirements["LinearityTest"] = [
 157     "CheckingPoint",
 158     "ObservationOperator",
 159     ]
 160 AlgoDataRequirements["GradientTest"] = [
 161     "CheckingPoint",
 162     "ObservationOperator",
 163     ]
 164 AlgoDataRequirements["AdjointTest"] = [
 165     "CheckingPoint",
 166     "ObservationOperator",
 167     ]
 168 AlgoDataRequirements["ObserverTest"] = [
 169     "Observers",
 170     ]
 171 AlgoDataRequirements["TangentTest"] = [
 172     "CheckingPoint",
 173     "ObservationOperator",
 174     ]
 175 AlgoDataRequirements["SamplingTest"] = [
 176     "CheckingPoint", "BackgroundError",
 177     "Observation", "ObservationError",
 178     "ObservationOperator",
 179     ]
 180
 181 AlgoType = {}
 182 AlgoType["3DVAR"] = "Optim"
 183 AlgoType["4DVAR"] = "Optim"
 184 AlgoType["Blue"] = "Optim"
 185 AlgoType["DerivativeFreeOptimization"] = "Optim"
 186 AlgoType["ExtendedBlue"] = "Optim"
 187 AlgoType["EnsembleBlue"] = "Optim"
 188 AlgoType["KalmanFilter"] = "Optim"
 189 AlgoType["ExtendedKalmanFilter"] = "Optim"
 190 AlgoType["UnscentedKalmanFilter"] = "Optim"
 191 AlgoType["LinearLeastSquares"] = "Optim"
 192 AlgoType["NonLinearLeastSquares"] = "Optim"
 193 AlgoType["ParticleSwarmOptimization"] = "Optim"
 194 AlgoType["QuantileRegression"] = "Optim"
 195
 196 # Variables qui sont partages avec le generateur de
 197 # catalogue Eficas
 198
 199 # Basic data types
 200 BasicDataInputs = ["String", "Script", "ScriptWithOneFunction", "ScriptWithFunctions", "ScriptWithSwitch", "FunctionDict"]
 201
 202 # Data input dict
 203 DataTypeDict = {}
 204 DataTypeDict["Vector"]               = ["String", "Script"]
 205 DataTypeDict["VectorSerie"]          = ["String", "Script"]
 206 DataTypeDict["Matrix"]               = ["String", "Script"]
 207 DataTypeDict["ScalarSparseMatrix"]   = ["String", "Script"]
 208 DataTypeDict["DiagonalSparseMatrix"] = ["String", "Script"]
 209 DataTypeDict["Function"]             = ["ScriptWithOneFunction", "ScriptWithFunctions", "ScriptWithSwitch", "FunctionDict"]
 210 DataTypeDict["Dict"]                 = ["String", "Script"]
 211
 212 DataTypeDefaultDict = {}
 213 DataTypeDefaultDict["Vector"]               = "Script"
 214 DataTypeDefaultDict["VectorSerie"]          = "Script"
 215 DataTypeDefaultDict["Matrix"]               = "Script"
 216 DataTypeDefaultDict["ScalarSparseMatrix"]   = "String"
 217 DataTypeDefaultDict["DiagonalSparseMatrix"] = "String"
 218 DataTypeDefaultDict["Function"]             = "ScriptWithOneFunction"
 219 DataTypeDefaultDict["Dict"]                 = "Script"
 220
 221 DataSValueDefaultDict = {}
 222 DataSValueDefaultDict["ScalarSparseMatrix"]   = "1."
 223
 224 # Assimilation data input
 225 AssimDataDict = {}
 226 AssimDataDict["Background"]          = ["Vector", "VectorSerie"]
 227 AssimDataDict["BackgroundError"]     = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 228 AssimDataDict["Observation"]         = ["Vector", "VectorSerie"]
 229 AssimDataDict["ObservationError"]    = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 230 AssimDataDict["ObservationOperator"] = ["Matrix", "Function"]
 231 AssimDataDict["EvolutionModel"]      = ["Matrix", "Function"]
 232 AssimDataDict["EvolutionError"]      = ["Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 233 AssimDataDict["AlgorithmParameters"] = ["Dict"]
 234 AssimDataDict["UserDataInit"]        = ["Dict"]
 235 AssimDataDict["CheckingPoint"]       = ["Vector"]
 236 AssimDataDict["ControlInput"]        = ["Vector", "VectorSerie"]
 237
 238 AssimDataDefaultDict = {}
 239 AssimDataDefaultDict["Background"]          = "Vector"
 240 AssimDataDefaultDict["BackgroundError"]     = "ScalarSparseMatrix"
 241 AssimDataDefaultDict["Observation"]         = "Vector"
 242 AssimDataDefaultDict["ObservationError"]    = "ScalarSparseMatrix"
 243 AssimDataDefaultDict["ObservationOperator"] = "Function"
 244 AssimDataDefaultDict["EvolutionModel"]      = "Function"
 245 AssimDataDefaultDict["EvolutionError"]      = "ScalarSparseMatrix"
 246 AssimDataDefaultDict["AlgorithmParameters"] = "Dict"
 247 AssimDataDefaultDict["UserDataInit"]        = "Dict"
 248 AssimDataDefaultDict["CheckingPoint"]       = "Vector"
 249 AssimDataDefaultDict["ControlInput"]        = "Vector"
 250
 251 StoredAssimData = ["Vector", "VectorSerie", "Matrix", "ScalarSparseMatrix", "DiagonalSparseMatrix"]
 252
 253 # Assimilation optional nodes
 254 OptDict = {}
 255 OptDict["UserPostAnalysis"]   = ["String", "Script", "Template"]
 256 OptDefaultDict = {}
 257 OptDefaultDict["UserPostAnalysis"]   = "Template"
 258
 259 # Observers
 260 ObserversList = [
 261     "Analysis",
 262     "Innovation",
 263     "InnovationAtCurrentState",
 264     "CurrentState",
 265     "CurrentOptimum",
 266     "IndexOfOptimum",
 267     "SimulatedObservationAtBackground",
 268     "SimulatedObservationAtCurrentState",
 269     "SimulatedObservationAtOptimum",
 270     "SimulatedObservationAtCurrentOptimum",
 271     "BMA",
 272     "OMA",
 273     "OMB",
 274     "CostFunctionJ",
 275     "CostFunctionJb",
 276     "CostFunctionJo",
 277     "GradientOfCostFunctionJ",
 278     "GradientOfCostFunctionJb",
 279     "GradientOfCostFunctionJo",
 280     "SigmaObs2",
 281     "SigmaBck2",
 282     "APosterioriCorrelations",
 283     "APosterioriCovariance",
 284     "APosterioriStandardDeviations",
 285     "APosterioriVariances",
 286     "Residu",
 287     ]