src/PythonAddons/doc/pipeNetworkFeature.rst

   1 .. _pipeNetwork:
   2 .. |pipeNetwork.icon|    image:: images/pipeNetwork.png
   3
   4 Réseau de tuyaux
   5 ================
   6
   7 Cette macro crée les objets SHAPER correspondant à un réseau de tuyauteries décrit dans un fichier texte.
   8
   9 Pour créer l'objet de la tuyauterie :
  10
  11 #. Choisir dans le menu principal *Macros - > Réseau de tuyaux* ou
  12 #. Cliquer le bouton |pipeNetwork.icon| **Réseau de tuyaux** dans la barre des macros.
  13
  14 Le menu suivant apparaît :
  15
  16 .. figure:: images/pipeNetworkPanel.png
  17    :align: center
  18    :alt: Menu de création du réseau
  19
  20    Menu de création du réseau de tuyaux
  21
  22 On doit fournir le fichier de type texte qui contient le réseau. Sa syntaxe est décrite plus bas.
  23
  24 Syntaxe du fichier de données
  25 """""""""""""""""""""""""""""
  26
  27 Règles générales
  28 ----------------
  29
  30 - Chaque ligne commençant par # est ignorée
  31 - Une information par ligne
  32 - Sur une ligne, les données sont séparés par des blancs
  33 - Les données sont regroupées en 3 sections : les noeuds, la connectivité, les raccordements
  34 - Une section débute par **mot-clé section**
  35
  36 Les noeuds
  37 ----------
  38
  39 - Repérage avec **nodes section**
  40
  41 - Pour un noeud dont on donne les coordonnées en absolu :
  42
  43 ``Identifiant du noeud, le signe -, les 3 coordonnées``
  44
  45 - Pour un noeud défini par rapport à un autre :
  46
  47 ``Identifiant du noeud, identifiant du noeud de départ, les 3 coordonnées de la translation``
  48
  49 La connectivité
  50 ---------------
  51
  52 - Repérage avec **connectivity section**
  53 - Choix de la méthode de description avec **method=par_ligne** ou **method=2par2**
  54
  55 - Pour la méthode en ligne :
  56
  57 Chaque ligne est décrite par la suite de ses noeuds repérés par leurs identifiants :
  58
  59 ``Identifiant du noeud n°1, identifiant du noeud n°2, ..., identifiant du dernier noeud``
  60
  61 - Pour la méthode 2 par 2 :
  62
  63 Chaque tronçon est décrit par les 2 noeuds repérés par leurs identifiants :
  64
  65 ``Identifiant du noeud n°1 , identifiant du noeud n°2``
  66
  67 Le raccordement entre tuyaux
  68 ----------------------------
  69
  70 - Repérage avec **fillets section**
  71 - Pour chaque noeud à la jonction de 2 tuyaux :
  72
  73 Si la jonction est directe : ``Identifiant du noeud, angular_connection``
  74
  75 Si la jonction est courbe : ``Identifiant du noeud, radius=xxx`` où xxx est le rayon de courbure.
  76
  77 .. note::
  78   Par défaut, la jonction entre deux tuyaux est directe, sans rayon de courbure. On peut donc se passer de l'information ``angular_connection``. Si toutes les jonctions sont directes, on peut se passer totalement de la rubrique **fillets section**.
  79
  80 .. note::
  81   Une jonction avec un rayon de courbure ne peut avoir lieu que sur un noeud auquel aboutit exactement 2 tuyaux. L'arc de cercle est tracé dans le plan formé par les deux tuyaux. Les deux tuyaux ne doivent donc pas être colinéaires.
  82
  83 Exemple
  84 -------
  85 .. literalinclude:: examples/pipeNetwork_ligne.txt
  86     :linenos:
  87     :language: text
  88
  89 .. figure:: images/pipeNetworkExemple.png
  90    :align: center
  91    :alt: Exemple de réseau
  92
  93    Exemple de réseau
  94
  95 :download:`Téléchargement des données de cet exemple<examples/pipeNetwork_ligne.txt>`
  96
  97 Le pilotage en TUI se fait ainsi :
  98
  99 .. literalinclude:: examples/pipeNetwork.py
 100     :linenos:
 101     :language: python
 102
 103 :download:`Téléchargement du pilotage en TUI<examples/pipeNetwork.py>`
 104
 105