X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Ftui_create_case.rst;h=f7ec74735b357bf049706cd930bde5ff8adee364;hb=b33a67ec227afc3111edfbd2487b2f7887a954c8;hp=202c79150cad371176d1bd20176a40ab2a229101;hpb=c61162b66735328e6ef718c72b7685a4b6717de9;p=modules%2Fhomard.git diff --git a/doc/tui_create_case.rst b/doc/tui_create_case.rst index 202c7915..f7ec7473 100644 --- a/doc/tui_create_case.rst +++ b/doc/tui_create_case.rst @@ -16,7 +16,8 @@ M | .. module:: CreateCase | | | | **CreateCase(case_name, mesh_name, mesh_file)** | -| Retourne une instance de la classe cas | +| Retourne une instance de la classe ``cas`` après sa | +| création | | | | - ``case_name`` : le nom du cas | | - ``mesh_name`` : le nom du maillage initial | @@ -27,6 +28,20 @@ M | * le répertoire des résultats est ``/tmp`` | | * l'adaptation est conforme | +---------------------------------------------------------------+ +| .. module:: GetCase | +| | +| **GetCase(case_name)** | +| Retourne l'instance de la classe ``cas`` connue par | +| son nom | +| | +| - ``case_name`` : le nom du cas | ++---------------------------------------------------------------+ +| .. module:: GetAllCases | +| | +| **GetAllCases()** | +| Retourne la liste des noms de tous les cas créés | +| | ++---------------------------------------------------------------+ Méthodes de la classe cas @@ -42,6 +57,7 @@ M | .. module:: SetDirName | | | | **SetDirName(dirname)** | +| Affecte le répertoire des résutats associé au cas | | | | - ``dirname`` : le nom du répertoire des résutats | +---------------------------------------------------------------+ @@ -53,6 +69,7 @@ M | .. module:: SetConfType | | | | **SetConfType(conf_type)** | +| Définit le mode de conformité associé au cas | | | | - ``conf_type`` : entier précisant le mode de conformité | | | @@ -70,12 +87,13 @@ M | | | **GetIter0Name()** | | Retourne le nom de l'itération 0, associée au maillage | -| initial. Ce nom est mis automatiquement par le module | +| initial. Ce nom est créé automatiquement par le module | | HOMARD et doit être utilisé pour enchaîner les adaptations| +---------------------------------------------------------------+ | .. module:: AddBoundaryGroup | | | | **AddBoundaryGroup(boundary, group)** | +| Ajoute une frontière à la définition du cas | | | | - ``boundary`` : nom d'une frontière courbe à suivre | | | @@ -100,6 +118,7 @@ Les options avanc | .. module:: SetPyram | | | | **SetPyram(option)** | +| Définit le statut des pyramides pour le cas | | | | - ``option`` : entier précisant le statut des pyramides | | éventuellement présentes dans le maillage initial |