Salome HOME
Rewriting and completing reference documentation ([DocR]
[modules/adao.git] / doc / fr / 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 des options d'un algorithme par "*AlgorithmParameters*"
28 -------------------------------------------------------------------
29
30 Chaque algorithme peut être contrôlé en utilisant des options particulières,
31 données à travers la commande optionnelle "*AlgorithmParameters*", à la manière
32 de l'exemple qui suit, dans un fichier Python::
33
34     AlgorithmParameters = {
35         "StoreInternalVariables" : True,
36         "MaximumNumberOfSteps" : 25,
37         "StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
38         }
39
40 Pour donner les valeurs de la commande "*AlgorithmParameters*" par une chaîne de
41 caractères, directement dans l'interface EFICAS, on doit utiliser des guillemets
42 simples pour fournir une définition standard de dictionnaire, comme par
43 exemple::
44
45     '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
46
47 Si une option est spécifiée par l'utilisateur pour un algorithme qui ne la
48 supporte pas, cette option est simplement laissée inutilisée et ne bloque pas le
49 traitement. La signification des acronymes ou des noms particuliers peut être
50 trouvée dans l':ref:`genindex` ou dans le :ref:`section_glossary`.