src/Tools/padder/doc/input/padder_userguide.doc

   1 /*!
   2
   3 \page padder_userguide_page Use the padder SMESH Plugin
   4
   5 -# \ref S1_PADDER
   6 -# \ref S2_PADDER
   7 -# \ref S3_PADDER
   8
   9 \section S1_PADDER The PADDER Algorithm
  10
  11 PADDER is an algorithm that creates a set of particules called a "discrete mesh".
  12 The particules are characterized by a location in space and a weight that can be considered
  13 as the radius of a sphere whose center is the location of the particule.
  14
  15 Discrete meshes are typically used to modelize civil components in rapid dynamic
  16 computation problems (seisms, chocs). These components consists in concrete parts
  17 embedding steal bares for reinforcement. These parts are input to the algorithm
  18 as standard finite elements meshes. The cells of theses meshes drive the location
  19 and sizing of particules.
  20
  21 In the med representation, a discrete mesh is described as MED_BALL elements.
  22 A MED_BALL element is defined by a location and a radius.
  23
  24 \section S2_PADDER The PADDER SALOME plugin
  25
  26 The PADDER algoritm is integrated in the module SMESH as a SALOME
  27 plugin. This section illustrates how to use this plugin to create a
  28 discrete mesh.
  29
  30 In this example, we suppose that two standard meshes (Finite Elements
  31 Meshes) have been created and publish in the study to modelize the
  32 concrete part (here with the name "concrete") and the steal bars part
  33 (here with the name "ferrail"):
  34
  35 \image html SMESH_spadder_start.png
  36
  37 The PADDER plugin can be invoked from the SMESH plugins menu, as
  38 illustrated on the figure below:
  39
  40 \image html SMESH_spadder_menu.png
  41
  42 When you clic on the "PADDER mesher" item, the graphical interface of
  43 the PADDER plugin appears:
  44
  45 \image html SMESH_spadder_plugindialog_start.png
  46
  47 This interface invites you to specify input data by pressing the button
  48 "Input". This command opens the Input dialog box to specify the list
  49 of meshes and the type of the selected meshes (to be choosen between
  50 "concrete" or "steelbar" using the combobox on the right side of the
  51 input line):
  52
  53 \image html SMESH_spadder_inputdialog_start.png
  54
  55 In the figure below, the mesh with name "concrete" has been selected
  56 in the study and added in the list of input file as a "concrete
  57 mesh". You have to input the mesh in the dialog using the rounded
  58 arrow icon, then specify a group name (the name of the group of
  59 MED_BALL created for this mesh in the resulting mesh), and finnaly
  60 clic on the "Add" icon:
  61
  62 \image html SMESH_spadder_inputdialog_concrete.png
  63
  64 Then, the mesh with name "ferrail" is selected and added to the list
  65 as a "steelbar mesh":
  66
  67 \image html SMESH_spadder_inputdialog_steelbar.png
  68
  69 The input dialog box can be validated toreturn to the main plugin
  70 interface. The "Compute" button is now enable, indicating that the
  71 problem is ready to be computed:
  72
  73 \image html SMESH_spadder_plugindialog_compute_ready.png
  74
  75 The command "Compute" start the job. The progression can be requested
  76 using the command "Refresh". In the figure below, the job is still
  77 running:
  78
  79 \image html SMESH_spadder_plugindialog_compute_running.png
  80
  81 Finally, the job is finished and the result is ready to be published
  82 in the SALOME study:
  83
  84 \image html SMESH_spadder_plugindialog_compute_finished.png
  85
  86 Clic on the command "Publish" to explicitly import the resulting med
  87 file in SMESH and published the resulting mesh in the SALOME study:
  88
  89 \image html SMESH_spadder_plugindialog_published.png
  90
  91 Note that this mesh contains one group for each of the input mesh. A
  92 group with the name specified in the input dialog has been defined for
  93 the set of MED_BALL created from the corresponding input mesh:
  94
  95 \image html SMESH_spadder_end.png
  96
  97 \section S3_PADDER Configuring the plugin
  98
  99 The configuration of the plugin consists in specifying the location of
 100 the padder executable program for each of the SALOME resource (at
 101 least for the localhost resource). This specification is done in the
 102 file padder.cfg, located in the plugin installation folder
 103 (i.e. <SMESH_ROOT_DIR>/plugins):
 104
 105 \code
 106 # This section specify the configurations to be used respectively for
 107 # the local execution and the remote execution. The value for 'local'
 108 # and 'remote' keys must be the name of a configuration section in
 109 # this file. The default key must specify a value between "local" or
 110 # "remote" to indicate the user preference.
 111 [resources]
 112 local   = localhost
 113 remote  = nepal
 114
 115 [preferences]
 116 defaultres = local
 117
 118 # The following sections defines the available configurations.
 119 # The name of the section can be choosen arbitrary. But the value of
 120 # the resname key MUST be the name of a SALOME resource defined in the
 121 # catalog of resources (CatalogResources.xml).
 122
 123 # For each section:
 124 # - resname : the name of the SALOME resource to be used in this configuration
 125 # - binpath : the path to the padder executable program on this resource
 126 # - envpath : the path to the environment file on this resource
 127 [localhost]
 128 resname = localhost
 129 binpath = /home/.programs/salome/workspace/V6_4_BR/SMESH/install/share/salome/resources/smesh/padderexe/padder.exe
 130 envpath = /home/.programs/salome/workspace/V6_4_BR/SMESH/install/share/salome/resources/smesh/padderexe/envPadder.sh
 131
 132 [nepal]
 133 resname = nepal@nepal
 134 binpath = /usr/local/bin/padder.exe
 135 envpath = /usr/local/share/envPadder.sh
 136 \endcode
 137
 138 */
 139