doc/salome/gui/SMESH/input/mesh_preferences.doc

   1 /*!
   2
   3 \page mesh_preferences_page Mesh preferences
   4
   5 In the Mesh module you can set mesh preferences, which can be used in
   6 later sessions with this module.
   7
   8 <h2>General Preferences</h2>
   9
  10 \image html pref21.png
  11
  12 <ul>
  13 <li><b>Automatic Update</b></li>
  14 <ul>
  15 <li>If you toggle <b>Automatic Update</b> checkbox, the model in your
  16 viewer automatically updated whenever you make changes in it.</li>
  17 <li><b>Size limit (elements)</b> - allows to specify the maximum
  18 number of elements in the resulting mesh for which the automatic updating
  19 of the presentation is performed. This option affects only
  20 <b>Compute</b> operation. Zero value means "no limit". Default value
  21 is 500 000 mesh elements.
  22 </ul>
  23 <li><b>Quality Controls</b></li>
  24 <ul>
  25 <li>If you toggle <b>Display entity</b>, both faces and edges of an
  26 object will be displayed in the viewer by default.</li>
  27 <li>If you toggle <b>Use precision</b> checkbox, you can display numbers in
  28 <b>Quality Control</b> diagrams at the necessary level of precision.</li>
  29 <li><b>Number of digits after point</b> - defines precision for <b>Quality Controls</b>. By default, numbers in <b>Quality Control</b>
  30 diagrams are presented as integers.</li>
  31 <li><b>Double nodes tolerance</b> defines maximal distance between two
  32 mesh nodes at which they are considered coincident by <b>Double nodes</b>
  33 quality control.
  34 </ul>
  35 <li><b>Display mode</b> - allows to set Wireframe, Shading, Nodes or Shrink
  36 presentation mode as default.</li>
  37 <li><b>Representation of the 2D quadratic elements</b></li>
  38 <ul>
  39 <li><b>Representation of the 2D quadratic elements</b> combobox - allows
  40 to select lines or arcs for representation of quadratic elements.</li>
  41 <li><b>Maximum Angle</b> - maximum deviation angle used by the
  42 application to build arcs. </li>
  43 </ul>
  44 <li><b>Mesh export</b></li>
  45 <ul>
  46 <li>If you toggle <b>Automatically create groups for MED export</b> checkbox,
  47 this operation will be carried out automatically.</li>
  48 <li>If you toggle <b>Automatic renumbering</b> checkbox, the exported
  49 mesh will be renumbered automatically</li>
  50 </ul>
  51 <li><b>Mesh computation</b></li>
  52 <ul>
  53 <li><b>Show a computation result notification</b> combobox allows to
  54 select the notification mode about a mesh computation result.
  55 There are 3 possible modes:</li>
  56 <ul>
  57 <li><b>Never</b> - do not show the result dialog at all;</li>
  58 <li><b>Errors only</b> - the result dialog will be shown if there were
  59 some errors during a mesh computation;</li>
  60 <li><b>Always</b> - show the result dialog after each mesh
  61 computation. This is a default mode.</li>
  62 </ul></ul>
  63 <li><b>Mesh information</b></li>
  64 <ul>
  65 <li><b>Mesh element information</b></li> - Change the way mesh element
  66 information is shown:
  67 <ul>
  68 <li><b>Simple</b> - as a plain text</li>
  69 <li><b>Tree</b> - in a tree-like form</li>
  70 </ul>
  71 <li><b>Automatic nodes compute limit</b></li> - allows to define the size limit for the
  72 mesh groups for which the number of underlying nodes is calculated
  73 automatically. If the group size exceeds the value set in the preferences,
  74 the user will have to press \em Compute button explicitly. Zero value
  75 means "no limit". By default the value is set to 100 000 mesh elements.
  76 </li></ul>
  77 <li><b>Automatic Parameters</b></li>
  78 <ul>
  79 <li><b>Ratio Bounding Box Diagonal / Max Size</b> - this parameter is
  80 used for automatic meshing: ratio between the bounding box of the
  81 meshed object and the Max Size of segments.</li>
  82 <li><b>Default Number of Segments</b> - allows defining the default
  83 number of segments on each edge</li>
  84 </li></ul>
  85 <li><b>Mesh loading</b></li>
  86 <ul>
  87 <li>If you toggle <b>No mesh loading from study file at hypothesis modification</b>
  88   checkbox, then mesh data won't be loaded from the study file
  89   provided that your first action on a mesh after study opening is
  90   modification of hypotheses. This can save your time by omitting
  91   loading data of a large mesh that your are going to recompute with
  92   other parameters.</li>
  93 </ul>
  94 <li><b>Input fields precision</b></li>
  95 <ul>
  96 <li><b>Length precision</b> - allows to adjust input precision of coordinates and dimensions.</li>
  97 <li><b>Angular precision</b> - allows to adjust input precision of angles.</li>
  98 <li><b>Length tolerance precision</b> - allows to adjust input precision of tolerance of coordinates and dimensions.</li>
  99 <li><b>Parametric precision</b> - allows to adjust input precision of parametric values.</li>
 100 <li><b>Area precision</b> - allows to adjust input precision of mesh element area.</li>
 101 <li><b>Volume precision</b> - allows to adjust input precision of mesh element volume.</li>
 102 </ul>
 103 <li><b>Python Dump</b></li>
 104 <ul>
 105 <li><b>Historical python dump</b> checkbox switches Python Dump from
 106   \a Historical to \a Snapshot mode and backward. In the \a
 107   Historical mode, the Python Dump script includes all commands
 108   performed by SMESH engine. In the \a Snapshot mode, commands
 109   relating to objects removed from the Study are excluded from the
 110   script as well as commands not influencing the current state of meshes.</li>
 111 </ul>
 112 </ul>
 113
 114 <h2>Mesh Preferences</h2>
 115
 116 \image html pref22.png
 117
 118 <ul>
 119 <li><b>Nodes</b></li>
 120 <ul>
 121 <li><b>Color</b> -  allows to select the color of nodes. Click on the
 122 colored line to access to the <b>Select Color</b> dialog box.</li>
 123 <li><b>Type of marker</b> - allows to define the shape of nodes.</li>
 124 <li><b>Scale of marker</b> - allows to define the size of nodes.</li>
 125 </ul>
 126 <li><b>Elements</b></li>
 127 <ul>
 128 <li><b>Surface color</b>  - allows to select the surface color of elements
 129 (seen in Shading mode). Click on the colored line to access to the <b>Select Color</b> dialog box.</li>
 130 <li><b>Back surface color</b> - allows to select the interior surface color
 131 of elements. Use the slider to select the color generated basing on
 132 the <b>Surface color</b> by changing its brightness and saturation.</li>
 133 <li><b>Outline color</b> - allows to select the color of element
 134 borders. Click on the colored line to access to the <b>Select Color</b> dialog box.</li>
 135 <li><b>Wireframe color</b> - allows to select the color of borders of
 136 elements in the wireframe mode. Click on the colored line to access to the <b>Select Color</b> dialog box.</li>
 137 <li><b>Width</b> - allows to define the width of lines (edges and borders of elements).</li>
 138 <li><b>Shrink coef.</b> - allows to define relative space of elements
 139 compared to gaps between them in shrink mode.</li>
 140 </ul>
 141 <li><b>Orientation of Faces</b> - allows to define the behavior of
 142 <b>Orientation of faces</b> functionality</li>
 143 <ul>
 144 <li> \b Color - allows to define the color of orientation vertors;</li>
 145 <li> \b Scale - allows to define the size of orientation vectors;</li>
 146 <li> <b> 3D Vector </b> checkbox allows to choose between 2D planar
 147 and 3D vectors.</li>
 148 </ul>
 149 </ul>
 150
 151 <br><h2>Selection Preferences</h2>
 152
 153 \image html pref23.png
 154
 155 <ul>
 156 <li><b>Selection</b> - performed with mouse-indexing (preselection)
 157 and left-clicking on an object, whose appearance changes as defined in
 158 the <b>Preferences</b>.</li>
 159 <ul>
 160 <li><b>Object Color</b> -  allows to select the color of mesh (edges and
 161 borders of meshes) of the selected entity. Click on the colored line
 162 to access to the <b>Select Color</b> dialog
 163 box.</li>
 164 <li><b>Element color</b> - allows to select the color of surface of selected
 165 elements (seen in Shading mode). Click on the colored line to access
 166 to the <b>Select Color</b> dialog box.</li>
 167 </ul>
 168 <li><b>Preselection</b> - performed with mouse-indexing on an object,
 169 whose appearance changes as defined in the <b>Preferences</b>.</li>
 170 <ul>
 171 <li><b>Highlight Color</b> -  allows to select the color of mesh (edges and
 172 borders of meshes) of the entity . Click on the colored line to access
 173 to the <b>Select Color</b> dialog box.</li>
 174 </ul>
 175 <li><b>Precision</b> - in this menu you can set the value of precision
 176 used for <b>Nodes</b>, <b>Elements</b> and <b>Objects</b>.</li>
 177 </ul>
 178
 179 <br><h2>Scalar Bar Preferences</h2>
 180
 181 \image html pref24.png
 182
 183 <ul>
 184 <li><b>Font</b> - in this menu you can set type, face and color for
 185 the font of <b>Title</b> and <b>Labels</b>.</li>
 186 <li><b>Colors & Labels</b> - in this menu you can set the <b>number of
 187 colors</b> and the <b>number of labels</b> in use.</li>
 188 <li><b>Orientation</b> - here you can choose between vertical and
 189 horizontal orientation of the <b>Scalar Bar</b></li>.
 190 <li><b>Origin & Size Vertical & Horizontal</b> - allows to define
 191 placement (<b>X</b> and <b>Y</b>) and lookout (<b>Width</b> and
 192 <b>Height</b>) of Scalar Bars</li>
 193 <ul>
 194 <li><b>X</b>: abscissa of the point of origin (from the left
 195 side)</li>
 196 <li><b>Y</b>: ordinate of the origin of the bar (from the bottom)</li>
 197 </ul>
 198 <li><b>Distribution</b> in this menu you can Show/Hide distribution histogram of the values of the <b>Scalar Bar</b> and specify the <b>Coloring Type</b> of the histogram</li>
 199 <ul>
 200 <li><b>Multicolor</b> the histogram is colored as <b>Scalar Bar</b></li>
 201 <li><b>Monocolor</b> the histogram is colored as selected with <b>Distribution color</b> selector</li>
 202 </ul>
 203 </ul>
 204
 205 */