Salome HOME
merge V7_7_BR
[modules/smesh.git] / doc / salome / gui / SMESH / input / about_quality_controls.doc
index f197bae0cd12570baf6a6ee7fcd29ec2a6679912..9dbb5c9923cff006424fe84e3a5c4867d98aa570 100644 (file)
@@ -1,6 +1,6 @@
 /*!
 
-\page about_quality_controls_page About quality controls
+\page quality_page About quality controls
 
 \n <b>Mesh quality control</b> in MESH is destined for visual control of the generated mesh.
 
@@ -13,32 +13,65 @@ the meshing elements and these calculated values is shown with the
 help of a scalar bar, which is displayed near the presentation of your
 mesh.
 
-There are 1D, 2D and 3D quality controls.
+There are four types of quality controls, corresponding to node, edge,
+face and volume entity type.
 
-1D mesh quality controls:
+Node quality controls:
 <ul>
-<li>\ref free_borders_page "Free borders"</li>
-<li>\ref borders_at_multi_connection_page "Borders at multi-connection"</li>
-<li>\ref length_page "Length"</li>
+<li>\subpage free_nodes_page "Free nodes"</li>
+<li>\subpage double_nodes_control_page "Double nodes"</li>
 </ul>
 
-2D mesh quality controls:
+Edge quality controls:
 <ul>
-<li>\ref free_edges_page "Free edges"</li>
-<li>\ref length_2d_page "Length 2D"</li>
-<li>\ref borders_at_multi_connection_2d_page "Borders at multi-connection 2D"</li>
-<li>\ref area_page "Area"</li>
-<li>\ref taper_page "Taper"</li>
-<li>\ref aspect_ratio_page "Aspect ratio"</li>
-<li>\ref minimum_angle_page "Minimum angle"</li>
-<li>\ref warping_page "Warping"</li>
-<li>\ref skew_page "Skew"</li>
+<li>\subpage free_borders_page "Free borders"</li>
+<li>\subpage length_page "Length"</li>
+<li>\subpage borders_at_multi_connection_page "Borders at multi-connection"</li>
+<li>\subpage double_elements_page "Double edges"</li>
 </ul>
 
-3D mesh quality controls:
+Face quality controls:
 <ul>
-<li>\ref aspect_ratio_3d_page "Aspect ratio 3D"</li>
-<li>\ref volume_page "Volume"</li>
+<li>\subpage free_edges_page "Free edges"</li>
+<li>\subpage free_faces_page "Free faces"</li>
+<li>\subpage bare_border_faces_page "Bare border faces"</li>
+<li>\subpage over_constrained_faces_page "Over-constrained faces"</li>
+<li>\subpage length_2d_page "Length 2D"</li>
+<li>\subpage borders_at_multi_connection_2d_page "Borders at multi-connection 2D"</li>
+<li>\subpage area_page "Area"</li>
+<li>\subpage taper_page "Taper"</li>
+<li>\subpage aspect_ratio_page "Aspect ratio"</li>
+<li>\subpage minimum_angle_page "Minimum angle"</li>
+<li>\subpage warping_page "Warping"</li>
+<li>\subpage skew_page "Skew"</li>
+<li>\subpage max_element_length_2d_page "Element Diameter 2D"</li>
+<li>\ref double_elements_page "Double faces"</li>
 </ul>
 
-*/
\ No newline at end of file
+Volume quality controls:
+<ul>
+<li>\subpage aspect_ratio_3d_page "Aspect ratio 3D"</li>
+<li>\subpage volume_page "Volume"</li>
+<li>\subpage max_element_length_3d_page "Element Diameter 3D"</li>
+<li>\subpage bare_border_volumes_page "Bare border volumes"</li>
+<li>\subpage over_constrained_volumes_page "Over-constrained volumes"</li>
+<li>\ref double_elements_page "Double volumes"</li>
+</ul>
+
+To manage the quality controls call pop-up in the VTK viewer and select "Controls" sub-menu
+\image html controls_popup.png
+
+<ul>
+<li> <b>Reset</b> switches off quality controls;</li>
+<li> <b>Node Controls</b> provides access to the node quality controls;</li>
+<li> <b>Edge Controls</b> provides access to the edge quality controls;</li>
+<li> <b>Face Controls</b> provides access to the face quality controls;</li>
+<li> <b>Volume Controls</b> provides access to the volume quality controls;</li>
+<li> <b>Scalar Bar Properties</b> allows setting \subpage scalar_bar_dlg;</li>
+<li> <b>Distribution -> Export ...</b> allows saving the distribution of quality control values in the text file;</li>
+<li> <b>Distribution -> Show </b> Shows/Hides the distribution histogram of the quality control values in the VTK Viewer.</li>
+<li> <b>Distribution -> Plot </b> Plots the distribution histogram of the quality control values in the Plot 2D Viewer.</li>
+</ul>
+
+
+*/