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