parameters: (solverWrapperDictionary)
docstring: Method checking solver wrapper keys are correctly set. A required key is outputBatchSize, which is needed to organize the quantities of interest into sublists (of future objects). For this reason, outputBatchSize must be smaller than or equal to the total number of quantities of interest. It is required if areSamplesSplit() is true.
docstring_summary: Method checking solver wrapper keys are correctly set. A required key is outputBatchSize, which is needed to organize the quantities of interest into sublists (of future objects). For this reason, outputBatchSize must be smaller than or equal to the total number of quantities of interest. It is required if areSamplesSplit() is true.
docstring_tokens: Method checking solver wrapper keys are correctly set . A required key is outputBatchSize which is needed to organize the quantities of interest into sublists ( of future objects ) . For this reason outputBatchSize must be smaller than or equal to the total number of quantities of interest . It is required if areSamplesSplit () is true .
function: def checkInitialisationSolverWrapper(solverWrapperDictionary):
      """
      Method checking solver wrapper keys are correctly set. A required key is outputBatchSize, which is needed to organize the quantities of interest into sublists (of future objects). For this reason, outputBatchSize must be smaller than or equal to the total number of quantities of interest. It is required if areSamplesSplit() is true.
      """
  
      obs = 1 # default value assigned in the solver wrapper
  
      if "outputBatchSize" in solverWrapperDictionary:
          obs = solverWrapperDictionary["outputBatchSize"]
      else:
          warnings.warn("outputBatchSize not defined in solverWrapper dictionary. The default value of 1 will be considered.")
  
      if "qoiEstimator" in solverWrapperDictionary:
          numqoi = len(solverWrapperDictionary["qoiEstimator"])
          qoi_estimator = solverWrapperDictionary["qoiEstimator"]
      else:
          raise Exception("qoiEstimator not defined in solverWrapper dictionary. This entry is required by the SolverWrapper.")
  
      if "xmc.momentEstimator.MultiMomentEstimator" in qoi_estimator or "xmc.momentEstimator.MultiCombinedMomentEstimator" in qoi_estimator:
          if not "sizeMultiXMomentEstimator" in solverWrapperDictionary:
              raise Exception("solverWrapperDictionary does not contain the key sizeMultiXMomentEstimator. The use of MultiMomentEstimator and MultiCombinedMomentEstimator requires to specify the dimension of such multi-dimensional quantities of interest in the solverWrapperDictionary.")
  
      if obs > (numqoi):
          raise Exception ("solverWrapper: outputBatchSize exceeding maximum dimension. Set a value <= number of estimators, namely len(qoiEstimator).")
  
      if solverWrapperDictionary["refinementStrategy"] != "reading_from_file":
          if not "refinementParametersPath" in solverWrapperDictionary:
              raise Exception("solverWrapperDictionary does not contain the key \"refinementParametersPath\". This key is required for running with a \"refinementStrategy\" different from \"reading_from_file\".")
function_tokens: def checkInitialisationSolverWrapper ( solverWrapperDictionary ) : obs = 1 # default value assigned in the solver wrapper if "outputBatchSize" in solverWrapperDictionary : obs = solverWrapperDictionary [ "outputBatchSize" ] else : warnings . warn ( "outputBatchSize not defined in solverWrapper dictionary. The default value of 1 will be considered." ) if "qoiEstimator" in solverWrapperDictionary : numqoi = len ( solverWrapperDictionary [ "qoiEstimator" ] ) qoi_estimator = solverWrapperDictionary [ "qoiEstimator" ] else : raise Exception ( "qoiEstimator not defined in solverWrapper dictionary. This entry is required by the SolverWrapper." ) if "xmc.momentEstimator.MultiMomentEstimator" in qoi_estimator or "xmc.momentEstimator.MultiCombinedMomentEstimator" in qoi_estimator : if not "sizeMultiXMomentEstimator" in solverWrapperDictionary : raise Exception ( "solverWrapperDictionary does not contain the key sizeMultiXMomentEstimator. The use of MultiMomentEstimator and MultiCombinedMomentEstimator requires to specify the dimension of such multi-dimensional quantities of interest in the solverWrapperDictionary." ) if obs > ( numqoi ) : raise Exception ( "solverWrapper: outputBatchSize exceeding maximum dimension. Set a value <= number of estimators, namely len(qoiEstimator)." ) if solverWrapperDictionary [ "refinementStrategy" ] != "reading_from_file" : if not "refinementParametersPath" in solverWrapperDictionary : raise Exception ( "solverWrapperDictionary does not contain the key \"refinementParametersPath\". This key is required for running with a \"refinementStrategy\" different from \"reading_from_file\"." )