doc/en/ref_options_AlgorithmParameters.rst

   1 ..
   2    Copyright (C) 2008-2014 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, or (at your option) any later version.
  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: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: AlgorithmParameters
  25 .. _section_ref_options_AlgorithmParameters:
  26
  27 Description of options of an algorithm by "*AlgorithmParameters*"
  28 -----------------------------------------------------------------
  29
  30 Each algorithm can be controlled using some generic or specific options, given
  31 through the "*AlgorithmParameters*" optional command in a script file or a
  32 string, as follows for example in a Python file::
  33
  34     AlgorithmParameters = {
  35         "StoreInternalVariables" : True,
  36         "MaximumNumberOfSteps" : 25,
  37         "StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
  38         }
  39
  40 To give the "*AlgorithmParameters*" values by a string, directly in the EFICAS
  41 interface, one must enclose a standard dictionary definition between simple
  42 quotes, as for example::
  43
  44     '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
  45
  46 If an option is specified by the user for an algorithm that doesn't support it,
  47 the option is simply left unused and don't stop the treatment. The meaning of
  48 the acronyms or particular names can be found in the :ref:`genindex` or the
  49 :ref:`section_glossary`.