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`` après sa       |
  20 |     création                                                  |
  21 |                                                               |
  22 |     - ``case_name`` : le nom du cas                           |
  23 |     - ``mesh_name`` : le nom du maillage initial              |
  24 |     - ``mesh_file`` : le nom du fichier contenant ce maillage |
  25 |                                                               |
  26 | Par défaut :                                                  |
  27 |                                                               |
  28 |  * le répertoire des résultats est ``/tmp``                   |
  29 |  * l'adaptation est conforme                                  |
  30 +---------------------------------------------------------------+
  31 | .. module:: GetCase                                           |
  32 |                                                               |
  33 | **GetCase(case_name)**                                        |
  34 |     Retourne l'instance de la classe ``cas`` connue par       |
  35 |     son nom                                                   |
  36 |                                                               |
  37 |     - ``case_name`` : le nom du cas                           |
  38 +---------------------------------------------------------------+
  39 | .. module:: GetAllCasesName                                   |
  40 |                                                               |
  41 | **GetAllCasesName()**                                         |
  42 |     Retourne la liste des noms de tous les cas créés          |
  43 |                                                               |
  44 +---------------------------------------------------------------+
  45
  46
  47 Méthodes de la classe cas
  48 """""""""""""""""""""""""
  49
  50 +---------------------------------------------------------------+
  51 +---------------------------------------------------------------+
  52 | .. module:: GetName                                           |
  53 |                                                               |
  54 | **GetName()**                                                 |
  55 |     Retourne le nom du cas                                    |
  56 +---------------------------------------------------------------+
  57 | .. module:: SetDirName                                        |
  58 |                                                               |
  59 | **SetDirName(dirname)**                                       |
  60 |     Affecte le répertoire des résutats associé au cas         |
  61 |                                                               |
  62 |     - ``dirname`` : le nom du répertoire des résutats         |
  63 +---------------------------------------------------------------+
  64 | .. module:: GetDirName                                        |
  65 |                                                               |
  66 | **GetDirName()**                                              |
  67 |     Retourne le nom du répertoire des résutats associé au cas |
  68 +---------------------------------------------------------------+
  69 | .. module:: SetConfType                                       |
  70 |                                                               |
  71 | **SetConfType(conf_type)**                                    |
  72 |     Définit le mode de conformité associé au cas              |
  73 |                                                               |
  74 |     - ``conf_type`` : entier précisant le mode de conformité  |
  75 |                                                               |
  76 |         * 1 : conforme                                        |
  77 |         * 2 : non conforme avec 1 noeud par maille            |
  78 |         * 3 : non conforme avec 1 noeud par arete de maille   |
  79 |         * 4 : non conforme quelconque                         |
  80 +---------------------------------------------------------------+
  81 | .. module:: GetConfType                                       |
  82 |                                                               |
  83 | **GetConfType()**                                             |
  84 |     Retourne le type de conformité                            |
  85 +---------------------------------------------------------------+
  86 | .. module:: GetIter0                                          |
  87 |                                                               |
  88 | **GetIter0()**                                                |
  89 |     Retourne l'itération 0, associée au maillage initial.     |
  90 |     Cette itération est créée automatiquement par le module   |
  91 |     HOMARD et est utilisée pour enchaîner les adaptations.    |
  92 +---------------------------------------------------------------+
  93 | .. module:: AddBoundaryGroup                                  |
  94 |                                                               |
  95 | **AddBoundaryGroup(boundary, group)**                         |
  96 |     Ajoute une frontière à la définition du cas               |
  97 |                                                               |
  98 |     - ``boundary`` : nom d'une frontière courbe à suivre      |
  99 |                                                               |
 100 |     Pour une frontière discrète :                             |
 101 |                                                               |
 102 |     . si toutes les lignes courbes sont suivies, le second    |
 103 |       argument est une chaîne vide.                           |
 104 |     . si seulement certaines lignes courbes sont suivies,     |
 105 |       ``group`` est le nom d'un groupe de segments à suivre.  |
 106 |                                                               |
 107 |     Pour une frontière analytique :                           |
 108 |                                                               |
 109 |     - ``group`` : nom d'un groupe de faces placées sur la     |
 110 |       frontière                                               |
 111 +---------------------------------------------------------------+
 112
 113 Les options avancées
 114 ^^^^^^^^^^^^^^^^^^^^
 115
 116 +---------------------------------------------------------------+
 117 +---------------------------------------------------------------+
 118 | .. module:: SetPyram                                          |
 119 |                                                               |
 120 | **SetPyram(option)**                                          |
 121 |     Définit le statut des pyramides pour le cas               |
 122 |                                                               |
 123 |     - ``option`` : entier précisant le statut des pyramides   |
 124 |       éventuellement présentes dans le maillage initial       |
 125 |                                                               |
 126 |         * 0 : pyramides refusées (défaut)                     |
 127 |         * 1 : pyramides autorisées                            |
 128 +---------------------------------------------------------------+
 129 | .. module:: GetPyram                                          |
 130 |                                                               |
 131 | **GetPyram()**                                                |
 132 |     Retourne le statut accordé aux pyramides éventuellement   |
 133 |     présentes dans le maillage initial                        |
 134 +---------------------------------------------------------------+
 135
 136
 137 Exemple
 138 """""""
 139 La création de l'objet case_1 se fait ainsi : ::
 140
 141     case_name = "CAS_1"
 142     mesh_name = "MAILL"
 143     mesh_file = "/local00/Salome/Adapt/m0.med"
 144     case_1 = homard.CreateCase(case_name, mesh_name, mesh_file)
 145     dirname = "/local00/Salome/Adapt/resu"
 146     case_1.SetDirName(dirname)
 147     case_1.SetConfType(1)
 148     case_1.AddBoundaryGroup( 'intersection', '' )
 149     case_1.AddBoundaryGroup( 'cyl_1', 'T1_EXT' )
 150     case_1.AddBoundaryGroup( 'cyl_1', 'T2_EXT' )
 151     case_1.AddBoundaryGroup( 'cyl_2', 'T_INT' )
 152
 153
 154
 155 Saisie graphique correspondante
 156 """""""""""""""""""""""""""""""
 157 Consulter :ref:`gui_create_case`
 158
 159