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 Création d'un cas
  15 ^^^^^^^^^^^^^^^^^
  16
  17 +---------------------------------------------------------------+
  18 +---------------------------------------------------------------+
  19 | .. module:: CreateCase                                        |
  20 |                                                               |
  21 | **CreateCase(case_name, mesh_name, mesh_file)**               |
  22 |     Retourne une instance de la classe ``cas`` après sa       |
  23 |     création                                                  |
  24 |                                                               |
  25 |     - ``case_name`` : le nom du cas                           |
  26 |     - ``mesh_name`` : le nom du maillage initial              |
  27 |     - ``mesh_file`` : le nom du fichier contenant ce maillage |
  28 |                                                               |
  29 | Par défaut :                                                  |
  30 |                                                               |
  31 |  * le répertoire des résultats est ``/tmp``                   |
  32 |  * l'adaptation est conforme                                  |
  33 +---------------------------------------------------------------+
  34 | .. module:: GetCase                                           |
  35 |                                                               |
  36 | **GetCase(case_name)**                                        |
  37 |     Retourne l'instance de la classe ``cas`` connue par       |
  38 |     son nom                                                   |
  39 |                                                               |
  40 |     - ``case_name`` : le nom du cas                           |
  41 +---------------------------------------------------------------+
  42 | .. module:: GetAllCasesName                                   |
  43 |                                                               |
  44 | **GetAllCasesName()**                                         |
  45 |     Retourne la liste des noms de tous les cas créés          |
  46 |                                                               |
  47 +---------------------------------------------------------------+
  48
  49 Création d'un cas par poursuite d'une itération calculée
  50 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  51
  52 +---------------------------------------------------------------+
  53 +---------------------------------------------------------------+
  54 | .. module:: CreateCaseFromIteration                           |
  55 |                                                               |
  56 | **CreateCaseFromIteration(case_name, dir_name)**              |
  57 |     Retourne une instance de la classe ``cas`` après sa       |
  58 |     création                                                  |
  59 |                                                               |
  60 |     - ``case_name`` : le nom du cas                           |
  61 |     - ``dir_name``  : le nom du répertoire contenant          |
  62 |       l'itération à poursuivre                                |
  63 |                                                               |
  64 +---------------------------------------------------------------+
  65 | .. module:: CreateCaseFromCaseLastIteration                   |
  66 |                                                               |
  67 | **CreateCaseFromCaseLastIteration(case_name, dir_name)**      |
  68 |     Retourne une instance de la classe ``cas`` après sa       |
  69 |     création                                                  |
  70 |                                                               |
  71 |     - ``case_name`` : le nom du cas                           |
  72 |     - ``dir_name``  : le nom du répertoire contenant          |
  73 |       l'itération à poursuivre                                |
  74 |                                                               |
  75 +---------------------------------------------------------------+
  76 | .. module:: CreateCaseFromCaseIteration                       |
  77 |                                                               |
  78 | **CreateCaseFromCaseIteration(case_name, dir_name, number)**  |
  79 |     Retourne une instance de la classe ``cas`` après sa       |
  80 |     création                                                  |
  81 |                                                               |
  82 |     - ``case_name`` : le nom du cas                           |
  83 |     - ``dir_name``  : le nom du répertoire contenant          |
  84 |       l'itération à poursuivre                                |
  85 |     - ``number`` : le numéro de l'itération du cas            |
  86 |                                                               |
  87 +---------------------------------------------------------------+
  88
  89
  90
  91 Méthodes de la classe cas
  92 """""""""""""""""""""""""
  93
  94 +---------------------------------------------------------------+
  95 +---------------------------------------------------------------+
  96 | .. module:: GetName                                           |
  97 |                                                               |
  98 | **GetName()**                                                 |
  99 |     Retourne le nom du cas                                    |
 100 +---------------------------------------------------------------+
 101 | .. module:: SetDirName                                        |
 102 |                                                               |
 103 | **SetDirName(dirname)**                                       |
 104 |     Affecte le répertoire des résutats associé au cas. Cela ne|
 105 |     peut se faire qu'après la création du cas et avant le     |
 106 |     premier calcul.                                           |
 107 |                                                               |
 108 |     - ``dirname`` : le nom du répertoire des résutats         |
 109 +---------------------------------------------------------------+
 110 | .. module:: GetDirName                                        |
 111 |                                                               |
 112 | **GetDirName()**                                              |
 113 |     Retourne le nom du répertoire des résutats associé au cas |
 114 +---------------------------------------------------------------+
 115 | .. module:: SetConfType                                       |
 116 |                                                               |
 117 | **SetConfType(conf_type)**                                    |
 118 |     Définit le mode de conformité associé au cas              |
 119 |                                                               |
 120 |     - ``conf_type`` : entier précisant le mode de conformité  |
 121 |                                                               |
 122 |         * 1 : conforme                                        |
 123 |         * 2 : non conforme avec 1 noeud par maille            |
 124 |         * 3 : non conforme avec 1 noeud par arete de maille   |
 125 |         * 4 : non conforme quelconque                         |
 126 +---------------------------------------------------------------+
 127 | .. module:: GetConfType                                       |
 128 |                                                               |
 129 | **GetConfType()**                                             |
 130 |     Retourne le type de conformité                            |
 131 +---------------------------------------------------------------+
 132 | .. module:: GetIter0                                          |
 133 |                                                               |
 134 | **GetIter0()**                                                |
 135 |     Retourne l'itération associée au maillage initial.        |
 136 |     Cette itération est créée automatiquement par le module   |
 137 |     HOMARD et est utilisée pour enchaîner les adaptations.    |
 138 |     Elle correspond à un maillage initial ou à une itération  |
 139 |     de poursuite d'un cas précédent.                          |
 140 +---------------------------------------------------------------+
 141 | .. module:: AddBoundaryGroup                                  |
 142 |                                                               |
 143 | **AddBoundaryGroup(boundary, group)**                         |
 144 |     Ajoute une frontière à la définition du cas               |
 145 |                                                               |
 146 |     - ``boundary`` : nom d'une frontière courbe à suivre      |
 147 |                                                               |
 148 |     Pour une frontière discrète :                             |
 149 |                                                               |
 150 |     . si toutes les lignes courbes sont suivies, le second    |
 151 |       argument est une chaîne vide.                           |
 152 |     . si seulement certaines lignes courbes sont suivies,     |
 153 |       ``group`` est le nom d'un groupe de segments à suivre.  |
 154 |                                                               |
 155 |     Pour une frontière analytique :                           |
 156 |                                                               |
 157 |     - ``group`` : nom d'un groupe de faces placées sur la     |
 158 |       frontière                                               |
 159 +---------------------------------------------------------------+
 160 | .. index:: single: Delete                                     |
 161 |                                                               |
 162 | **Delete()**                                                  |
 163 |     Detruit le cas et toutes les itérations associées ainsi   |
 164 |     que tous les maillages produits. Le fichier du maillage   |
 165 |     initial associé est conservé.                             |
 166 |                                                               |
 167 |     Retourne un entier :                                      |
 168 |         * 0 : destruction réussie                             |
 169 |         * autre valeur : problème                             |
 170 +---------------------------------------------------------------+
 171 | .. module:: GetState                                          |
 172 |                                                               |
 173 | **GetState()**                                                |
 174 |     Retourne l'état du cas :                                  |
 175 |         * 0 : correspond à un maillage initial                |
 176 |         * autre valeur : poursuite d'une itération de numéro n|
 177 +---------------------------------------------------------------+
 178
 179 Les options avancées
 180 ^^^^^^^^^^^^^^^^^^^^
 181
 182 +---------------------------------------------------------------+
 183 +---------------------------------------------------------------+
 184 | .. module:: SetPyram                                          |
 185 |                                                               |
 186 | **SetPyram(option)**                                          |
 187 |     Définit le statut des pyramides pour le cas               |
 188 |                                                               |
 189 |     - ``option`` : entier précisant le statut des pyramides   |
 190 |       éventuellement présentes dans le maillage initial       |
 191 |                                                               |
 192 |         * 0 : pyramides refusées (défaut)                     |
 193 |         * 1 : pyramides autorisées                            |
 194 +---------------------------------------------------------------+
 195 | .. module:: GetPyram                                          |
 196 |                                                               |
 197 | **GetPyram()**                                                |
 198 |     Retourne le statut accordé aux pyramides éventuellement   |
 199 |     présentes dans le maillage initial                        |
 200 +---------------------------------------------------------------+
 201
 202 Informations sur le maillage initial
 203 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 204
 205 +---------------------------------------------------------------+
 206 +---------------------------------------------------------------+
 207 | .. module:: MeshInfo                                          |
 208 |                                                               |
 209 | **MeshInfo(Qual, Diam, Conn, Tail, Inte)**                    |
 210 |     Donne des informations sur le maillage. Pour chaque       |
 211 |     option, le choix 0 correspond à ne rien faire, alors que  |
 212 |     le choix 1 active l'option.                               |
 213 |                                                               |
 214 |     - ``Qual`` : qualité des mailles                          |
 215 |     - ``Diam`` : diamètre des mailles                         |
 216 |     - ``Conn`` : connexité du domaine ; en un seul morceau,   |
 217 |       combien de trous, etc.                                  |
 218 |     - ``Tail`` : tailles des constituants du domaine, groupe  |
 219 |       par groupe                                              |
 220 |     - ``Inte`` : interpénétration des mailles, par dimension  |
 221 +---------------------------------------------------------------+
 222
 223
 224 Exemple
 225 """""""
 226 La création de l'objet case_1 se fait ainsi : ::
 227
 228     case_name = "CAS_1"
 229     mesh_name = "MAILL"
 230     mesh_file = "/local00/Salome/Adapt/m0.med"
 231     case_1 = homard.CreateCase(case_name, mesh_name, mesh_file)
 232     dirname = "/local00/Salome/Adapt/resu"
 233     case_1.SetDirName(dirname)
 234     case_1.SetConfType(1)
 235     case_1.AddBoundaryGroup( 'intersection', '' )
 236     case_1.AddBoundaryGroup( 'cyl_1', 'T1_EXT' )
 237     case_1.AddBoundaryGroup( 'cyl_1', 'T2_EXT' )
 238     case_1.AddBoundaryGroup( 'cyl_2', 'T_INT' )
 239
 240
 241
 242 Saisie graphique correspondante
 243 """""""""""""""""""""""""""""""
 244 Consulter :ref:`gui_create_case`
 245
 246