From: Gerald NICOLAS Date: Mon, 15 Jan 2018 10:37:56 +0000 (+0100) Subject: Documentation en français X-Git-Tag: V9_0_0^2~5 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=944dcb3ee421b09b4d5e3208e43d7d173eb95285;p=modules%2Fhomard.git Documentation en français --- diff --git a/doc/fr/gui_create_boundary.rst b/doc/fr/gui_create_boundary.rst index f2cb2bc0..5bd55ac0 100644 --- a/doc/fr/gui_create_boundary.rst +++ b/doc/fr/gui_create_boundary.rst @@ -4,26 +4,52 @@ La frontière ############ .. index:: single: boundary .. index:: single: frontière +.. index:: single: CAO L'objet frontière contient toutes les définitions géométriques permettant de décrire une frontière courbe à suivre. Il existe deux modes de description d'une frontière : - - Discrète : ce mode est utilisé pour décrire une courbe 1D - - Analytique : ce mode est utilisé pour décrire une surface + - CAO : la frontière est issue de la géométrie du domaine + - Non CAO : si on ne dispose pas de la géométrie, on peut approcher la frontière par des descriptions : + * Discrète : pour décrire l'ensemble des courbes 1D composant la frontière + * Analytique : pour décrire chaque surface composant la frontière + +Le choix est exclusif : + +.. image:: images/create_boundary_1.png + :align: center + +Frontière CAO +************* + +Le suivi d'une frontière CAO se fera en sélectionnant une frontière choisie dans la liste des frontières CAO enregistrées. + +Au démarrage, la liste est vide. Il faut créer une première frontière CAO par activation du bouton "*Nouveau*" : + +.. image:: images/create_boundary_cao_1.png + :align: center + +La fenêtre proposée invite au choix d'un fichier contenant une CAO au format XAO. Cette est celle de la géométrie qui est le support du maillage. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière, quel que soit son type. + +.. image:: images/create_boundary_cao_2.png + :align: center + +.. note:: + La cohérence entre cette CAO et le maillage initial n'est pas contrôlée. Frontière discrète ****************** -Le suivi d'une frontière discrète se fera en sélectionnant une frontière choisie dans la liste des frontières discrètes existantes. +Le suivi d'une frontière discrète se fera en sélectionnant une frontière choisie dans la liste des frontières discrètes enregistrées. Au démarrage, la liste est vide. Il faut créer une première frontière discrète par activation du bouton "*Nouveau*" : .. image:: images/create_boundary_di_1.png :align: center -La fenêtre proposée invite au choix d'un fichier de maillage. Ce maillage est celui de toutes les lignes constituant la frontière. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière. +La fenêtre proposée invite au choix d'un fichier de maillage. Ce maillage est celui de toutes les lignes constituant la frontière. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière, quel que soit son type. .. image:: images/create_boundary_di_2.png :align: center @@ -86,7 +112,7 @@ Un cylindre =========== .. index:: single: cylindre -Le cylindre est défini par un point de l'axe, son axe et son rayon. L'axe est défini par un vecteur. La norme de ce vecteur n'est pas nécessairement égale à 1 ; de même, son orientation n'a aucune importance. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière. +Le cylindre est défini par un point de l'axe, son axe et son rayon. L'axe est défini par un vecteur. La norme de ce vecteur n'est pas nécessairement égale à 1 ; de même, son orientation n'a aucune importance. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière, quel que soit son type. .. image:: images/create_boundary_an_cy.png :align: center @@ -95,7 +121,7 @@ Une sphère ========== .. index:: single: sphere -La sphère est définie par son centre et son rayon. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière. +La sphère est définie par son centre et son rayon. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière, quel que soit son type. .. image:: images/create_boundary_an_sp.png :align: center @@ -104,7 +130,7 @@ Un cône ======= .. index:: single: cone -Un cône est défini de deux manières différentes : le centre, l'axe et l'angle d'ouverture en degré ou par deux points centrés sur l'axe et le rayon associé. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière. +Un cône est défini de deux manières différentes : le centre, l'axe et l'angle d'ouverture en degré ou par deux points centrés sur l'axe et le rayon associé. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière, quel que soit son type. Création par une origine, un axe et un angle d'ouverture : @@ -120,7 +146,7 @@ Un tore ======= .. index:: single: tore -Le tore est défini par son centre, son axe, le rayon de révolution et le rayon primaire. L'axe est défini par un vecteur. La norme de ce vecteur n'est pas nécessairement égale à 1 ; de même, son orientation n'a aucune importance. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière. +Le tore est défini par son centre, son axe, le rayon de révolution et le rayon primaire. L'axe est défini par un vecteur. La norme de ce vecteur n'est pas nécessairement égale à 1 ; de même, son orientation n'a aucune importance. Un nom de frontière est proposé automatiquement : Boun_1, Boun_2, etc. Ce nom peut être modifié. Il ne doit pas avoir déjà été utilisé pour une autre frontière, quel que soit son type. .. image:: images/create_boundary_an_to.png :align: center @@ -131,7 +157,7 @@ L'arbre d'étude A l'issue de cette création de frontières, l'arbre d'études a été enrichi. On y trouve toutes les frontières créées, identifiées par leur nom, avec la possibilité de les éditer. -.. image:: images/create_boundary_1.png +.. image:: images/create_boundary.png :align: center diff --git a/doc/fr/gui_create_case.rst b/doc/fr/gui_create_case.rst index 0e41fc22..9f0ff88f 100644 --- a/doc/fr/gui_create_case.rst +++ b/doc/fr/gui_create_case.rst @@ -66,12 +66,15 @@ Quand le bord du domaine est courbe, HOMARD sait placer les nouveaux noeuds sur Deux cas de figure sont présents : -* courbe 1D : cette courbe peut être définie dans un plan, par exemple pour un calcul 2D. Elle peut également être définie dans l'espace 3D, par exemple pour l'intersection de deux surfaces. Une ligne à suivre est décrite de manière discrète. -* surface : une surface à suivre est décrite de manière analytique. +- CAO : la CAO du domaine associé au maillage est disponible. Le calcul s'appuiera sur elle pour réaliser les projections. +- Pas de CAO : en l'absence de CAO, il est possible d'avoir une version approchée des frontières : -On cochera le ou les boutons voulus : + * courbe 1D : cette courbe peut être définie dans un plan, par exemple pour un calcul 2D. Elle peut également être définie dans l'espace 3D, par exemple pour l'intersection de deux surfaces. Une ligne à suivre est décrite de manière discrète. + * surface : une surface à suivre est décrite de manière analytique. -.. image:: images/create_case_5.png +On cochera le bouton voulu : + +.. image:: images/create_boundary_1.png :align: center La définition des frontières est décrite dans :doc:`gui_create_boundary`. diff --git a/doc/fr/images/create_boundary_1.png b/doc/fr/images/create_boundary_1.png index 0460d485..5ac25733 100644 Binary files a/doc/fr/images/create_boundary_1.png and b/doc/fr/images/create_boundary_1.png differ diff --git a/doc/fr/images/create_boundary_an_1.png b/doc/fr/images/create_boundary_an_1.png index 09630eb8..e46aaf4f 100644 Binary files a/doc/fr/images/create_boundary_an_1.png and b/doc/fr/images/create_boundary_an_1.png differ diff --git a/doc/fr/images/create_boundary_di_1.png b/doc/fr/images/create_boundary_di_1.png index 8f80605d..cbfc1dbf 100644 Binary files a/doc/fr/images/create_boundary_di_1.png and b/doc/fr/images/create_boundary_di_1.png differ diff --git a/doc/fr/images/create_case_5.png b/doc/fr/images/create_case_5.png deleted file mode 100644 index 418535b5..00000000 Binary files a/doc/fr/images/create_case_5.png and /dev/null differ diff --git a/doc/fr/images/intro_31.png b/doc/fr/images/intro_31.png index 175264e0..0b01550b 100644 Binary files a/doc/fr/images/intro_31.png and b/doc/fr/images/intro_31.png differ diff --git a/doc/fr/images/intro_32.png b/doc/fr/images/intro_32.png index f4022ca2..e71d7d6f 100644 Binary files a/doc/fr/images/intro_32.png and b/doc/fr/images/intro_32.png differ diff --git a/doc/fr/images/intro_33.png b/doc/fr/images/intro_33.png index a0bd05e2..2c25cb89 100644 Binary files a/doc/fr/images/intro_33.png and b/doc/fr/images/intro_33.png differ diff --git a/doc/fr/images/intro_34.png b/doc/fr/images/intro_34.png index 94866890..e3124af2 100644 Binary files a/doc/fr/images/intro_34.png and b/doc/fr/images/intro_34.png differ diff --git a/doc/fr/images/intro_39.png b/doc/fr/images/intro_39.png index ad542ba7..45ab1077 100644 Binary files a/doc/fr/images/intro_39.png and b/doc/fr/images/intro_39.png differ diff --git a/doc/fr/tui_create_boundary.rst b/doc/fr/tui_create_boundary.rst index 6b963767..426bd5e7 100644 --- a/doc/fr/tui_create_boundary.rst +++ b/doc/fr/tui_create_boundary.rst @@ -16,6 +16,14 @@ Ces méthodes retournent une instance de la classe boundary. +----------------------------------------------------------------------------------------+ +----------------------------------------------------------------------------------------+ +| .. module:: CreateBoundaryCAO | +| | +| **CreateBoundaryCAO(boundary_name, xao_file)** | +| Retourne une instance de la classe ``boundary`` de type CAO après sa création | +| | +| - ``boundary_name`` : le nom de la frontière CAO | +| - ``xao_file`` : le nom du fichier contenant cette CAO, au format XAO | ++----------------------------------------------------------------------------------------+ | .. module:: CreateBoundaryDi | | | | **CreateBoundaryDi(boundary_name, mesh_name, mesh_file)** | @@ -23,7 +31,7 @@ Ces méthodes retournent une instance de la classe boundary. | | | - ``boundary_name`` : le nom de la frontière discrète | | - ``mesh_name`` : le nom du maillage de la frontière | -| - ``mesh_file`` : le nom du fichier contenant ce maillage | +| - ``mesh_file`` : le nom du fichier contenant ce maillage, au format MED | +----------------------------------------------------------------------------------------+ | .. module:: CreateBoundaryCylinder | | | @@ -106,20 +114,24 @@ Voir également dans :doc:`tui_create_case`. +---------------------------------------------------------------+ +---------------------------------------------------------------+ -| .. module:: AddBoundaryGroup | +| .. module:: AddBoundary | | | -| **AddBoundaryGroup(boundary, group)** | +| **AddBoundary(boundary)** | | Ajoute une frontière à la définition du cas | | | | - ``boundary`` : nom d'une frontière courbe à suivre | ++---------------------------------------------------------------+ +| .. module:: AddBoundaryGroup | +| | +| **AddBoundaryGroup(boundary, group)** | +| Ajoute une frontière à la définition du cas en précisant | +| les groupes associés | | | -| Pour une frontière discrète : | +| - ``boundary`` : nom d'une frontière courbe à suivre | | | -| . si toutes les lignes courbes sont suivies, le second | -| argument est une chaîne vide. | +| Pour une frontière discrète ou CAO : | | | -| . si seulement certaines lignes courbes sont suivies, | -| ``group`` est le nom d'un groupe de segments à suivre. | +| - ``group`` : nom d'un groupe de mailles à suivre | | | | Pour une frontière analytique : | | | @@ -142,6 +154,7 @@ Méthodes de la classe boundary | **GetType()** | | Retourne le type de la frontière : | | | +| * -1 : CAO | | * 0 : discrète | | * 1 : cylindre | | * 2 : sphère | @@ -159,9 +172,11 @@ Méthodes de la classe boundary | .. module:: Delete | | | | **Delete()** | -| Detruit la frontière. | +| Détruit la frontière. | | Pour une frontière discrète, le fichier du maillage | | associé est conservé. | +| Pour une frontière CAO, le fichier de la géométrie | +| associée est conservé. | | | | Retourne un entier : | | * 0 : destruction réussie | @@ -171,7 +186,11 @@ Méthodes de la classe boundary Exemple ******* -Création d'une frontière discrète, d'une frontière sphèrique, puis d'une frontière cylindrique : :: +Création d'une frontière CAO : :: + + la_cao = homard.CreateBoundaryCAO("BLOC", dircase+'/tutorial_6.xao') + +Création d'une frontière discrète, d'une frontière sphérique, puis d'une frontière cylindrique : :: inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med') fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5) diff --git a/doc/fr/tui_create_case.rst b/doc/fr/tui_create_case.rst index a795348d..d6615eab 100644 --- a/doc/fr/tui_create_case.rst +++ b/doc/fr/tui_create_case.rst @@ -103,16 +103,16 @@ Méthodes de la classe cas | .. module:: SetDirName | | | | **SetDirName(dirname)** | -| 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 | +| Affecte le répertoire des résultats 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 | +| - ``dirname`` : le nom du répertoire des résultats | +---------------------------------------------------------------+ | .. module:: GetDirName | | | | **GetDirName()** | -| Retourne le nom du répertoire des résutats associé au cas | +| Retourne le nom du répertoire des résultats associé au cas| +---------------------------------------------------------------+ | .. module:: SetConfType | | | diff --git a/doc/fr/tui_create_hypothese.rst b/doc/fr/tui_create_hypothese.rst index d048cbba..fcc483f1 100644 --- a/doc/fr/tui_create_hypothese.rst +++ b/doc/fr/tui_create_hypothese.rst @@ -151,7 +151,7 @@ Le champ de pilotage de l'adaptation et les seuils | * 4 : moyenne + n fois l'écart-type | | | | - ``threshold`` : valeur numérique entrant dans la | -| définition du seuil | +| définition du seuil | +---------------------------------------------------------------+ | .. module:: GetRefinThrType | | | diff --git a/doc/fr/tui_create_iteration.rst b/doc/fr/tui_create_iteration.rst index 0c3b1be0..2f928e67 100644 --- a/doc/fr/tui_create_iteration.rst +++ b/doc/fr/tui_create_iteration.rst @@ -152,7 +152,7 @@ Généralités | .. module:: GetDirName | | | | **GetDirName()** | -| Retourne le nom du répertoire des résutats associé à | +| Retourne le nom du répertoire des résultats associé à | | l'itération | +---------------------------------------------------------------+ | .. module:: Delete | diff --git a/doc/fr/tutorials.rst b/doc/fr/tutorials.rst index 3cda6c84..5562fb6f 100644 --- a/doc/fr/tutorials.rst +++ b/doc/fr/tutorials.rst @@ -36,7 +36,8 @@ On fera ici trois raffinements uniformes successifs du maillage contenu dans le * le maillage produit porte toujours le même nom. Cela ne pose pas de problème car il est stocké dans des fichiers différents. .. literalinclude:: ../files/tutorial_1.py - :lines: 52-85 + :start-after: Début des commandes + :end-before: Fin des commandes .. note:: Téléchargement des fichiers @@ -53,7 +54,8 @@ Raffinement par des zones On procède ici au raffinement selon des zones. Pour passer du maillage initial au maillage 'M_1', on utilise une boîte encadrant le plan z=1 et une sphère centrée sur l'origine de rayon 1.05. Puis pour passer du maillage 'M_1' au maillage 'M_2', on remplace la sphère par une boîte encadrant le cube de côté 0.5, pointant sur l'origine et on déraffine les mailles contenues dans la toute première zone. .. literalinclude:: ../files/tutorial_2.py - :lines: 52-95 + :start-after: Début des commandes + :end-before: Fin des commandes .. note:: Téléchargement des fichiers @@ -71,7 +73,8 @@ On procède ici au raffinement selon un champ. Les hypothèses servent à défin Pour adapter le maillage H_1 issu de l'itération Iter_1, deux variantes sont appliquées. Dans la première, Iter_2, le champ est un champ scalaire d'indicateurs d'erreur et on découpe les 1.5% de mailles où l'erreur est la plus grande. Dans la seconde variante, Iter_2_bis, on se base sur un champ vectoriel et on examine le saut de ce vecteur entre une maille et ses voisines : on découpera là où la norme infinie de ce saut est supérieure au seuil absolu de 0.0001. .. literalinclude:: ../files/tutorial_3.py - :lines: 52-124 + :start-after: Début des commandes + :end-before: Fin des commandes .. note:: Téléchargement des fichiers @@ -84,24 +87,43 @@ Pour adapter le maillage H_1 issu de l'itération Iter_1, deux variantes sont ap Suivi de frontières courbes *************************** -.. index:: single: champ +.. index:: single: frontière +.. index:: single: CAO .. index:: single: YACS -On teste ici le suivi des frontières courbes : des frontières analytiques pour décrire les différentes surfaces des tuyaux et une frontière discrète pour décrire les lignes d'intersection des deux tuyaux. Le pilotage du raffinement est le suivant : raffinement uniforme de toutes les mailles contenues dans des groupes désignés. On commence par raffiner les faces internes aux tuyaux ; ensuite, on raffine deux fois de suite les faces externes aux tuyaux. +On teste ici le suivi des frontières courbes en fournissant la géométrie représentée par la CAO de la pièce. Cette CAO est fournie dans un fichier au format XAO. +Le pilotage du raffinement est le suivant : raffinement uniforme de toutes les mailles contenues dans des groupes désignés. On commence par raffiner les faces internes aux tuyaux ; ensuite, on raffine deux fois de suite les faces externes aux tuyaux. Le schéma YACS réalisant cette adaptation est téléchargeable. .. literalinclude:: ../files/tutorial_4.py - :lines: 52-111 + :start-after: Début des commandes + :end-before: Fin des commandes .. note:: Téléchargement des fichiers * :download:`maillage initial<../files/tutorial_4.00.med.gz>` - * :download:`maillage de la frontière discrète<../files/tutorial_4.fr.med.gz>` + * :download:`la frontière en CAO<../files/tutorial_4.xao.gz>` * :download:`commandes python<../files/tutorial_4.py>` * :download:`commandes python de l'utilitaire de compression<../files/tutorial_util.py>` * :download:`schéma YACS<../files/tutorial_4.xml>` +Si la géométrie sous forme de CAO n'est pas disponible, on peut l'approcher ainsi : +des frontières analytiques pour décrire les différentes surfaces des tuyaux et une frontière discrète pour décrire les lignes d'intersection des deux tuyaux. Il suffit de remplacer la définition des frontières. + +.. literalinclude:: ../files/tutorial_6.py + :start-after: Début des commandes + :end-before: Fin des commandes + +.. note:: + Téléchargement des fichiers + + * :download:`maillage initial<../files/tutorial_4.00.med.gz>` + * :download:`maillage de la frontière discrète<../files/tutorial_6.fr.med.gz>` + * :download:`commandes python<../files/tutorial_6.py>` + * :download:`commandes python de l'utilitaire de compression<../files/tutorial_util.py>` + * :download:`schéma YACS<../files/tutorial_6.xml>` + Instructions spécifiques au 2D ****************************** @@ -111,7 +133,8 @@ Les instructions pour adapter un maillage 2D sont exactement identiques à celle Dans le cas présenté ici, on raffine une première fois toutes les mailles contenues dans un disque percé, puis dans une seconde itération, toutes les mailles contenues dans un rectangle. On notera l'utilisation du suivi des frontières circulaires du domaine. .. literalinclude:: ../files/tutorial_5.py - :lines: 52-95 + :start-after: Début des commandes + :end-before: Fin des commandes .. note:: Téléchargement des fichiers