chi_mesh__SnapToPlaneMeshModifier.h

Go to the documentation of this file.

/** \defgroup chi_mesh__SnapToPlaneMeshModifier chi_mesh.SnapToPlaneMeshModifier
 
 
\ingroup DocMeshModifiers
Modifier that will snap nodes, that are within a tolerated distance of a plane, to the plane. This modifier is useful for straitening a boundary edge or aligning vertices that misaligned during meshing.
 
 
## Example usage:
Create this object:
\code
params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
chi_mesh.SnapToPlaneMeshModifier.Create(params)
\endcode
## Required Input parameters
\htmlonly
 
<div style="display: block;">
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><span class="arrow" style="padding-left: 0px;">►</span><TT><B>normal</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe normal of the plane to which the nodes are to be snapped</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. The normal of the plane to which the nodes are to be snapped.
</p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><span class="arrow" style="padding-left: 0px;">►</span><TT><B>point</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe anchor point of the plane</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. The anchor point of the plane.
</p>
</div>
 
</div>
\endhtmlonly
 
## Optional Input parameters
\htmlonly
 
<div style="display: block;">
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><span class="arrow" style="padding-left: 0px;">►</span><TT><B>boundaries_only</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspIf set to true, only boundary nodes will be snapped</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. If set to true, only boundary nodes will be snapped.
</p>
  <p>Default value: <TT style="color:grey">true</TT></p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><span class="arrow" style="padding-left: 0px;">►</span><TT><B>check_face_alignment</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspIf set, only faces that match the plane normal (within tolerance) will have their nodes snapped</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. If set, only faces that match the plane normal (within tolerance) will have their nodes snapped.
</p>
  <p>Default value: <TT style="color:grey">false</TT></p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><span class="arrow" style="padding-left: 0px;">►</span><TT><B>tolerance</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTolerance per dimension within which a face/edge will be aligned</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Tolerance per dimension within which a face/edge will be aligned
</p>
  <p>Default value: <TT style="color:grey">1e-05(double)</TT></p>
</div>
 
</div>
\endhtmlonly
 
\htmlonly
 
<script>
 
{
    var coll = document.getElementsByClassName("droppy2");
    var i;
    
    for (i = 0; i < coll.length; i++) {
      coll[i].addEventListener("click", function() {
        this.classList.toggle("active");
        var content = this.nextElementSibling;
        if (content.style.display === "block") {
          content.style.display = "none";
          this.childNodes[0].innerText = "►"
        } else {
          content.style.display = "block";
          this.children[0].innerText = "▼"
        }
      });
    }
}</script>
 
\endhtmlonly
 
*/