Le déraffinement est une opération consistant à supprimer des mailles. Il s'agit en fait d'annuler un précédent découpage : on ne reviendra jamais 'plus haut' que le maillage initial.
zone
- Une zone est une région qui définit un pilotage de raffinement : toutes les mailles dont au moins une arête est dans une zone seront raffinées.
+ Une zone est une région qui définit un mode de pilotage de l'adaptation : toutes les mailles dont au moins une arête est dans une zone seront raffinées ou déraffinées selon le choix retenu.
cas
Un cas est défini par un maillage initial et une succession d'adaptations.
Un champ est exprimé sur un maillage, par noeud ou par maille, avec une ou plusieurs composantes. La valeur de ce champ pilote l'adaptation.
MED
- C'est le format d'échange des maillages et des champs pour Salome.
\ No newline at end of file
+ C'est le format d'échange des maillages et des champs pour SALOME.
\ No newline at end of file
.. glossary::
:sorted:
- raffinement
- Le raffinement est une opération consistant à découper les mailles sélectionnées.
+ refinement
+ The refinement is an operation that consists in splitting the selected elements.
- niveau
- Le niveau d'une maille est le nombre de découpages qu'il a fallu pour l'obtenir. Les mailles du maillage initial sont du niveau 0 par convention.
+ level
+ The level of an element corresponds to the number of splitting that were done to obtain it. The levem of the elements in the initial mesh is 0.
- déraffinement
- Le déraffinement est une opération consistant à supprimer des mailles. Il s'agit en fait d'annuler un précédent découpage : on ne reviendra jamais 'plus haut' que le maillage initial.
+ unrefinement
+ The unrefinement is an operation that consists in removing the selected elements. In fact, the objective is to cancel a previous splitting: a 'higher' level than the initial mesh cannot be obtained.
zone
- Une zone est une région qui définit un pilotage de raffinement : toutes les mailles dont au moins une arête est dans une zone seront raffinées.
+ A zone is a region that may govern the adaptation: every element with at least 2 nodes inside the zone is split or removed, depending on the choice.
- cas
- Un cas est défini par un maillage initial et une succession d'adaptations.
+ case
+ A case is defined with an initial mesh and a list of adaptations.
- itération
- Une itération est le processus qui permet de passer d'un maillage à un autre au sein d'un cas. Une itération met en oeuvre du raffinement et/ou du déraffinement selon l'hypothèse qui lui est attachée.
+ iteration
+ An iteration is the process that transform a mesh to another one into a case. An iteration implies refinement and/or unrefinement, following the associated hypothesis.
- hypothèse
- Une hypothèse décrit les conditions de passage d'un maillage à un autre : raffinement et/ou déraffinement, mode de pilotage, etc. Une hypothèse est référencée par une ou plusieurs itérations.
+ hypothesis
+ An hypothesis describes the conditions that governs the modification from a mesh to another one: refinement and/or unrefinement, etc. An hypothesis is referenced by 1 or more iterations.
- champ
- Un champ est exprimé sur un maillage, par noeud ou par maille, avec une ou plusieurs composantes. La valeur de ce champ pilote l'adaptation.
+ field
+ A field is expressed over a mesh, onto node or element, with 1 or more components.
MED
- C'est le format d'échange des maillages et des champs pour Salome.
+ It is the excange format for the meshes and the fields in SALOME.
Frontière analytique
====================
-Au démarrage, Salome affiche un tableau avec un seule colonne. Cette colonne contient la liste de tous les groupes du maillage initial définissant le cas.
+Au démarrage, SALOME affiche un tableau avec un seule colonne. Cette colonne contient la liste de tous les groupes du maillage initial définissant le cas.
.. image:: images/create_boundary_an_1.png
:align: center
Analytical boundary
===================
-Au démarrage, Salome affiche un tableau avec un seule colonne. Cette colonne contient la liste de tous les groupes du maillage initial définissant le cas.
+Au démarrage, SALOME affiche un tableau avec un seule colonne. Cette colonne contient la liste de tous les groupes du maillage initial définissant le cas.
.. image:: images/create_boundary_an_1.png
:align: center
.. index:: single: yacs
La poursuite d'un cas correspond à la situation suivante :
-Une série d'adaptations ont été conduites sur un cas puis Salome est fermé. On a gardé les répertoires de travail de ces itérations. On souhaite ensuite reprendre ces itérations pour les poursuivre là où on s'est arrêté. Cette fonctionnalité est particulièrement utile dans le cas de schémas YACS pour lesquels on scinde en plusieurs parties une longue série d'adaptations.
+Une série d'adaptations ont été conduites sur un cas puis SALOME est fermé. On a gardé les répertoires de travail de ces itérations. On souhaite ensuite reprendre ces itérations pour les poursuivre là où on s'est arrêté. Cette fonctionnalité est particulièrement utile dans le cas de schémas YACS pour lesquels on scinde en plusieurs parties une longue série d'adaptations.
La condition pour reprendre une itération est d'avoir conservé dans un même répertoire deux fichiers :
- le fichier de configuration qui a servi de données au module exécutable de HOMARD ; ce fichier se présente sous la forme ``HOMARD.Configuration.(n).vers.(n+1)``
.. index:: single: yacs
La poursuite d'un cas correspond à la situation suivante :
-Une série d'adaptations ont été conduites sur un cas puis Salome est fermé. On a gardé les répertoires de travail de ces itérations. On souhaite ensuite reprendre ces itérations pour les poursuivre là où on s'est arrêté. Cette fonctionnalité est particulièrement utile dans le cas de schémas YACS pour lesquels on scinde en plusieurs parties une longue série d'adaptations.
+Une série d'adaptations ont été conduites sur un cas puis SALOME est fermé. On a gardé les répertoires de travail de ces itérations. On souhaite ensuite reprendre ces itérations pour les poursuivre là où on s'est arrêté. Cette fonctionnalité est particulièrement utile dans le cas de schémas YACS pour lesquels on scinde en plusieurs parties une longue série d'adaptations.
La condition pour reprendre une itération est d'avoir conservé dans un même répertoire deux fichiers :
- le fichier de configuration qui a servi de données au module exécutable de HOMARD ; ce fichier se présente sous la forme ``HOMARD.Configuration.(n).vers.(n+1)``
.. note::
- Par défaut, le calcul est lancé avec l'exécutable de HOMARD installé avec Salome. Si on souhaite utiliser une version privée de HOMARD, pour tester une évolution par exemple, il faut préciser où le nouvel exécutable est disponible. Pour cela, il faut renseigner deux variables d'environnement.
+ Par défaut, le calcul est lancé avec l'exécutable de HOMARD installé avec SALOME. Si on souhaite utiliser une version privée de HOMARD, pour tester une évolution par exemple, il faut préciser où le nouvel exécutable est disponible. Pour cela, il faut renseigner deux variables d'environnement.
"*HOMARD_REP_EXE_PRIVATE*" définit le répertoire dans lequel se trouve l'exécutable voulu.
"*HOMARD_EXE_PRIVATE*" définit le nom de l'exécutable dans ce répertoire, si ce nom est différent de "*homard*".
.. note::
- Par défaut, le calcul est lancé avec l'exécutable de HOMARD installé avec Salome. Si on souhaite utiliser une version privée de HOMARD, pour tester une évolution par exemple, il faut préciser où le nouvel exécutable est disponible. Pour cela, il faut renseigner deux variables d'environnement.
+ Par défaut, le calcul est lancé avec l'exécutable de HOMARD installé avec SALOME. Si on souhaite utiliser une version privée de HOMARD, pour tester une évolution par exemple, il faut préciser où le nouvel exécutable est disponible. Pour cela, il faut renseigner deux variables d'environnement.
"*HOMARD_REP_EXE_PRIVATE*" définit le répertoire dans lequel se trouve l'exécutable voulu.
"*HOMARD_EXE_PRIVATE*" définit le nom de l'exécutable dans ce répertoire, si ce nom est différent de "*homard*".
#. en activant l'onglet HOMARD dans la liste des modules,
#. en cliquant sur le bouton HOMARD dans la barre d'outils.
-L'utilisateur a alors le choix entre créer une nouvelle étude ou en ouvrir une qui a été précédemment enregistrée, selon le principe qui a été retenu pour tous les autres modules de Salome.
+L'utilisateur a alors le choix entre créer une nouvelle étude ou en ouvrir une qui a été précédemment enregistrée, selon le principe qui a été retenu pour tous les autres modules de SALOME.
.. image:: images/homard_1.png
:align: center
#. en activant l'onglet HOMARD dans la liste des modules,
#. en cliquant sur le bouton HOMARD dans la barre d'outils.
-L'utilisateur a alors le choix entre créer une nouvelle étude ou en ouvrir une qui a été précédemment enregistrée, selon le principe qui a été retenu pour tous les autres modules de Salome.
+L'utilisateur a alors le choix entre créer une nouvelle étude ou en ouvrir une qui a été précédemment enregistrée, selon le principe qui a été retenu pour tous les autres modules de SALOME.
.. image:: images/homard_1.png
:align: center
Documentation du composant HOMARD |logo|
----------------------------------------
-HOMARD est le composant qui permet l'adaptation de maillage au sein de la plateforme Salome.
+HOMARD est le composant qui permet l'adaptation de maillage au sein de la plateforme SALOME.
*HOMARD est une marque déposée d'EDF.*
.. index:: single: démarrage
.. index:: single: exemple
-L'ensemble des options de pilotage du module HOMARD dans Salome est décrit dans le :ref:`gui_usage`. Mais on trouvera ici le B.A. BA pour découvrir l'utilisation de HOMARD à partir d'un exemple simple. Imaginons que l'on a effectué un calcul de thermique sur un maillage donné. On a récupéré en sortie de ce calcul un fichier au format MED, contenant le maillage et le champ des températures aux noeuds. On aimerait adapter le maillage de telle sorte que l'écart de température entre deux noeuds voisins soit inférieur à une valeur donnée.
+L'ensemble des options de pilotage du module HOMARD dans SALOME est décrit dans le :ref:`gui_usage`. Mais on trouvera ici le B.A. BA pour découvrir l'utilisation de HOMARD à partir d'un exemple simple. Imaginons que l'on a effectué un calcul de thermique sur un maillage donné. On a récupéré en sortie de ce calcul un fichier au format MED, contenant le maillage et le champ des températures aux noeuds. On aimerait adapter le maillage de telle sorte que l'écart de température entre deux noeuds voisins soit inférieur à une valeur donnée.
-La première action nécessite de lancer le module HOMARD, en créant une nouvelle étude, selon le principe qui a été retenu pour tous les autres modules de Salome.
+La première action nécessite de lancer le module HOMARD, en créant une nouvelle étude, selon le principe qui a été retenu pour tous les autres modules de SALOME.
.. image:: images/homard_1.png
:align: center
.. image:: images/intro_37.png
:align: center
-A ce stade, on va utiliser ce nouveau maillage pour un deuxième calcul, dans les mêmes conditions que le premier. Une fois que ce nouveau calcul est achevé, on peut décider de poursuivre le processus d'adaptation. Pour cela on revient dans Salome et on active le module HOMARD. On désigne l'itération que l'avait calculée précédemment "*Iter_1*" et on demande une nouvelle itération. La fenêtre suivante apparaît :
+A ce stade, on va utiliser ce nouveau maillage pour un deuxième calcul, dans les mêmes conditions que le premier. Une fois que ce nouveau calcul est achevé, on peut décider de poursuivre le processus d'adaptation. Pour cela on revient dans SALOME et on active le module HOMARD. On désigne l'itération que l'avait calculée précédemment "*Iter_1*" et on demande une nouvelle itération. La fenêtre suivante apparaît :
.. image:: images/intro_38.png
:align: center
.. index:: single: start
.. index:: single: example
-L'ensemble des options de pilotage du module HOMARD dans Salome est décrit dans le :ref:`gui_usage_en`. Mais on trouvera ici le B.A. BA pour découvrir l'utilisation de HOMARD à partir d'un exemple simple. Imaginons que l'on a effectué un calcul de thermique sur un maillage donné. On a récupéré en sortie de ce calcul un fichier au format MED, contenant le maillage et le champ des températures aux noeuds. On aimerait adapter le maillage de telle sorte que l'écart de température entre deux noeuds voisins soit inférieur à une valeur donnée.
+L'ensemble des options de pilotage du module HOMARD dans SALOME est décrit dans le :ref:`gui_usage_en`. Mais on trouvera ici le B.A. BA pour découvrir l'utilisation de HOMARD à partir d'un exemple simple. Imaginons que l'on a effectué un calcul de thermique sur un maillage donné. On a récupéré en sortie de ce calcul un fichier au format MED, contenant le maillage et le champ des températures aux noeuds. On aimerait adapter le maillage de telle sorte que l'écart de température entre deux noeuds voisins soit inférieur à une valeur donnée.
-La première action nécessite de lancer le module HOMARD, en créant une nouvelle étude, selon le principe qui a été retenu pour tous les autres modules de Salome.
+La première action nécessite de lancer le module HOMARD, en créant une nouvelle étude, selon le principe qui a été retenu pour tous les autres modules de SALOME.
.. image:: images/homard_1.png
:align: center
.. image:: images/intro_37.png
:align: center
-A ce stade, on va utiliser ce nouveau maillage pour un deuxième calcul, dans les mêmes conditions que le premier. Une fois que ce nouveau calcul est achevé, on peut décider de poursuivre le processus d'adaptation. Pour cela on revient dans Salome et on active le module HOMARD. On désigne l'itération que l'avait calculée précédemment "*Iter_1*" et on demande une nouvelle itération. La fenêtre suivante apparaît :
+A ce stade, on va utiliser ce nouveau maillage pour un deuxième calcul, dans les mêmes conditions que le premier. Une fois que ce nouveau calcul est achevé, on peut décider de poursuivre le processus d'adaptation. Pour cela on revient dans SALOME et on active le module HOMARD. On désigne l'itération que l'avait calculée précédemment "*Iter_1*" et on demande une nouvelle itération. La fenêtre suivante apparaît :
.. image:: images/intro_38.png
:align: center
| Pour une frontière discrète : |
| |
| . si toutes les lignes courbes sont suivies, le second |
-| argument est une chaîne vide. |
+| argument est une chaîne vide. |
+| |
| . si seulement certaines lignes courbes sont suivies, |
-| ``group`` est le nom d'un groupe de segments à suivre. |
+| ``group`` est le nom d'un groupe de segments à suivre. |
| |
| Pour une frontière analytique : |
| |
============
.. index:: single: boundary
-.. index:: single: cylindre
+.. index:: single: cylinder
.. index:: single: sphere
The variables are described in :ref:`gui_create_boundary_en`.
| **AddBoundaryGroup(boundary, group)** |
| Add a boundary to the definition of a case |
| |
-| - ``boundary``: nom d'une frontière courbe à suivre |
+| - ``boundary``: name of the curved boundary |
| |
-| Pour une frontière discrete: |
+| Discrete boundary: |
| |
-| . si toutes les lignes courbes sont suivies, le second |
-| argument est une chaîne vide. |
-| . si seulement certaines lignes courbes sont suivies, |
-| ``group`` est the name d'un groupe de segments à suivre |
+| . if all the curved lines are involved, the second |
+| argument is an empty string. |
| |
-| Pour une frontière analytique: |
+| . if only some curved lines are involved, ``group`` is |
+| the name of the group of segments |
| |
-| - ``group``: nom d'un groupe de faces placées sur la |
-| frontière |
+| Analytical boundary: |
+| |
+| - ``group``: name of the groupe of faces located on the |
+| boundary |
+---------------------------------------------------------------+
Methods of the class boundary
| .. module:: GetName |
| |
| **GetName()** |
-| Retourne the name of the boundary |
+| Returns the name of the boundary |
+---------------------------------------------------------------+
| .. module:: GetType |
| |
| **GetType()** |
-| Retourne le type de la frontière: |
+| Returns the type of the boundary: |
| |
| * 0: discrete |
-| * 1: cylindre |
+| * 1: cylinder |
| * 2: sphere |
-| * 3: cône défini par un axe et un angle |
-| * 4: cône défini par deux rayons |
+| * 3: cone defined by an axis and an angle |
+| * 4: cone defined by 2 radius |
+---------------------------------------------------------------+
| .. module:: GetCoords |
| |
| **GetCoords()** |
-| Retourne un tableau contenant les coordinates de la |
-| frontière dans l'ordre d'entrée dans le CreateBoundaryXXXX|
-| associé |
+| Returns the array of the coordinates of the boundary |
+| with the same order as in its definition with |
+| CreateBoundaryXXXX |
+---------------------------------------------------------------+
| .. module:: Delete |
| |
| **Delete()** |
-| Detruit la frontière. |
-| Pour une frontière discrete, le fichier du maillage |
-| associé est conservé. |
+| Deletes the boundary. |
+| If the boundary is discrete, the file of the mesh is kept.|
| |
-| Retourne un entier: |
-| * 0: destruction réussie |
-| * autre valeur: problème |
+| Returns an integer: |
+| * 0: the destruction is done |
+| * other value: problem |
+---------------------------------------------------------------+
-Exemple
+Example
"""""""
-Création d'une frontière discrete, d'une frontière sphèrique, puis d'une frontière cylindrique: ::
+Creation of a discrete boundary, a spherical boundary, and a cylindrical boundary:
+::
inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
-Saisie graphique correspondante
-"""""""""""""""""""""""""""""""
-Consulter :ref:`gui_create_boundary_en`
+Similar graphical input
+"""""""""""""""""""""""
+Look at :ref:`gui_create_boundary_en`
| |
| - ``case_name`` : le nom du cas |
| - ``mesh_name`` : le nom du maillage initial |
-| - ``mesh_file`` : le nom du fichier contenant ce maillage |
+| - ``mesh_file`` : le nom du fichier MED contenant ce |
+| ce maillage |
| |
| Par défaut : |
| |
| .. module:: GetAllCasesName |
| |
| **GetAllCasesName()** |
-| Retourne la liste des noms de tous les cas créés |
+| Retourne la liste des noms de tous les cas existant |
| |
+---------------------------------------------------------------+
| fichiers de maillage associés |
| |
| * 0 : les fichiers sont conservés |
-| * 1 : les fichiers sont détruits |
+| * 1 : les fichiers sont supprimés |
| |
| Retourne un entier : |
| * 0 : destruction réussie |
.. _tui_create_case_en:
-Le cas
-======
+The case
+========
.. index:: single: cas
-.. index:: single: type de conformité
-.. index:: single: maillage;initial
+.. index:: single: type of conformity
+.. index:: single: mesh;initial
The variables are described in :ref:`gui_create_case_en`.
Methods of the class homard
""""""""""""""""""""""""""""
-Création d'un cas
-^^^^^^^^^^^^^^^^^
+Creation of a case
+^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: CreateCase |
| |
| **CreateCase(case_name, mesh_name, mesh_file)** |
-| Returns an instance of the class ``cas`` après sa |
-| création |
+| Returns an instance of the class ``cas`` after its |
+| creation |
| |
-| - ``case_name``: le nom du cas |
-| - ``mesh_name``: le nom du maillage initial |
-| - ``mesh_file``: le nom du fichier contenant ce maillage |
+| - ``case_name``: the name of the case |
+| - ``mesh_name``: the name of the initial mesh |
+| - ``mesh_file``: the name of the MED file of this mesh |
| |
-| Par défaut: |
+| Default: |
| |
-| * le répertoire des résultats est ``/tmp`` |
-| * l'adaptation est conforme |
+| * the directory for the results is ``/tmp`` |
+| * the adaptation is conformal |
+---------------------------------------------------------------+
| .. module:: GetCase |
| |
| **GetCase(case_name)** |
-| Returns an instance of the class classe ``cas`` connue par|
-| son nom |
+| Returns an instance of the class ``cas`` known by its name|
| |
-| - ``case_name``: le nom du cas |
+| - ``case_name``: the name of the case |
+---------------------------------------------------------------+
| .. module:: GetAllCasesName |
| |
| **GetAllCasesName()** |
-| Retourne la liste des noms de tous les cas créés |
+| Returns the liste of the name of all the existing cases |
| |
+---------------------------------------------------------------+
-Création d'un cas par poursuite d'une itération calculée
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Creation of a case by pursuit of a computed iteration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: CreateCaseFromIteration |
| |
| **CreateCaseFromIteration(case_name, dir_name)** |
-| Returns an instance of the class ``cas`` après sa |
-| création |
+| Returns an instance of the class ``cas`` after its |
+| creation |
| |
-| - ``case_name``: le nom du cas |
-| - ``dir_name`` : le nom du répertoire contenant |
-| l'itération à poursuivre |
+| - ``case_name``: the name of the case |
+| - ``dir_name``: the name of the directory that contains |
+| the iteration |
| |
+---------------------------------------------------------------+
| .. module:: CreateCaseFromCaseLastIteration |
| |
| **CreateCaseFromCaseLastIteration(case_name, dir_name)** |
-| Returns an instance of the class ``cas`` après sa |
-| création |
+| Returns an instance of the class ``cas`` after its |
+| creation |
| |
-| - ``case_name``: le nom du cas |
-| - ``dir_name`` : le nom du répertoire contenant |
-| le cas à poursuivre |
+| - ``case_name``: the name of the case |
+| - ``dir_name``: the name of the directory that contains |
+| the case |
| |
+---------------------------------------------------------------+
| .. module:: CreateCaseFromCaseIteration |
| |
| **CreateCaseFromCaseIteration(case_name, dir_name, number)** |
-| Returns an instance of the class ``cas`` après sa |
-| création |
+| Returns an instance of the class ``cas`` after its |
+| creation |
| |
-| - ``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 |
+| - ``case_name``: the name of the case |
+| - ``dir_name``: the name of the directory that contains |
+| the case |
+| - ``number``: the number of the iteration of the case |
| |
+---------------------------------------------------------------+
Methods of the class cas
-"""""""""""""""""""""""""
+""""""""""""""""""""""""
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: GetName |
| |
| **GetName()** |
-| Retourne le nom du cas |
+| Returns the name of the case |
+---------------------------------------------------------------+
| .. 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 |
-| premier calcul. |
+| Gives a directory for the results of the case. It can be |
+| done only after the creation of the case and before the |
+| first computation. |
| |
-| - ``dirname``: le nom du répertoire des résutats |
+| - ``dirname``: the name of the directory of the results |
+---------------------------------------------------------------+
| .. module:: GetDirName |
| |
| **GetDirName()** |
-| Retourne le nom du répertoire des résutats associé au cas |
+| Returns the name of the directory of the results of the |
+| case |
+---------------------------------------------------------------+
| .. module:: SetConfType |
| |
| **SetConfType(conf_type)** |
-| Définit le mode de conformité associé au cas |
+| Defines the type of conformity for the case |
| |
-| - ``conf_type``: entier précisant le mode de conformité |
+| - ``conf_type``: integer as follows: |
| |
-| * 1: conforme |
-| * 2: non conforme avec 1 noeud par maille |
-| * 3: non conforme avec 1 noeud par arete de maille |
-| * 4: non conforme quelconque |
+| * 1: conformal |
+| * 2: non conformal with one hanging node per element |
+| * 3: non conformal with one hanging node per edge of |
+| element |
+| * 4: non conformal without any constraint |
+---------------------------------------------------------------+
| .. module:: GetConfType |
| |
| **GetConfType()** |
-| Retourne le type de conformité |
+| Returns the type of conformity |
+---------------------------------------------------------------+
| .. module:: GetIter0 |
| |
| **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. |
+| Returns the iteration linked to the initial mesh. |
+| This iteration is automatically created by the module |
+| HOMARD. It is used to connect the iterations. It is |
+| connected to an initial mesh or to the iteration of a |
+| previous case. |
+---------------------------------------------------------------+
| .. module:: AddBoundaryGroup |
| |
| **AddBoundaryGroup(boundary, group)** |
-| Ajoute une frontière à la définition du cas |
+| Add a boundary to the definition of a case |
| |
-| - ``boundary``: nom d'une frontière courbe à suivre |
+| - ``boundary``: name of the curved boundary |
| |
-| Pour une frontière discrète: |
+| Discrete boundary: |
| |
-| . si toutes les lignes courbes sont suivies, le second |
-| argument est une chaîne vide. |
-| . si seulement certaines lignes courbes sont suivies, |
-| ``group`` est le nom d'un groupe de segments à suivre. |
+| . if all the curved lines are involved, the second |
+| argument is an empty string. |
+| . if only some curved lines are involved, ``group`` is |
+| the name of the group of segments |
| |
-| Pour une frontière analytique: |
+| Analytical boundary: |
| |
-| - ``group``: nom d'un groupe de faces placées sur la |
-| frontière |
+| - ``group``: name of the group of faces located on the |
+| boundary |
+---------------------------------------------------------------+
| .. module:: Delete |
| |
| **Delete(option)** |
-| Detruit le cas et toutes les itérations associées. Le |
-| fichier du maillage initial associé est conservé. |
+| Deletes the case and all the connected iterations. The MED|
+| file of the first mesh is kept. |
| |
-| - ``option``: un entier précisant ce qui est fait des |
-| fichiers de maillage associés |
+| - ``option``: an integer to define what to do with the |
+| MED file of the associated meshes |
| |
-| * 0: les fichiers sont conservés |
-| * 1: les fichiers sont détruits |
+| * 0: the files are kept |
+| * 1: the files are removed |
| |
-| Retourne un entier: |
-| * 0: destruction réussie |
-| * autre valeur: problème |
+| Returns an integer: |
+| * 0: the destruction is done |
+| * other value: problem |
+---------------------------------------------------------------+
| .. module:: GetState |
| |
| **GetState()** |
-| Retourne l'état du cas: |
-| * 0: correspond à un maillage initial |
-| * autre valeur: poursuite d'une itération de numéro n |
+| Returns the state of the case: |
+| * 0: corresponds to an initial mesh |
+| * other value: pursuit of an iteration with number n |
+---------------------------------------------------------------+
-Les options avancées
-^^^^^^^^^^^^^^^^^^^^
+Advanced options
+^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: SetPyram |
| |
| **SetPyram(option)** |
-| Définit le statut des pyramides pour le cas |
+| Defines the status of the pyramids in this case |
| |
-| - ``option``: entier précisant le statut des pyramides |
-| éventuellement présentes dans le maillage initial |
+| - ``option``: integer that defines the status of the |
+| pyramids that could belongs to the initial mesh |
| |
-| * 0: pyramides refusées (défaut) |
-| * 1: pyramides autorisées |
+| * 0: rejected pyramids (default) |
+| * 1: authorized pyramids |
+---------------------------------------------------------------+
| .. module:: GetPyram |
| |
| **GetPyram()** |
-| Retourne le statut accordé aux pyramides éventuellement |
-| présentes dans le maillage initial |
+| Returns the status of the pyramids in this case |
+---------------------------------------------------------------+
-Informations sur le maillage initial
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Informations for the initial mesh
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. 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. |
+| Gives information about the current mesh. For every |
+| option, the choice #0 corresponds to 'no action', while |
+| the choice #1 launches the 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 |
+| - ``Qual``: quality of the elements |
+| - ``Diam``: diametre of the elements |
+| - ``Conn``: connexity of the domain; a single block, how |
+| many holes, etc. |
+| - ``Tail``: size of the parts of the domain, group by |
+| group |
+| - ``Inte``: staggered elements, by dimension |
+---------------------------------------------------------------+
-Exemple
+Example
"""""""
-La création de l'objet case_1 se fait ainsi: ::
+The creation of the object case_1 is done as follows:
+
+::
case_name = "CAS_1"
mesh_name = "MAILL"
- mesh_file = "/local00/Salome/Adapt/m0.med"
+ mesh_file = "/scratch/Salome/Adapt/m0.med"
case_1 = homard.CreateCase(case_name, mesh_name, mesh_file)
- dirname = "/local00/Salome/Adapt/resu"
+ dirname = "/scratch/Salome/Adapt/resu"
case_1.SetDirName(dirname)
case_1.SetConfType(1)
case_1.AddBoundaryGroup( 'intersection', '' )
-Saisie graphique correspondante
-"""""""""""""""""""""""""""""""
-Consulter :ref:`gui_create_case_en`
+Similar graphical input
+"""""""""""""""""""""""
+Look at :ref:`gui_create_case_en`
| |
| **SetAdapInit(option)** |
| Définit le traitement à appliquer aux mailles où |
-| le champ de pilotage du raffinement n'est pas défini |
+| le champ de pilotage de l'adaptation n'est pas défini |
| |
| - ``option`` : entier précisant le choix retenu |
| |
| |
| **GetAdapInit()** |
| Retourne le type de traitement à appliquer aux mailles où |
-| le champ de pilotage du raffinement n'est pas défini |
+| le champ de pilotage de l'adaptation n'est pas défini |
+---------------------------------------------------------------+
| .. module:: SetLevelOutput |
| |
.. _tui_create_hypothese_en:
-L'hypothèse
-===========
+The hypothesis
+==============
-.. index:: single: itération
-.. index:: single: hypothèse
+.. index:: single: iteration
+.. index:: single: hypothesis
.. index:: single: zone
The variables are described in :ref:`gui_create_hypothese_en`.
| **CreateHypothesis(hypo_name)** |
| Returns an instance of the class ``hypothese`` |
| |
-| - ``hypo_name``: le nom de l'hypothèse |
+| - ``hypo_name``: the name of the hypothesis |
+---------------------------------------------------------------+
| .. module:: GetHypothesis |
| |
| **GetHypothesis(hypo_name)** |
-| Returns an instance of the class classe ``hypothese`` |
-| son nom |
+| Returns an instance of the class ``hypothese`` |
+| known by its name |
| |
-| - ``hypo_name``: le nom de l'hypothèse |
+| - ``hypo_name``: the name of the hypothesis |
+---------------------------------------------------------------+
| .. module:: GetAllHypothesesName |
| |
| **GetAllHypothesesName()** |
-| Retourne la liste des noms de toutes les hypothèses créées|
+| Returns the liste of the name of all the existing |
+| hypotheses |
| |
+---------------------------------------------------------------+
Methods of the class hypothese
"""""""""""""""""""""""""""""""
-Généralités
-^^^^^^^^^^^
+General methods
+^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: GetName |
| |
| **GetName()** |
-| Retourne le nom de l'hypothèse |
+| Returns the name of the hypothesis |
+---------------------------------------------------------------+
| .. module:: SetAdapRefinUnRef |
| |
| **SetAdapRefinUnRef(Adap, Refin, UnRef)** |
-| Affecte le mode d'adaptation associé à l'hypothèse |
+| Gives the type of adaptation to the hypothesis |
| |
-| - ``Adap``: entier précisant le type d'adaptation |
+| - ``Adap``: integer that defines the type of adaptation |
| |
-| * -1: uniforme |
-| * 0: selon des zones |
-| * 1: selon un champ |
+| * -1: uniform |
+| * 0: by zones |
+| * 1: by a field |
| |
-| - ``Refin``: entier précisant si le raffinement est a ctif|
+| - ``Refin``: integer that informs if the refinement is |
+| active or not |
| |
-| * 0: inactif |
-| * 1: actif |
+| * 0: unactive |
+| * 1: active |
| |
-| - ``UnRef``: entier précisant si déraffinement est actif |
+| - ``UnRef``: integer that informs if the refinement is |
+| active or not |
| |
-| * 0: inactif |
-| * 1: actif |
+| * 0: unactive |
+| * 1: active |
| |
+---------------------------------------------------------------+
| .. module:: GetAdapType |
| |
| **GetAdapType()** |
-| Retourne le type d'adaptation |
+| Returns the type of the adaptation |
+---------------------------------------------------------------+
| .. module:: GetRefinType |
| |
| **GetRefinType()** |
-| Retourne le type de raffinement |
+| Returns the type of the refinement |
+---------------------------------------------------------------+
| .. module:: GetUnRefType |
| |
| **GetUnRefType()** |
-| Retourne le type de déraffinement |
+| Returns the type of the unrefinement |
+---------------------------------------------------------------+
| .. module:: Delete |
| |
| **Delete()** |
-| Detruit l'hypothèse |
+| Deletes the hypothesis |
| |
-| Retourne un entier: |
-| * 0: destruction réussie |
-| * autre valeur: problème |
+| Returns an integer: |
+| * 0: the destruction is done |
+| * other value: problem |
+---------------------------------------------------------------+
-Le champ et les seuils
-^^^^^^^^^^^^^^^^^^^^^^
+The field and the thresholds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: SetField |
| |
| **SetField(field_name)** |
-| Attribue un nom de champ à l'hypothèse |
+| Gives the name of a field to the hypothesis |
| |
-| - ``field_name``: le nom du champ |
+| - ``field_name``: the name of the field |
+---------------------------------------------------------------+
| .. module:: GetFieldName |
| |
| **GetFieldName()** |
-| Retourne le nom du champ |
+| Returns the name of the field |
+---------------------------------------------------------------+
| .. module:: SetUseField |
| |
| **SetUseField(use_field)** |
-| Attribue un mode d'usage du champ à l'hypothèse |
+| Gives the usage of the field for the hypothesis |
| |
-| - ``use_field``: entier précisant l'usage du champ |
+| - ``use_field``: integer that defines how the field is |
+| used |
| |
-| * 0: valeur par élément (défaut) |
-| * 1: saut entre un élément et ses voisins |
+| * 0: value by element (default) |
+| * 1: jump between an element and its neighbours |
+---------------------------------------------------------------+
| .. module:: SetRefinThr |
| |
| **SetRefinThr(type_thres, threshold)** |
-| Définit les seuils en raffinement |
+| Defines the thresholds for the refinement |
| |
-| - ``type_thres``: entier précisant le type de seuil en |
-| raffinement |
+| - ``type_thres``: integer that defines the type of the |
+| threshold for the refinement |
| |
-| * 1: valeur absolue |
-| * 2: valeur relative en % |
-| * 3: fraction des mailles en % |
-| * 4: moyenne + n fois l'écart-type |
+| * 1: absolute value |
+| * 2: relative value in % |
+| * 3: ratio of elements in % |
+| * 4: mean + n times the standard deviation |
| |
-| - ``threshold``: valeur numérique entrant dans la |
-| définition du seuil |
+| - ``threshold``: numerical value that defines the |
+| threshold |
+---------------------------------------------------------------+
| .. module:: GetRefinThrType |
| |
| **GetRefinThrType()** |
-| Retourne le type de seuil de raffinement |
+| Returns the type of the threshold for the refinement |
+---------------------------------------------------------------+
| .. module:: SetUnRefThr |
| |
| **SetUnRefThr(type_thres, threshold)** |
-| Définit les seuils en déraffinement |
+| Defines the thresholds for the unrefinement |
| |
-| - ``type_thres``: entier précisant le type de seuil en |
-| déraffinement |
+| - ``type_thres``: integer that defines the type of the |
+| threshold for the unrefinement |
| |
-| * 1: valeur absolue |
-| * 2: valeur relative en % |
-| * 3: fraction des mailles en % |
-| * 4: moyenne - n fois l'écart-type |
+| * 1: absolute value |
+| * 2: relative value in % |
+| * 3: ratio of elements in % |
+| * 4: mean - n times the standard deviation |
| |
-| - ``threshold``: valeur du seuil |
+| - ``threshold``: numerical value that defines the |
+| threshold |
+---------------------------------------------------------------+
| .. module:: GetUnRefThrType |
| |
| **GetUnRefThrType()** |
-| Retourne le type de seuil de déraffinement |
+| Returns the type of the threshold for the unrefinement |
+---------------------------------------------------------------+
-Les composantes du champ
-^^^^^^^^^^^^^^^^^^^^^^^^
+The components of the field
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: AddComp |
| |
| **AddComp(comp_name)** |
-| Ajoute une composante du champ à considérer |
+| Add a component of the field |
| |
-| - ``comp_name``: nom d'une composante à prendre en |
-| compte |
+| - ``comp_name``: name of a component to take into account |
+---------------------------------------------------------------+
| .. module:: SetUseComp |
| |
| **SetUseComp(use_comp)** |
-| Définit l'usage des composantes |
+| Defines hom to use the components |
| |
-| - ``use_comp``: entier précisant l'usage des composantes |
+| - ``use_comp``: integer that defines how to use the |
+| components |
| |
-| * 0: norme L2 (défaut) |
-| * 1: norme infinie |
-| * 2: valeur relative, si une seule composante |
+| * 0: L2 norm (default) |
+| * 1: infinite norm |
+| * 2: relative value, if only one component |
+---------------------------------------------------------------+
| .. module:: GetListComp |
| |
| **GetListComp()** |
-| Retourne la liste des composantes utilisées |
+| Returns the list of the used components |
+---------------------------------------------------------------+
-Les zones
+The zones
^^^^^^^^^
+---------------------------------------------------------------+
| |
| **AddZone(zone_name, type_use)** |
| |
-| - ``zone_name``: le nom de la zone à ajouter |
-| - ``type_use``: entier précisant l'usage de la zone |
+| - ``zone_name``: the name of the zone to add |
+| - ``type_use``: integer that defines how to use the zone |
| |
-| * 1: raffinement |
-| * -1: déraffinement |
+| * 1: refinement |
+| * -1: unrefinement |
+---------------------------------------------------------------+
-Le filtrage par les groupes
+The filtering by the groups
^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
| .. module:: AddGroup |
| |
| **AddGroup(group_name)** |
-| Ajoute un groupe au filtrage |
+| Add a group to the filtering |
| |
-| - ``group_name``: nom du groupe à prendre en compte |
+| - ``group_name``: name of the group to take into account |
+---------------------------------------------------------------+
| .. module:: GetGroups |
| |
| **GetGroups()** |
-| Retourne la liste des groupes utilisés pour le filtrage |
+| Returns the mist of the groups that are used in the |
+| filtering |
+---------------------------------------------------------------+
-Les options avancées
-^^^^^^^^^^^^^^^^^^^^
+Advanced options
+^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: SetNivMax |
| |
| **SetNivMax(nivmax)** |
-| Définit le niveau maximal de raffinement |
+| Defines the maximum level for the refinement |
| |
-| - ``nivmax``: niveau de raffinement à ne pas dépasser |
+| - ``nivmax``: level of refinement that must not be |
+| exceeded |
+---------------------------------------------------------------+
| .. module:: GetNivMax |
| |
| **GetNivMax()** |
-| Retourne le niveau maximal de raffinement |
+| Returns the maximum level for the refinement |
+---------------------------------------------------------------+
| .. module:: SetDiamMin |
| |
| **SetDiamMin(diammin)** |
-| Définit le diamètre minimal des futures mailles |
+| Defines the minimum diameter of the future elements |
| |
-| - ``diammin``: diamètre minimal voulu pour une maille |
+| - ``diammin``: minimum diameter for an element |
+---------------------------------------------------------------+
| .. module:: GetDiamMin |
| |
| **GetDiamMin()** |
-| Retourne le diamètre minimal voulu |
+| Returns the minimum diameter of the future elements |
+---------------------------------------------------------------+
| .. module:: SetAdapInit |
| |
| **SetAdapInit(option)** |
-| Définit le traitement à appliquer aux mailles où |
-| le champ de pilotage du raffinement n'est pas défini |
+| Defines the treatment of the elements where the field that|
+| governs the adaptation is not defined |
| |
-| - ``option``: entier précisant le choix retenu |
+| - ``option``: integer as follows: |
| |
-| * 0: aucun effet (défaut) |
-| * 1: les mailles sans indicateurs sont raffinées |
-| * -1: les mailles sans indicateurs sont déraffinées |
+| * 0: no effect (default) |
+| * 1: the elements without field are refined |
+| * -1: the elements without field are unrefined |
+---------------------------------------------------------------+
| .. module:: GetAdapInit |
| |
| **GetAdapInit()** |
-| Retourne le type de traitement à appliquer aux mailles où |
-| le champ de pilotage du raffinement n'est pas défini |
+| Returns the treatment of the elements where the field that|
+| governs the adaptation is not defined |
+---------------------------------------------------------------+
| .. module:: SetLevelOutput |
| |
| **SetLevelOutput(option)** |
-| Précise si on veut récupérer le niveau de raffinement des |
-| mailles sous la forme d'un champ |
+| Acts if the level of refinement is returned as a field in |
+| the output MED file |
| |
-| - ``option``: entier précisant le choix retenu |
+| - ``option``: integer as follows: |
| |
-| * 0: aucun effet (défaut) |
-| * 1: le champ est produit |
+| * 0: no effect (default) |
+| * 1: the field is produced |
+---------------------------------------------------------------+
| .. module:: GetLevelOutput |
| |
| **GetLevelOutput()** |
-| Retourne le choix retenu pour la récupération du niveau |
-| de raffinement |
+| Returns the choice for the output of the level of |
+| refinement |
+---------------------------------------------------------------+
-Exemple
+Example
"""""""
-La création de l'objet hypo_1 se fait ainsi: ::
+The creation of the object hypo_1 is done as follows:
+::
hypo_1 = homard.CreateHypothesis("HypoField")
hypo_1.SetAdapRefinUnRef(1, 1, 0)
hypo_1.SetRefinThr(1, 80.)
-Saisie graphique correspondante
-"""""""""""""""""""""""""""""""
-Consulter :ref:`gui_create_hypothese_en`
+Similar graphical input
+"""""""""""""""""""""""
+Look at :ref:`gui_create_hypothese_en`
.. warning::
- En mode graphique, si on édite une hypothèse et que l'on modifie une de ses caractéristiques, par exemple le seuil de raffinement, toutes les itérations qui ont été calculées précédemment avec cette hypothèse sont invalidées. En mode python, cela n'est plus vrai : les itérations restent telles quelles.
+ With the graphical input mode, if an hypothesis is edited and if one of the characteristic is modified, the value of the threshold for the refinement for example, all the iterations that were computed with this hypothesis are unvalidated. In python mode, that is not true: the iterations stay as they are.
| .. module:: SetMeshFile |
| |
| **SetMeshFile(mesh_file)** |
-| Définit le fichier du maillage produit |
+| Définit le fichier MED du maillage produit |
| |
-| - ``mesh_file`` : le nom du fichier qui contiendra |
+| - ``mesh_file`` : le nom du fichier MED qui contiendra |
| le maillage produit |
+---------------------------------------------------------------+
| .. module:: GetMeshFile |
| |
| **GetMeshFile()** |
-| Retourne le nom du fichier du maillage produit |
+| Retourne le nom du fichier MED du maillage produit |
+---------------------------------------------------------------+
| .. module:: MeshInfo |
| |
| .. module:: SetFieldFile |
| |
| **SetFieldFile(field_file)** |
-| Définit le fichier des champs utiles |
+| Définit le fichier MED des champs utiles |
| |
-| - ``field_file`` : le nom du fichier contenant le champ |
+| - ``field_file`` : le nom du fichier MED contenant le |
+| champ |
+---------------------------------------------------------------+
| .. module:: SetTimeStepRank |
| |
| **SetTimeStepRank(TimeStep, Rank)** |
| Définit les instants pour le champ |
| |
+| Inutile si aucun instant n'est défini 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:: GetFieldFileName |
| |
| **GetFieldFileName()** |
-| Retourne le nom du fichier du champ |
+| Retourne le nom du fichier MED du champ |
+---------------------------------------------------------------+
| .. module:: GetTimeStep |
| |
.. _tui_create_iteration_en:
-L'itération
-===========
+The iteration
+=============
-.. index:: single: itération
-.. index:: single: hypothèse
+.. index:: single: iteration
+.. index:: single: hypothesis
.. index:: single: zone
The variables are described in :ref:`gui_create_iteration_en`.
| .. module:: GetIteration |
| |
| **GetIteration(iter_name)** |
-| Returns an instance of the class classe ``iteration`` |
-| son nom |
+| Returns an instance of the class ``iteration`` |
+| known by its name |
| |
-| - ``iter_name``: le nom de l'itération |
+| - ``iter_name``: the name of the iteration |
+---------------------------------------------------------------+
| .. module:: GetAllIterationsName |
| |
| **GetAllIterationsName()** |
-| Retourne la liste des noms de toutes les itérations créées|
+| Returns the liste of the name of all the existing |
+| iterations |
| |
+---------------------------------------------------------------+
| .. module:: NextIteration |
| |
| **NextIteration(iter_name)** |
-| Returns an instance of the class ``iteration`` après |
-| sa création: elle suit immédiatement l'itération |
-| initiale, correspondant au maillage définissant le cas |
+| Returns an instance of the class ``iteration`` after |
+| its creation: it is the next iteration after the very |
+| first one that corresponds to the first mesh of the case |
| |
-| - ``iter_name``: le nom à donner à la nouvelle itération |
+| - ``iter_name``: the name of this next iteration |
| |
-| Par défaut: |
+| Default: |
| |
-| * le maillage produit a le même nom que l'itération |
+| * the produced mesh has got the same name as the iteration |
+---------------------------------------------------------------+
| .. module:: LastIteration |
| |
| **LastIteration()** |
-| Returns an instance of the class ``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. |
+| Returns an instance of the class ``iteration``: the last |
+| iteration into the descendants of the initial iteration |
+| of the case. It is the one that has got no child. There is|
+| an error if more than one branch exists into the |
+| descendants. |
| |
+---------------------------------------------------------------+
Methods of the class iteration
-"""""""""""""""""""""""""""""""
+""""""""""""""""""""""""""""""
-Généralités
-^^^^^^^^^^^
+General methods
+^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: NextIteration |
| |
| **NextIteration(iter_name)** |
-| Returns an instance of the class ``iteration`` qui suit |
-| l'itération courante |
+| Returns an instance of the class ``iteration`` after |
+| its creation: it is the next iteration after the current |
+| one |
| |
-| - ``iter_name``: le nom à donner à la nouvelle itération |
+| - ``iter_name``: the name of this next iteration |
| |
-| Par défaut: |
+| Default: |
| |
-| * le maillage produit a le même nom que l'itération |
+| * the produced mesh has got the same name as the iteration |
+---------------------------------------------------------------+
| .. module:: Compute |
| |
| **Compute(option1, option2)** |
-| Calcule le maillage correspondant à l'itération |
+| Computes the mesh produced by the iteration |
| |
-| - ``option1``: un entier précisant ce qui se passe quand |
-| des fichiers de résultats existent déjà |
+| - ``option1``: an integer to decide what to do with |
+| existing files, if any |
| |
-| * 0: arrêt en erreur |
-| * 1: écrasement des anciens fichiers |
+| * 0: stop with error |
+| * 1: the old files are removed |
| |
-| - ``option2``: un entier précisant ce qui est fait des |
-| résultats |
+| - ``option2``: an integer to decide what to do with |
+| the results |
| |
-| * 1: aucune action particulière |
-| * 2 : publication dans le module SMESH |
+| * 1: no specific action |
+| * 2: publication into the module SMESH |
| |
-| Retourne un entier : |
-| * 0 : adaptation réussie |
-| * autre valeur : problème |
+| Returns an integer: |
+| * 0: successful adaptation |
+| * other value: problem |
+---------------------------------------------------------------+
| .. module:: GetName |
| |
| **GetName()** |
-| Retourne le nom de l'itération |
+| Returns the name of the iteration |
+---------------------------------------------------------------+
| .. module:: GetNumber |
| |
| **GetNumber()** |
-| Retourne le numéro de l'itération. |
+| Returns the number of the iteration. |
| |
-| L'itération 0 est celle associée au maillage initial. |
-| Ensuite, une itération de numéro N est issue de |
-| l'adaptation d'une itération de numéro N-1. |
+| The iteration #0 is the one associated to the initial |
+| mesh. Then, an iteration with number #N comes from the |
+| adaptation of an iteration with number #(N-1). |
+---------------------------------------------------------------+
| .. module:: GetIterParent |
| |
| **GetIterParent()** |
-| Retourne l'itération mère |
+| Returns the iteration parent |
+---------------------------------------------------------------+
| .. module:: LastIteration |
| |
| **LastIteration()** |
-| Returns an instance of the class ``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. |
+| Returns an instance of the class ``iteration``: the last |
+| iteration into the descendants of the current iteration. |
+| It is the one that has got no child. There is |
+| an error if more than one branch exists into the |
+| descendants. |
+---------------------------------------------------------------+
| .. module:: AssociateHypo |
| |
| **AssociateHypo(hypo_name)** |
-| Associe une hypothèse à l'itération |
+| Associate an hypothesis with the iteration |
| |
-| - ``hypo_name`` : le nom de l'hypothèse à associer |
+| - ``hypo_name``: the name of the hypothesis |
+---------------------------------------------------------------+
| .. module:: GetHypoName |
| |
| **GetHypoName()** |
-| Retourne le nom de l'hypothèse associée |
+| Returns the name of the associated hypothesis |
+---------------------------------------------------------------+
| .. module:: GetCaseName |
| |
| **GetCaseName()** |
-| Retourne le nom du cas associé |
+| Returns the name of the associated case |
+---------------------------------------------------------------+
| .. module:: GetState |
| |
| **GetState()** |
-| Retourne l'état de l'itération |
+| Returns the state of the iteration |
| |
-| - ``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 |
+| - ``2``: computed iteration |
+| - ``1``: non computed iteration |
+| - ``<=0``: initial iteration not to be computed, with a |
+| number equal to the absolute valure of the state |
+---------------------------------------------------------------+
| .. module:: GetLogFile |
| |
| **GetLogFile()** |
-| Retourne le nom du fichier retraçant le déroulement de |
-| l'exécution de HOMARD |
+| Returns the name of the file with the messages all along |
+| the running of HOMARD |
+---------------------------------------------------------------+
| .. module:: GetFileInfo |
| |
| **GetFileInfo()** |
-| Retourne le nom du fichier contenant l'analyse du maillage|
+| Returns the name of the file with the analysis of the mesh|
+---------------------------------------------------------------+
| .. module:: GetDirName |
| |
| **GetDirName()** |
-| Retourne le nom du répertoire des résutats associé à |
-| l'itération |
+| Returns the name of the directory that contains the |
+| results of the iteration |
+---------------------------------------------------------------+
| .. module:: Delete |
| |
| **Delete(option)** |
-| Detruit l'itération et toutes ses filles éventuelles. |
+| Deletes the iteration and all its children |
| |
-| - ``option`` : un entier précisant ce qui est fait des |
-| fichiers de maillage associés |
+| - ``option``: an integer to define what to do with the |
+| MED file of the associated meshes |
| |
-| * 0 : les fichiers sont conservés |
-| * 1 : les fichiers sont détruits |
+| * 0: the files are kept |
+| * 1: the files are removed |
| |
-| Retourne un entier : |
-| * 0 : destruction réussie |
-| * autre valeur : problème |
+| Returns an integer: |
+| * 0: the destruction is done |
+| * other value: problem |
+---------------------------------------------------------------+
-Informations sur les maillages
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Information about the meshes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: SetMeshName |
| |
| **SetMeshName(mesh_name)** |
-| Définit le nom du maillage produit |
+| Defines the name of the produced mesh |
| |
-| - ``mesh_name`` : le nom du maillage produit |
+| - ``mesh_name``: the name of the produced mesh |
+---------------------------------------------------------------+
| .. module:: GetMeshName |
| |
| **GetMeshName()** |
-| Retourne le nom du maillage produit |
+| Returns the name of the produced mesh |
+---------------------------------------------------------------+
| .. module:: SetMeshFile |
| |
| **SetMeshFile(mesh_file)** |
-| Définit le fichier du maillage produit |
+| Defines the name of the MED file of the produced mesh |
| |
-| - ``mesh_file`` : le nom du fichier qui contiendra |
-| le maillage produit |
+| - ``mesh_file``: the name of the MED file of the |
+| produced mesh |
+---------------------------------------------------------------+
| .. module:: GetMeshFile |
| |
| **GetMeshFile()** |
-| Retourne le nom du fichier du maillage produit |
+| Returns the name of the MED file of the produced mesh |
+---------------------------------------------------------------+
| .. 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 |
+| Gives information about the current mesh. For every |
+| option, the choice #0 corresponds to 'no action', while |
+| the choice #1 launches the option. |
+| |
+| - ``Qual``: quality of the elements |
+| - ``Diam``: diametre of the elements |
+| - ``Conn``: connexity of the domain; a single block, how |
+| many holes, etc. |
+| - ``Tail``: size of the parts of the domain, group by |
+| group |
+| - ``Inte``: staggered elements, by dimension |
+---------------------------------------------------------------+
-Informations sur le champ
-^^^^^^^^^^^^^^^^^^^^^^^^^
+Information about the field
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: SetFieldFile |
| |
| **SetFieldFile(field_file)** |
-| Définit le fichier des champs utiles |
+| Defines the MED file of the field |
| |
-| - ``field_file`` : le nom du fichier contenant le champ |
+| - ``field_file``: the name of the MED file of the field |
+---------------------------------------------------------------+
| .. module:: SetTimeStepRank |
| |
| **SetTimeStepRank(TimeStep, Rank)** |
-| Définit les instants pour le champ |
+| Defines the time steps for the fields |
| |
-| Si un seul instant est défini pour le champ, il est pris |
-| par défaut. |
+| Useless if no time step is defined for the field. |
| |
-| Inutile si aucun instant n'est défini pour le champ |
+| If a single time step is defined for the filed, it is the |
+| default choice. |
| |
-| - ``TimeStep`` : l'instant où est pris le champ |
-| - ``Rank`` : le numéro d'ordre où est pris le champ |
+| - ``TimeStep``: the selected time step |
+| - ``Rank``: the selected rank |
+---------------------------------------------------------------+
| .. module:: SetTimeStepRankLast |
| |
| **SetTimeStepRankLast()** |
-| Précise que le dernier instant enregistré pour le champ |
-| est utilisé |
+| The last time step will be used, whatever its value |
+---------------------------------------------------------------+
| .. module:: GetFieldFileName |
| |
| **GetFieldFileName()** |
-| Retourne le nom du fichier du champ |
+| Returns the name of the MED file of the field |
+---------------------------------------------------------------+
| .. module:: GetTimeStep |
| |
| **GetTimeStep()** |
-| Retourne l'instant où est pris le champ |
+| Returns the selected time step for the field |
+---------------------------------------------------------------+
| .. module:: GetRank |
| |
| **GetRank()** |
-| Retourne le numéro d'ordre où est pris le champ |
+| Returns the selected rank for the field |
+---------------------------------------------------------------+
-Exemple
+Example
"""""""
-.. index:: single: maillage;initial
+.. index:: single: mesh;initial
-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. ::
+To create the first iteration, the starting point is the iteration associated to the initial mesh. It is the one that defines the case.
+::
iter_name = "Iteration_1"
iter_1 = case_1.NextIteration(iter_name)
iter_1.AssociateHypo("HypoField")
codret = iter_1.Compute(1, 2)
-Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
+Then, the next iteration is created from the current iteration.
+::
iter_name = "Iteration_2"
iter_2 = iter_1.NextIteration(iter_name)
codret = iter_2.Compute(1, 2)
-Saisie graphique correspondante
-"""""""""""""""""""""""""""""""
-Consulter :ref:`gui_create_iteration_en`
+Similar graphical input
+"""""""""""""""""""""""
+Look at :ref:`gui_create_iteration_en`
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| La convention d'orientation du plan est la même que celle |
-| utilisée dans les autres modules de Salome, en particulier |
+| appliquée dans les autres modules de SALOME, en particulier |
| GEOM : |
| |
| 1. plan XY ; U <==> X et V <==> Y |
Exemple
"""""""
-La création d'une boîte 3D ou d'un disque dans le plan XY se fait ainsi : ::
+La création d'une boîte 3D se fait ainsi :
+::
zone_1 = homard.CreateZoneBox ("BLOC", -1., 1., -30., 40., 10.5, 20.8)
+
+
+La création d'un disque dans le plan XY se fait ainsi :
+::
+
zone_2 = homard.CreateZoneDisk ("disque", 1., 3., 43.25, 1)
.. _tui_create_zone_en:
-La zone
-=======
+The zone
+========
.. index:: single: zone
-.. index:: single: boite
+.. index:: single: box
.. index:: single: sphere
-.. index:: single: cylindre
-.. index:: single: tuyau
-.. index:: single: disque
-.. index:: single: disque avec trou
+.. index:: single: cylinder
+.. index:: single: pipe
+.. index:: single: disk
+.. index:: single: disk with a hole
.. index:: single: 2D
The variables are described in :ref:`gui_create_zone_en`.
| .. module:: CreateZoneBox |
| |
| **CreateZoneBox(zone_name, Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)** |
-| Returns an instance of the class ``zone`` de type parallélépipèdique |
-| après sa création |
+| Returns an instance of the class ``zone`` of type box |
+| after its creation |
| |
-| - ``zone_name``: le nom de la zone basée sur un parallélépipède |
-| - ``Xmin``, ``Xmax``: coordonnées extrêmes selon X |
-| - ``Ymin``, ``Ymax``: coordonnées extrêmes selon Y |
-| - ``Zmin``, ``Zmax``: coordonnées extrêmes selon Z |
+| - ``zone_name``: the name of the zone based on a box |
+| - ``Xmin``, ``Xmax``: min/max coordinates extrêmes along X |
+| - ``Ymin``, ``Ymax``: min/max coordinates extrêmes along Y |
+| - ``Zmin``, ``Zmax``: min/max coordinates extrêmes along Z |
+----------------------------------------------------------------------------------+
| .. module:: CreateZoneCylinder |
| |
| **CreateZoneCylinder(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H)** |
-| Returns an instance of the class ``zone`` de type cylindrique |
-| après sa création |
+| Returns an instance of the class ``zone`` of type cylinder |
+| after its creation |
| |
-| - ``zone_name``: le nom de la zone basée sur un cylindre |
-| - ``Xbase``, ``Ybase``, ``Zbase``: coordonnées d'un point de base |
-| positionné sur l'axe |
-| - ``Xaxe``, ``Yaxe``, ``Zaxe``: vecteur de l'axe |
-| - ``R`` : rayon du cylindre |
-| - ``H`` : hauteur du cylindre |
+| - ``zone_name``: the name of the zone based on a cylinder |
+| - ``Xbase``, ``Ybase``, ``Zbase``: coordinates of a point on the axis |
+| - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis |
+| - ``R``: radius of the cylinder |
+| - ``H``: height of the cylinder |
+----------------------------------------------------------------------------------+
| .. module:: CreateZonePipe |
| |
| **CreateZonePipe(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H, Rint)** |
-| Returns an instance of the class ``zone`` de type tuyau |
-| après sa création |
+| Returns an instance of the class ``zone`` of type pipe |
+| after its creation |
| |
-| - ``zone_name`` : le nom de la zone basée sur un tuyau |
-| - ``Xbase``, ``Ybase``, ``Zbase`` : coordonnées d'un point de base |
-| positionné sur l'axe |
-| - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe |
-| - ``R`` : rayon externe du tuyau |
-| - ``H`` : hauteur du tuyau |
-| - ``R`` : rayon interne du tuyau |
+| - ``zone_name``: the name of the zone based on a pipe |
+| - ``Xbase``, ``Ybase``, ``Zbase``: coordinates of a point on the axis |
+| - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis |
+| - ``R``: external radius of the pipe |
+| - ``H``: height of the pipe |
+| - ``R``: internal radius of the pipe |
+----------------------------------------------------------------------------------+
| .. module:: CreateZoneSphere |
| |
| **CreateZoneSphere(zone_name, Xcen, Ycen, Zcen, R)** |
-| Returns an instance of the class ``zone`` de type sphérique |
-| après sa création |
+| Returns an instance of the class ``zone`` of type sphere |
+| after its creation |
| |
-| - ``zone_name`` : le nom de la zone basée sur une sphère |
-| - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère |
-| - ``R`` : rayon de la sphère |
+| - ``zone_name``: the name of the zone based on a sphere |
+| - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the center of the sphere |
+| - ``R``: radius of the sphere |
+----------------------------------------------------------------------------------+
| .. module:: CreateZoneBox2D |
| |
| **CreateZoneBox2D(zone_name, Umin, Umax, Vmin, Vmax, Orient)** |
-| Returns an instance of the class ``zone`` de type rectangulaire |
-| après sa création |
+| Returns an instance of the class ``zone`` of type rectangle |
+| after its creation |
| |
-| - ``zone_name`` : le nom de la zone basée sur un rectangle |
-| - ``Umin``, ``Umax`` : coordonnées extrêmes pour la 1ère dimension |
-| - ``Vmin``, ``Vmax`` : coordonnées extrêmes pour la 2nde dimension |
-| - ``Orient`` : entier précisant la convention d'orientation du plan |
+| - ``zone_name``: the name of the zone based on a rectangle |
+| - ``Umin``, ``Umax``: min/max coordinates for the 1st dimension |
+| - ``Vmin``, ``Vmax``: min/max coordinates for the 2nd dimension |
+| - ``Orient``: integer that defines the convention for the plane |
+----------------------------------------------------------------------------------+
| .. module:: CreateZoneDisk |
| |
| **CreateZoneDisk(zone_name, Ucen, Vcen, R, Orient)** |
-| Returns an instance of the class ``zone`` de type disque |
-| après sa création |
+| Returns an instance of the class ``zone`` of type disk |
+| after its creation |
| |
-| - ``zone_name`` : le nom de la zone basée sur un disque plein |
-| - ``Ucen``, ``Vcen`` : coordonnées du centre du disque |
-| - ``R`` : rayon du disque |
-| - ``Orient`` : entier précisant la convention d'orientation du plan |
+| - ``zone_name``: the name of the zone based on a full disk |
+| - ``Ucen``, ``Vcen``: coordinates of the center of the disk |
+| - ``R``: radius of the disk |
+| - ``Orient``: integer that defines the convention for the plane |
+----------------------------------------------------------------------------------+
| .. module:: CreateZoneDiskWithHole |
| |
| **CreateZoneDiskWithHole(zone_name, Ucen, Vcen, R, Rint, Orient)** |
-| Returns an instance of the class ``zone`` de type disque troué |
-| après sa création |
+| Returns an instance of the class ``zone`` of type disk with a hole |
+| after its creation |
| |
-| - ``zone_name`` : le nom de la zone basée sur un disque troué |
-| - ``Ucen``, ``Vcen`` : coordonnées du centre du disque |
-| - ``R`` : rayon externe du disque |
-| - ``Rint`` : rayon interne du disque |
-| - ``Orient`` : entier précisant la convention d'orientation du plan |
+| - ``zone_name``: the name of the zone based on a disk with a hole |
+| - ``Ucen``, ``Vcen``: coordinates of the center of the disk |
+| - ``R``: external radius of the disk |
+| - ``Rint``: internal radius of the disk |
+| - ``Orient``: integer that defines the convention for the plane |
+----------------------------------------------------------------------------------+
+---------------------------------------------------------------+
+---------------------------------------------------------------+
-| La convention d'orientation du plan est la même que celle |
-| utilisée dans les autres modules de Salome, en particulier |
-| GEOM : |
+| The convention of the orientation of the plane is the same |
+| as the one that is applied in the other modules of SALOME, |
+| in particular GEOM: |
| |
-| 1. plan XY ; U <==> X et V <==> Y |
-| 2. plan YZ ; U <==> Y et V <==> Z |
-| 3. plan ZX ; U <==> Z et V <==> X |
+| 1. plane XY ; U <==> X and V <==> Y |
+| 2. plane YZ ; U <==> Y and V <==> Z |
+| 3. plane ZX ; U <==> Z and V <==> X |
+---------------------------------------------------------------+
.. note::
- Les fonctions définissant des zones 2D ne doivent être utilisées que si l'intégralité du
- maillage est 2D, dans un des plans de coordonnées.
+ The functions that define 2D zones should be used only of the whole mesh is 2D into a plane of coordinates.
| .. module:: GetZone |
| |
| **GetZone(zone_name)** |
-| Returns an instance of the class classe ``zone`` connue |
-| son nom |
+| Returns an instance of the class ``zone`` |
+| known by its name |
| |
-| - ``zone_name`` : le nom de la zone |
+| - ``zone_name``: the name of the zone |
+---------------------------------------------------------------+
| .. module:: GetAllZonesName |
| |
| **GetAllZonesName()** |
-| Retourne la liste des noms de toutes les zones créées |
+| Returns the liste of the name of all the existing zones |
| |
+---------------------------------------------------------------+
Methods of the class zone
-""""""""""""""""""""""""""
+"""""""""""""""""""""""""
+---------------------------------------------------------------+
+---------------------------------------------------------------+
| .. module:: GetName |
| |
| **GetName()** |
-| Retourne le nom de la zone |
+| Returns the name of the zone |
+---------------------------------------------------------------+
| .. module:: GetType |
| |
| **GetType()** |
-| Retourne le type de la zone |
+| Returns the type of the zone |
| |
-| * 2 : parallélépipède |
-| * 3 : sphère |
-| * 5 : cylindre |
-| * 7 : tuyau |
-| * 11, 12, 13 : rectangle et orientation 1, 2 ou 3 |
-| * 31, 32, 33 : disque et orientation 1, 2 ou 3 |
-| * 61, 62, 63 : disque percé et orientation 1, 2 ou 3 |
+| * 2: box |
+| * 3: sphere |
+| * 5: cylinder |
+| * 7: pipe |
+| * 11, 12, 13: rectangle and orientation 1, 2 ou 3 |
+| * 31, 32, 33: disk and orientation 1, 2 ou 3 |
+| * 61, 62, 63: disk with a hole and orientation 1, 2 |
+| ou 3 |
+---------------------------------------------------------------+
| .. module:: GetCoords |
| |
| **GetCoords()** |
-| Retourne un tableau contenant les coordonnées de la zone |
-| dans l'ordre d'entrée dans le CreateZoneXXXX associé |
+| Returns the array of the coordinates of the zone |
+| with the same order as in its definition with |
+| CreateZoneXXXX |
+---------------------------------------------------------------+
| .. module:: Delete |
| |
| **Delete()** |
-| Detruit la zone |
+| Deletes the zone |
| |
-| Retourne un entier : |
-| * 0 : destruction réussie |
-| * autre valeur : problème |
+| Returns an integer: |
+| * 0: the destruction is done |
+| * other value: problem |
+---------------------------------------------------------------+
-Exemple
+Example
"""""""
-La création d'une boîte 3D ou d'un disque dans le plan XY se fait ainsi : ::
+The creation of a 3D box is done as follows:
+::
zone_1 = homard.CreateZoneBox ("BLOC", -1., 1., -30., 40., 10.5, 20.8)
- zone_2 = homard.CreateZoneDisk ("disque", 1., 3., 43.25, 1)
-Saisie graphique correspondante
-"""""""""""""""""""""""""""""""
-Consulter :ref:`gui_create_zone_en`
+The creation of a disk in the plane XY is done as follows:
+::
-.. warning::
- En mode graphique, si on édite une zone et que l'on modifie une des dimensions, toutes les itérations qui ont été calculées précédemment avec cette zone sont invalidées. En mode python, cela n'est plus vrai : les itérations restent telles quelles.
+ zone_2 = homard.CreateZoneDisk ("disk", 1., 3., 43.25, 1)
+Similar graphical input
+"""""""""""""""""""""""
+Look at :ref:`gui_create_zone_en`
+.. warning::
+ With the graphical input mode, if a zone is edited and if one of the dimensions is modified, all the iterations that were computed with this zone are unvalidated. In python mode, that is not true: the iterations stay as they are.
