Méthodes de la classe homard
""""""""""""""""""""""""""""
+Création d'un cas
+^^^^^^^^^^^^^^^^^
+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: CreateCase |
| |
| - ``case_name`` : le nom du cas |
+---------------------------------------------------------------+
-| .. module:: GetAllCases |
+| .. module:: GetAllCasesName |
| |
-| **GetAllCases()** |
+| **GetAllCasesName()** |
| Retourne la liste des noms de tous les cas créés |
| |
+---------------------------------------------------------------+
+Création d'un cas par poursuite d'une itération calculée
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: CreateCaseFromIteration |
+| |
+| **CreateCaseFromIteration(case_name, dir_name)** |
+| Retourne une instance de la classe ``cas`` après sa |
+| création |
+| |
+| - ``case_name`` : le nom du cas |
+| - ``dir_name`` : le nom du répertoire contenant |
+| l'itération à poursuivre |
+| |
++---------------------------------------------------------------+
+| .. module:: CreateCaseFromCaseLastIteration |
+| |
+| **CreateCaseFromCaseLastIteration(case_name, dir_name)** |
+| Retourne une instance de la classe ``cas`` après sa |
+| création |
+| |
+| - ``case_name`` : le nom du cas |
+| - ``dir_name`` : le nom du répertoire contenant |
+| le cas à poursuivre |
+| |
++---------------------------------------------------------------+
+| .. module:: CreateCaseFromCaseIteration |
+| |
+| **CreateCaseFromCaseIteration(case_name, dir_name, number)** |
+| Retourne une instance de la classe ``cas`` après sa |
+| création |
+| |
+| - ``case_name`` : le nom du cas |
+| - ``dir_name`` : le nom du répertoire contenant |
+| le cas à poursuivre |
+| - ``number`` : le numéro de l'itération du cas |
+| |
++---------------------------------------------------------------+
+
+
Méthodes de la classe cas
"""""""""""""""""""""""""
| .. module:: SetDirName |
| |
| **SetDirName(dirname)** |
-| Affecte le répertoire des résutats associé au cas |
+| Affecte le répertoire des résutats associé au cas. Cela ne|
+| peut se faire qu'après la création du cas et avant le |
+| premier calcul. |
| |
| - ``dirname`` : le nom du répertoire des résutats |
+---------------------------------------------------------------+
| **GetConfType()** |
| Retourne le type de conformité |
+---------------------------------------------------------------+
-| .. module:: GetIter0Name |
+| .. module:: GetIter0 |
| |
-| **GetIter0Name()** |
-| Retourne le nom de l'itération 0, associée au maillage |
-| initial. Ce nom est créé automatiquement par le module |
-| HOMARD et doit être utilisé pour enchaîner les adaptations|
+| **GetIter0()** |
+| Retourne l'itération associée au maillage initial. |
+| Cette itération est créée automatiquement par le module |
+| HOMARD et est utilisée pour enchaîner les adaptations. |
+| Elle correspond à un maillage initial ou à une itération |
+| de poursuite d'un cas précédent. |
+---------------------------------------------------------------+
| .. module:: AddBoundaryGroup |
| |
| - ``group`` : nom d'un groupe de faces placées sur la |
| frontière |
+---------------------------------------------------------------+
+| .. module:: Delete |
+| |
+| **Delete(option)** |
+| Detruit le cas et toutes les itérations associées. Le |
+| fichier du maillage initial associé est conservé. |
+| |
+| - ``option`` : un entier précisant ce qui est fait des |
+| fichiers de maillage associés |
+| |
+| * 0 : les fichiers sont conservés |
+| * 1 : les fichiers sont détruits |
+| |
+| Retourne un entier : |
+| * 0 : destruction réussie |
+| * autre valeur : problème |
++---------------------------------------------------------------+
+| .. module:: GetState |
+| |
+| **GetState()** |
+| Retourne l'état du cas : |
+| * 0 : correspond à un maillage initial |
+| * autre valeur : poursuite d'une itération de numéro n|
++---------------------------------------------------------------+
Les options avancées
^^^^^^^^^^^^^^^^^^^^
| présentes dans le maillage initial |
+---------------------------------------------------------------+
+Informations sur le maillage initial
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: MeshInfo |
+| |
+| **MeshInfo(Qual, Diam, Conn, Tail, Inte)** |
+| Donne des informations sur le maillage. Pour chaque |
+| option, le choix 0 correspond à ne rien faire, alors que |
+| le choix 1 active l'option. |
+| |
+| - ``Qual`` : qualité des mailles |
+| - ``Diam`` : diamètre des mailles |
+| - ``Conn`` : connexité du domaine ; en un seul morceau, |
+| combien de trous, etc. |
+| - ``Tail`` : tailles des constituants du domaine, groupe |
+| par groupe |
+| - ``Inte`` : interpénétration des mailles, par dimension |
++---------------------------------------------------------------+
+
Exemple
"""""""
