+---------------------------------------------------------------+
+---------------------------------------------------------------+
-| .. module:: CreateIteration |
+| .. module:: GetIteration |
| |
-| **CreateIteration(iter_name, iter_parent_name)** |
-| Retourne une instance de la classe ``iteration`` après |
-| sa création |
+| **GetIteration(iter_name)** |
+| Retourne l'instance de la classe ``iteration`` connue par |
+| son nom |
| |
| - ``iter_name`` : le nom de l'itération |
-| - ``iter_parent_name`` : le nom de l'itération mère |
++---------------------------------------------------------------+
+| .. module:: GetAllIterationsName |
| |
-| Par défaut : |
+| **GetAllIterationsName()** |
+| Retourne la liste des noms de toutes les itérations créées|
| |
-| * le maillage produit a le même nom que l'itération |
+---------------------------------------------------------------+
-| .. module:: AssociateIterHypo |
+
+Méthodes de la classe cas
+"""""""""""""""""""""""""
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: NextIteration |
| |
-| **AssociateIterHypo(iter_name, hypo_name)** |
-| Associe une hypothèse à une itération |
+| **NextIteration(iter_name)** |
+| Retourne une instance de la classe ``iteration`` après |
+| sa création : elle suit immédiatement l'itération |
+| initiale, correspondant au maillage définissant le cas |
| |
-| - ``iter_name`` : le nom de l'itération |
-| - ``hypo_name`` : le nom de l'hypothèse à associer |
-+---------------------------------------------------------------+
-| .. module:: GetIteration |
+| - ``iter_name`` : le nom à donner à la nouvelle itération |
| |
-| **GetIteration(iter_name)** |
-| Retourne l'instance de la classe ``iteration`` connue par |
-| son nom |
+| Par défaut : |
| |
-| - ``iter_name`` : le nom de l'itération |
+| * le maillage produit a le même nom que l'itération |
+---------------------------------------------------------------+
-| .. module:: GetAllIterations |
+| .. module:: LastIteration |
| |
-| **GetAllIterations()** |
-| Retourne la liste des noms de toutes les itérations créées|
+| **LastIteration()** |
+| Retourne une instance de la classe ``iteration`` : la |
+| dernière créée dans la descendance de l'itération initiale|
+| du cas. C'est celle qui est sans fille. Il y a erreur s'il|
+| existe plus d'une branche dans la descendance. |
| |
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
-| .. index:: single: Compute |
+| .. module:: NextIteration |
+| |
+| **NextIteration(iter_name)** |
+| Retourne une instance de la classe ``iteration`` qui suit |
+| l'itération courante |
+| |
+| - ``iter_name`` : le nom à donner à la nouvelle itération |
+| |
+| Par défaut : |
+| |
+| * le maillage produit a le même nom que l'itération |
++---------------------------------------------------------------+
+| .. module:: Compute |
| |
-| **Compute(option)** |
+| **Compute(option1, option2)** |
| Calcule le maillage correspondant à l'itération |
| |
-| - ``option`` : un entier précisant ce qui se passe quand |
+| - ``option1`` : un entier précisant ce qui se passe quand |
| des fichiers de résultats existent déjà |
| |
| * 0 : arrêt en erreur |
| * 1 : écrasement des anciens fichiers |
| |
+| - ``option2`` : un entier précisant ce qui est fait des |
+| résultats |
+| |
+| * 1 : aucune action particulière |
+| * 2 : publication dans le module SMESH |
+| |
| Retourne un entier : |
| * 0 : adaptation réussie |
| * autre valeur : problème |
| .. module:: GetIterParent |
| |
| **GetIterParent()** |
-| Retourne le nom de l'itération mère |
+| Retourne l'itération mère |
++---------------------------------------------------------------+
+| .. module:: LastIteration |
+| |
+| **LastIteration()** |
+| Retourne une instance de la classe ``iteration`` : la |
+| dernière créée dans la descendance de l'itération. C'est |
+| celle qui est sans fille. Il y a erreur s'il existe plus |
+| d'une branche dans la descendance. |
++---------------------------------------------------------------+
+| .. module:: AssociateHypo |
+| |
+| **AssociateHypo(hypo_name)** |
+| Associe une hypothèse à l'itération |
+| |
+| - ``hypo_name`` : le nom de l'hypothèse à associer |
+---------------------------------------------------------------+
| .. module:: GetHypoName |
| |
| **GetState()** |
| Retourne l'état de l'itération |
| |
-| - ``0`` : itération non calculée |
-| - ``1`` : itération calculée correctement |
+| - ``2`` : itération calculée correctement |
+| - ``1`` : itération non calculée |
+| - ``<=0`` : itération initiale à ne pas calculer, de |
+| numéro valant la valeur absolue de l'état |
++---------------------------------------------------------------+
+| .. module:: GetLogFile |
+| |
+| **GetLogFile()** |
+| Retourne le nom du fichier retraçant le déroulement de |
+| l'exécution de HOMARD |
++---------------------------------------------------------------+
+| .. module:: GetFileInfo |
+| |
+| **GetFileInfo()** |
+| Retourne le nom du fichier contenant l'analyse du maillage|
++---------------------------------------------------------------+
+| .. module:: GetDirName |
+| |
+| **GetDirName()** |
+| Retourne le nom du répertoire des résutats associé à |
+| l'itération |
++---------------------------------------------------------------+
+| .. module:: Delete |
+| |
+| **Delete(option)** |
+| Detruit l'itération et toutes ses filles éventuelles. |
+| |
+| - ``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 |
+---------------------------------------------------------------+
Informations sur les maillages
+---------------------------------------------------------------+
+---------------------------------------------------------------+
+| .. module:: SetMeshName |
+| |
+| **SetMeshName(mesh_name)** |
+| Définit le nom du maillage produit |
+| |
+| - ``mesh_name`` : le nom du maillage produit |
++---------------------------------------------------------------+
| .. module:: GetMeshName |
| |
| **GetMeshName()** |
| **GetMeshFile()** |
| Retourne le nom du fichier du maillage produit |
+---------------------------------------------------------------+
+| .. 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 |
++---------------------------------------------------------------+
Informations sur le champ
^^^^^^^^^^^^^^^^^^^^^^^^^
| **SetTimeStepRank(TimeStep, Rank)** |
| Définit les instants pour le champ |
| |
+| Si un seul instant est défini pour le champ, il est pris |
+| par défaut. |
+| |
| Inutile si aucun instant n'est défini pour le champ |
| |
| - ``TimeStep`` : l'instant où est pris le champ |
| - ``Rank`` : le numéro d'ordre où est pris le champ |
+---------------------------------------------------------------+
+| .. module:: SetTimeStepRankLast |
+| |
+| **SetTimeStepRankLast()** |
+| Précise que le dernier instant enregistré pour le champ |
+| est utilisé |
++---------------------------------------------------------------+
| .. module:: GetFieldFileName |
| |
| **GetFieldFileName()** |
"""""""
.. index:: single: maillage;initial
-Pour la création de la première itération, il faut récupérer le nom qui a été donné à celle qui correspond au maillage initial. Ce nom s'obtient avec la méthode ``GetIter0Name`` appliquée au cas. ::
+Pour la création de la première itération, on part de celle qui correspond au maillage initial. C'est celle contenue dans le cas. ::
iter_name = "Iteration_1"
- iter_1 = homard.CreateIteration(iter_name, case_1.GetIter0Name())
+ iter_1 = case_1.NextIteration(iter_name)
iter_1.SetField(field_file)
iter_1.SetTimeStepRank( 0, 0)
iter_1.SetMeshName("maill_01")
iter_1.SetMeshFile("/local00/M.01.med")
- homard.AssociateIterHypo(iter_name, "HypoField")
- codret = iter_1.Compute(1)
+ iter_1.AssociateHypo("HypoField")
+ codret = iter_1.Compute(1, 2)
-Pour la création d'une itération suivante, on donnera le nom de l'itération parent de laquelle on part. ::
+Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
iter_name = "Iteration_2"
- iter_2 = homard.CreateIteration(iter_name, "Iteration_1")
+ iter_2 = iter_1.NextIteration(iter_name)
iter_2.SetField(field_file)
iter_2.SetTimeStepRank( 1, 1)
iter_2.SetMeshName("maill_02")
iter_2.SetMeshFile("/local00/M.02.med")
- homard.AssociateIterHypo(iter_name, "HypoField")
- codret = iter_2.Compute(1)
+ iter_2.AssociateHypo("HypoField")
+ codret = iter_2.Compute(1, 2)
Saisie graphique correspondante
