From c570e0f979380e153cef5dd6beb519180e89bd31 Mon Sep 17 00:00:00 2001 From: Paul RASCLE Date: Mon, 18 Apr 2016 14:07:49 +0200 Subject: [PATCH] general crack dialog documentation --- src/Tools/blocFissure/doc/faq.rst | 19 ++ src/Tools/blocFissure/doc/gui.rst | 78 ++++++++ .../blocFissure/doc/images/01_CubeAngle.png | Bin 0 -> 16367 bytes .../blocFissure/doc/images/01_CubeAngle_2.png | Bin 0 -> 17181 bytes .../blocFissure/doc/images/02_CubeAngle2.png | Bin 0 -> 20790 bytes .../doc/images/02_CubeAngle2_2.png | Bin 0 -> 28416 bytes .../blocFissure/doc/images/03_cylindre.png | Bin 0 -> 18194 bytes .../blocFissure/doc/images/03_cylindre_2.png | Bin 0 -> 31324 bytes .../blocFissure/doc/images/04_cylindre2.png | Bin 0 -> 20197 bytes .../blocFissure/doc/images/04_cylindre2_2.png | Bin 0 -> 32279 bytes .../blocFissure/doc/images/05_disque.png | Bin 0 -> 33658 bytes .../blocFissure/doc/images/05_disque_2.png | Bin 0 -> 25703 bytes .../blocFissure/doc/images/06_ellipse1.png | Bin 0 -> 16597 bytes .../blocFissure/doc/images/06_ellipse1_2.png | Bin 0 -> 25224 bytes .../blocFissure/doc/images/07_ellipse2.png | Bin 0 -> 18504 bytes .../blocFissure/doc/images/07_ellipse2_2.png | Bin 0 -> 15275 bytes .../doc/images/08_eprouvetteCourbe.png | Bin 0 -> 19681 bytes .../doc/images/08_eprouvetteCourbe_2.png | Bin 0 -> 31486 bytes .../doc/images/09_eprouvetteDroite.png | Bin 0 -> 13986 bytes .../doc/images/09_eprouvetteDroite_2.png | Bin 0 -> 32365 bytes .../doc/images/10_eprouvetteDroite2.png | Bin 0 -> 16064 bytes .../doc/images/10_eprouvetteDroite2_2.png | Bin 0 -> 23142 bytes .../blocFissure/doc/images/11_faceGauche.png | Bin 0 -> 37786 bytes .../doc/images/11_faceGauche_2.png | Bin 0 -> 42567 bytes .../blocFissure/doc/images/12_faceGauche2.png | Bin 0 -> 21163 bytes .../doc/images/12_faceGauche2_2.png | Bin 0 -> 32782 bytes src/Tools/blocFissure/doc/images/13_vis_1.png | Bin 0 -> 45831 bytes .../blocFissure/doc/images/13_vis_1_2.png | Bin 0 -> 73005 bytes .../blocFissure/doc/images/BF_GUI_capture.png | Bin 0 -> 44903 bytes .../doc/images/Capture_GUI_pipes.png | Bin 0 -> 80263 bytes .../doc/images/Capture_GUI_pipes_2.png | Bin 0 -> 174075 bytes src/Tools/blocFissure/doc/images/GUI_BG.png | Bin 0 -> 197652 bytes src/Tools/blocFissure/doc/images/coude_0.png | Bin 0 -> 18085 bytes .../blocFissure/doc/images/coude_0_2.png | Bin 0 -> 64981 bytes src/Tools/blocFissure/doc/images/coude_3.png | Bin 0 -> 74299 bytes .../doc/images/general_princ_a.png | Bin 0 -> 11626 bytes .../doc/images/general_princ_b.png | Bin 0 -> 856 bytes .../doc/images/general_princ_c.png | Bin 0 -> 11013 bytes .../doc/images/general_princ_d.png | Bin 0 -> 11945 bytes .../doc/images/general_princ_e.png | Bin 0 -> 3039 bytes .../doc/images/general_princ_f.png | Bin 0 -> 9675 bytes .../doc/images/general_princ_g.png | Bin 0 -> 10924 bytes .../doc/images/general_princ_h.png | Bin 0 -> 8342 bytes .../doc/images/general_princ_i.png | Bin 0 -> 17281 bytes .../doc/images/general_princ_j.png | Bin 0 -> 23091 bytes .../doc/images/general_princ_j_old.png | Bin 0 -> 28845 bytes .../doc/images/general_princ_k.png | Bin 0 -> 12488 bytes .../doc/images/general_princ_k_old.png | Bin 0 -> 16870 bytes src/Tools/blocFissure/doc/images/intro.png | Bin 0 -> 33009 bytes .../doc/images/longueur_influence.png | Bin 0 -> 51020 bytes .../blocFissure/doc/images/parametres.png | Bin 0 -> 61944 bytes .../blocFissure/doc/images/parametres_GUI.png | Bin 0 -> 61157 bytes .../doc/images/recom_groupe_apres.png | Bin 0 -> 8710 bytes .../doc/images/recom_groupe_avant.png | Bin 0 -> 7751 bytes .../doc/images/recom_interface_apres.png | Bin 0 -> 40314 bytes .../doc/images/recom_interface_avant.png | Bin 0 -> 21733 bytes .../doc/images/schema_fis_ext2.png | Bin 0 -> 67132 bytes .../blocFissure/doc/images/schema_fissure.png | Bin 0 -> 85443 bytes .../blocFissure/doc/images/schema_lignes1.png | Bin 0 -> 24412 bytes .../doc/images/schema_tube_sain.png | Bin 0 -> 75423 bytes .../blocFissure/doc/images/tutorial_1.png | Bin 0 -> 9899 bytes .../blocFissure/doc/images/tutorial_2.png | Bin 0 -> 10251 bytes .../blocFissure/doc/images/tutorial_3.png | Bin 0 -> 20325 bytes .../blocFissure/doc/images/tutorial_4.png | Bin 0 -> 16875 bytes src/Tools/blocFissure/doc/index.rst | 49 ++--- src/Tools/blocFissure/doc/introduction.rst | 22 +++ src/Tools/blocFissure/doc/pipes.rst | 104 +++++++++++ src/Tools/blocFissure/doc/principles.rst | 122 +++++++++++++ src/Tools/blocFissure/doc/scripts.rst | 86 +++++++++ src/Tools/blocFissure/doc/testcases.rst | 170 ++++++++++++++++++ src/Tools/blocFissure/doc/tutorials.rst | 66 +++++++ src/Tools/blocFissure/doc/use.rst | 14 ++ 72 files changed, 698 insertions(+), 32 deletions(-) create mode 100755 src/Tools/blocFissure/doc/faq.rst create mode 100755 src/Tools/blocFissure/doc/gui.rst create mode 100644 src/Tools/blocFissure/doc/images/01_CubeAngle.png create mode 100644 src/Tools/blocFissure/doc/images/01_CubeAngle_2.png create mode 100644 src/Tools/blocFissure/doc/images/02_CubeAngle2.png create mode 100644 src/Tools/blocFissure/doc/images/02_CubeAngle2_2.png create mode 100644 src/Tools/blocFissure/doc/images/03_cylindre.png create mode 100644 src/Tools/blocFissure/doc/images/03_cylindre_2.png create mode 100644 src/Tools/blocFissure/doc/images/04_cylindre2.png create mode 100644 src/Tools/blocFissure/doc/images/04_cylindre2_2.png create mode 100644 src/Tools/blocFissure/doc/images/05_disque.png create mode 100644 src/Tools/blocFissure/doc/images/05_disque_2.png create mode 100644 src/Tools/blocFissure/doc/images/06_ellipse1.png create mode 100644 src/Tools/blocFissure/doc/images/06_ellipse1_2.png create mode 100644 src/Tools/blocFissure/doc/images/07_ellipse2.png create mode 100644 src/Tools/blocFissure/doc/images/07_ellipse2_2.png create mode 100644 src/Tools/blocFissure/doc/images/08_eprouvetteCourbe.png create mode 100644 src/Tools/blocFissure/doc/images/08_eprouvetteCourbe_2.png create mode 100644 src/Tools/blocFissure/doc/images/09_eprouvetteDroite.png create mode 100644 src/Tools/blocFissure/doc/images/09_eprouvetteDroite_2.png create mode 100644 src/Tools/blocFissure/doc/images/10_eprouvetteDroite2.png create mode 100644 src/Tools/blocFissure/doc/images/10_eprouvetteDroite2_2.png create mode 100644 src/Tools/blocFissure/doc/images/11_faceGauche.png create mode 100644 src/Tools/blocFissure/doc/images/11_faceGauche_2.png create mode 100644 src/Tools/blocFissure/doc/images/12_faceGauche2.png create mode 100644 src/Tools/blocFissure/doc/images/12_faceGauche2_2.png create mode 100644 src/Tools/blocFissure/doc/images/13_vis_1.png create mode 100644 src/Tools/blocFissure/doc/images/13_vis_1_2.png create mode 100644 src/Tools/blocFissure/doc/images/BF_GUI_capture.png create mode 100644 src/Tools/blocFissure/doc/images/Capture_GUI_pipes.png create mode 100644 src/Tools/blocFissure/doc/images/Capture_GUI_pipes_2.png create mode 100644 src/Tools/blocFissure/doc/images/GUI_BG.png create mode 100644 src/Tools/blocFissure/doc/images/coude_0.png create mode 100644 src/Tools/blocFissure/doc/images/coude_0_2.png create mode 100644 src/Tools/blocFissure/doc/images/coude_3.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_a.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_b.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_c.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_d.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_e.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_f.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_g.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_h.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_i.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_j.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_j_old.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_k.png create mode 100644 src/Tools/blocFissure/doc/images/general_princ_k_old.png create mode 100644 src/Tools/blocFissure/doc/images/intro.png create mode 100644 src/Tools/blocFissure/doc/images/longueur_influence.png create mode 100644 src/Tools/blocFissure/doc/images/parametres.png create mode 100644 src/Tools/blocFissure/doc/images/parametres_GUI.png create mode 100644 src/Tools/blocFissure/doc/images/recom_groupe_apres.png create mode 100644 src/Tools/blocFissure/doc/images/recom_groupe_avant.png create mode 100644 src/Tools/blocFissure/doc/images/recom_interface_apres.png create mode 100644 src/Tools/blocFissure/doc/images/recom_interface_avant.png create mode 100644 src/Tools/blocFissure/doc/images/schema_fis_ext2.png create mode 100644 src/Tools/blocFissure/doc/images/schema_fissure.png create mode 100644 src/Tools/blocFissure/doc/images/schema_lignes1.png create mode 100644 src/Tools/blocFissure/doc/images/schema_tube_sain.png create mode 100644 src/Tools/blocFissure/doc/images/tutorial_1.png create mode 100644 src/Tools/blocFissure/doc/images/tutorial_2.png create mode 100644 src/Tools/blocFissure/doc/images/tutorial_3.png create mode 100644 src/Tools/blocFissure/doc/images/tutorial_4.png create mode 100755 src/Tools/blocFissure/doc/introduction.rst create mode 100755 src/Tools/blocFissure/doc/pipes.rst create mode 100755 src/Tools/blocFissure/doc/principles.rst create mode 100755 src/Tools/blocFissure/doc/scripts.rst create mode 100755 src/Tools/blocFissure/doc/testcases.rst create mode 100755 src/Tools/blocFissure/doc/tutorials.rst create mode 100755 src/Tools/blocFissure/doc/use.rst diff --git a/src/Tools/blocFissure/doc/faq.rst b/src/Tools/blocFissure/doc/faq.rst new file mode 100755 index 000000000..03e5ff06c --- /dev/null +++ b/src/Tools/blocFissure/doc/faq.rst @@ -0,0 +1,19 @@ +.. _faq: + +####################### +FAQ +####################### + + - Does Bloc Fissure works on a 2D mesh ? + +No, Bloc Fissure works only for 3D meshes. However, the user can extrude the 2D mesh to a 3D mesh, insert a crack and then extract a surface containing the crack. + + - Can I insert a crack in a symmetry plan ? + +No, the user must insert the crack without using the symmetry plan passing through the crack lips. + + - I can't have Bloc Fissure working, it raises a pure python error, what can I do ? + +Bloc Fissure has some error messages for the most commonly encountered misuses. If the program raises a pure python error, it means that this error is rare or has not been encountered by the programmers yet. + +Still, either the case can't be treated using Bloc Fissure or the insertion procedure was not fully respected. In the first case, use Zcracks (soon available). In the second case, see the :ref:`tutorial `. \ No newline at end of file diff --git a/src/Tools/blocFissure/doc/gui.rst b/src/Tools/blocFissure/doc/gui.rst new file mode 100755 index 000000000..029341361 --- /dev/null +++ b/src/Tools/blocFissure/doc/gui.rst @@ -0,0 +1,78 @@ +.. _gui: + +With GUI +===================================== + +To make the use of « Bloc Fissure » easier, a Graphical User Interface (GUI) was developed. Inputs are similar to those of :ref:`script mode