IC::PointList
=============

:bdg-link-secondary-line:`src/IC/PointList.H <../../doxygen/PointList_8H_source.html>`

Fill a domain based on a list of points to form one or more closed 2D shapes.
The distance from each point to the nearest edge is found and an error function is then used to compute
the value of phi between 0 (outside) and 1 (inside) the domain. Only works in 2 dimensions.
Points belonging to different polygons are distinguished using the ObjNum column of the input file:
whenever ObjNum changes by more than obj_num_threshold between consecutive lines, a new polygon begins.
Each polygon's field is computed into phi_temp. Polygons are then combined into either the "solid" field
(pointwise max over all non-void polygons) or the "void" field (pointwise max over all void polygons,
as selected by the per-polygon invert list). The void field is inverted (zero inside, one outside the
void polygons) and multiplied into the solid field, punching holes wherever a void polygon overlaps it.
invert_all is then applied once at the end to flip the whole finished field if desired.

.. raw:: html

   <div class="input-reference-list">
     <article class="input-reference-item" id="input-eps-dbe37d3210">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00246"><code>eps</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0.0</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Diffuseness of the solid boundary</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.eps</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.eps</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.eps</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-file-name-4c6b606752">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00250"><code>file.name</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-meta">file path</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Location of .xy file</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.file.name</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.file.name</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.file.name</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-verbose-754537094c">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00253"><code>verbose</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Verbosity (used in parser only)</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.verbose</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.verbose</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.verbose</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-mult-ff860ff2ac">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00256"><code>mult</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">1.0</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Unitless coordinate multiplier, applied after the rotation</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.mult</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.mult</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.mult</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-invert-all-5cd647204e">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00259"><code>invert_all</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0</span> <span class="input-reference-badge input-reference-badge-option">1</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Whether to invert the finished field as a whole (make IC 1 outside of solid instead of inside solid)</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.invert_all</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.invert_all</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.invert_all</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-x0-e1e55a9834">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00262"><code>x0</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0.0 0.0 0.0</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">X-offsed, applied after the rotation</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.x0</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.x0</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.x0</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-rotation-center-3810569a2f">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00265"><code>rotation.center</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0.0 0.0 0.0</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Center of rigid-body rotation</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.rotation.center</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.rotation.center</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.rotation.center</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-rotation-angle-9a50ad045d">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00268"><code>rotation.angle</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0.0</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Amount of rotation about rotation center (clockwise)</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.rotation.angle</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.rotation.angle</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.rotation.angle</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-obj-num-threshold-5eceb0fb75">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00271"><code>obj_num_threshold</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0.5</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">ObjNum jump (between consecutive points in the file) larger than this starts a new polygon</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.obj_num_threshold</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.obj_num_threshold</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.obj_num_threshold</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-file-unit-b21a849e27">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00276"><code>file.unit</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Units of length in the file</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.file.unit</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.file.unit</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.file.unit</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-invert-8bc406a864">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PointList_8H_source.html#l00280"><code>invert</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Per-polygon void flag: nonzero marks a polygon as a void/negative region that is cut out of the solid field instead of being unioned into it. Must have one entry per polygon if given.</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 3 uses</span></summary>
         <div class="input-reference-resolved-body">
           <div class="input-reference-executable">
             <strong>alamo-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.invert</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.pointlist.invert</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.pointlist.invert</code>
             </div>
           </div>
         </div>
       </details>
     </article>
   </div>