doc/tui_homard.rst

   1 .. _tui_homard:
   2
   3 L'adaptation
   4 ============
   5
   6 .. index:: single: itération
   7 .. index:: single: calcul
   8
   9 Méthodes de la classe homard
  10 """"""""""""""""""""""""""""
  11
  12 +---------------------------------------------------------------+
  13 +===============================================================+
  14 | .. index:: single: Compute                                    |
  15 |                                                               |
  16 | **Compute(iter_name, option)**                                |
  17 |     Calcule l'adaptation de maillage correspondant à          |
  18 |     une itération                                             |
  19 |                                                               |
  20 |     - ``iter_name`` : le nom de l'itération                   |
  21 |     - ``option`` : un entier précisant ce qui se passe quand  |
  22 |     des fichiers de résultats existent déjà                   |
  23 |         * 0 : arrêt en erreur                                 |
  24 |         * 1 : écrasement des anciens fichiers                 |
  25 |                                                               |
  26 |     Retourne un entier :                                      |
  27 |         * 0 : adaptation réussie                              |
  28 |         * autre valeur : problème                             |
  29 +---------------------------------------------------------------+
  30
  31
  32 Exemple
  33 """""""
  34 Le calcul de l'itération de nom "Iteration_1" avec écrasement des anciens fichiers de résultat se fait ainsi : ::
  35
  36     iter_name = "Iteration_1"
  37     codret = homard.Compute(iter_name, 1)