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 | .. module:: AddBoundaryGroup                                  |
  77 |                                                               |
  78 | **AddBoundaryGroup(boundary, group)**                         |
  79 |                                                               |
  80 |     - ``boundary`` : nom d'une frontière courbe à suivre      |
  81 |                                                               |
  82 |     Pour une frontière discrète :                             |
  83 |                                                               |
  84 |     . si toutes les lignes courbes sont suivies, le second    |
  85 |       argument est une chaîne vide.                           |
  86 |     . si seulement certaines lignes courbes sont suivies,     |
  87 |       ``group`` est le nom d'un groupe de segments à suivre.  |
  88 |                                                               |
  89 |     Pour une frontière analytique :                           |
  90 |                                                               |
  91 |     - ``group`` : nom d'un groupe de faces placées sur la     |
  92 |       frontière                                               |
  93 +---------------------------------------------------------------+
  94
  95 Les options avancées
  96 ^^^^^^^^^^^^^^^^^^^^
  97
  98 +---------------------------------------------------------------+
  99 +---------------------------------------------------------------+
 100 | .. module:: SetPyram                                          |
 101 |                                                               |
 102 | **SetPyram(option)**                                          |
 103 |                                                               |
 104 |     - ``option`` : entier précisant le statut des pyramides   |
 105 |       éventuellement présentes dans le maillage initial       |
 106 |                                                               |
 107 |         * 0 : pyramides refusées (défaut)                     |
 108 |         * 1 : pyramides autorisées                            |
 109 +---------------------------------------------------------------+
 110 | .. module:: GetPyram                                          |
 111 |                                                               |
 112 | **GetPyram()**                                                |
 113 |     Retourne le statut accordé aux pyramides éventuellement   |
 114 |     présentes dans le maillage initial                        |
 115 +---------------------------------------------------------------+
 116
 117
 118 Exemple
 119 """""""
 120 La création de l'objet case_1 se fait ainsi : ::
 121
 122     case_name = "CAS_1"
 123     mesh_name = "MAILL"
 124     mesh_file = "/local00/Salome/Adapt/m0.med"
 125     case_1 = homard.CreateCase(case_name, mesh_name, mesh_file)
 126     dirname = "/local00/Salome/Adapt/resu"
 127     case_1.SetDirName(dirname)
 128     case_1.SetConfType(1)
 129     case_1.AddBoundaryGroup( 'intersection', '' )
 130     case_1.AddBoundaryGroup( 'cyl_1', 'T1_EXT' )
 131     case_1.AddBoundaryGroup( 'cyl_1', 'T2_EXT' )
 132     case_1.AddBoundaryGroup( 'cyl_2', 'T_INT' )
 133
 134
 135
 136 Saisie graphique correspondante
 137 """""""""""""""""""""""""""""""
 138 Consulter :ref:`gui_create_case`
 139
 140