doc/tui_create_case.rst

   1 .. _tui_create_case:
   2
   3 Le cas
   4 ======
   5 .. index:: single: cas
   6 .. index:: single: type de conformité
   7 .. index:: single: maillage;initial
   8
   9 Les variables sont décrites dans :ref:`gui_create_case`.
  10
  11 Méthodes de la classe homard
  12 """"""""""""""""""""""""""""
  13
  14 +---------------------------------------------------------------+
  15 +===============================================================+
  16 | .. module:: CreateCase                                        |
  17 |                                                               |
  18 | **CreateCase(case_name, mesh_name, mesh_file)**               |
  19 |     Retourne une instance de la classe cas                    |
  20 |                                                               |
  21 |     - ``case_name`` : le nom du cas                           |
  22 |     - ``mesh_name`` : le nom du maillage initial              |
  23 |     - ``mesh_file`` : le nom du fichier contenant ce maillage |
  24 |                                                               |
  25 | Par défaut :                                                  |
  26 |                                                               |
  27 |  * le répertoire des résultats est ``/tmp``                   |
  28 |  * l'adaptation est conforme                                  |
  29 +---------------------------------------------------------------+
  30
  31
  32 Méthodes de la classe cas
  33 """""""""""""""""""""""""
  34
  35 +---------------------------------------------------------------+
  36 +===============================================================+
  37 | .. module:: GetName                                           |
  38 |                                                               |
  39 | **GetName()**                                                 |
  40 |     Retourne le nom du cas                                    |
  41 +---------------------------------------------------------------+
  42 | .. module:: SetDirName                                        |
  43 |                                                               |
  44 | **SetDirName(dirname)**                                       |
  45 |                                                               |
  46 |     - ``dirname`` : le nom du répertoire des résutats         |
  47 +---------------------------------------------------------------+
  48 | .. module:: GetDirName                                        |
  49 |                                                               |
  50 | **GetDirName()**                                              |
  51 |     Retourne le nom du répertoire des résutats associé au cas |
  52 +---------------------------------------------------------------+
  53 | .. module:: SetConfType                                       |
  54 |                                                               |
  55 | **SetConfType(conf_type)**                                    |
  56 |                                                               |
  57 |     - ``conf_type`` :  entier précisant le mode de conformité |
  58 |                                                               |
  59 |         1. conforme                                           |
  60 |         2. non conforme avec 1 noeud par maille               |
  61 |         3. non conforme avec 1 noeud par arete de maille      |
  62 |         4. non conforme quelconque                            |
  63 +---------------------------------------------------------------+
  64 | .. module:: GetConfType                                       |
  65 |                                                               |
  66 | **GetConfType()**                                             |
  67 |     Retourne le type de conformité                            |
  68 +---------------------------------------------------------------+
  69 | .. module:: GetIter0Name                                      |
  70 |                                                               |
  71 | **GetIter0Name()**                                            |
  72 |     Retourne le nom de l'itération 0, associée au maillage    |
  73 |     initial. Ce nom est mis automatiquement par le module     |
  74 |     HOMARD et doit être utilisé pour enchaîner les adaptations|
  75 +---------------------------------------------------------------+
  76
  77
  78 Exemple
  79 """""""
  80 La création de l'objet case_1 se fait ainsi : ::
  81
  82     case_name = "CAS_1"
  83     mesh_name = "MAILL"
  84     mesh_file = "/local00/Salome/Adapt/m0.med"
  85     case_1 = homard.CreateCase(case_name, mesh_name, mesh_file)
  86     dirname = "/local00/Salome/Adapt/resu"
  87     case_1.SetDirName(dirname)
  88     case_1.SetConfType(1)
  89
  90
  91
  92