IC::PSRead
==========

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

Fill a domain (region where field=0) with packed spheres (regions where field=1).
Sphere locations and radii are determined from an xyzr file.

.. raw:: html

   <div class="input-reference-list">
     <article class="input-reference-item" id="input-eps-5df7a45a92">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PSRead_8H_source.html#l00137"><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 sphere boundary</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 9 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.psread.eps</code>
               <code>pf.eta.ic.psread.eps</code>
               <code>phi.ic.psread.eps</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.psread.eps</code>
               <code>pf.eta.ic.psread.eps</code>
               <code>phi.ic.psread.eps</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.psread.eps</code>
               <code>flame.pf.eta.ic.psread.eps</code>
               <code>flame.phi.ic.psread.eps</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-file-name-88f4638ae0">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PSRead_8H_source.html#l00141"><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 .xyzr file</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 9 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.psread.file.name</code>
               <code>pf.eta.ic.psread.file.name</code>
               <code>phi.ic.psread.file.name</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.psread.file.name</code>
               <code>pf.eta.ic.psread.file.name</code>
               <code>phi.ic.psread.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.psread.file.name</code>
               <code>flame.pf.eta.ic.psread.file.name</code>
               <code>flame.phi.ic.psread.file.name</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-verbose-013e131a4b">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PSRead_8H_source.html#l00144"><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, 9 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.psread.verbose</code>
               <code>pf.eta.ic.psread.verbose</code>
               <code>phi.ic.psread.verbose</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.psread.verbose</code>
               <code>pf.eta.ic.psread.verbose</code>
               <code>phi.ic.psread.verbose</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.psread.verbose</code>
               <code>flame.pf.eta.ic.psread.verbose</code>
               <code>flame.phi.ic.psread.verbose</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-mult-8fdfac4571">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PSRead_8H_source.html#l00147"><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</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 9 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.psread.mult</code>
               <code>pf.eta.ic.psread.mult</code>
               <code>phi.ic.psread.mult</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.psread.mult</code>
               <code>pf.eta.ic.psread.mult</code>
               <code>phi.ic.psread.mult</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.psread.mult</code>
               <code>flame.pf.eta.ic.psread.mult</code>
               <code>flame.phi.ic.psread.mult</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-invert-81e65708a8">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PSRead_8H_source.html#l00150"><code>invert</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 (1 outside instead of inside spheres)</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 9 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.psread.invert</code>
               <code>pf.eta.ic.psread.invert</code>
               <code>phi.ic.psread.invert</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.psread.invert</code>
               <code>pf.eta.ic.psread.invert</code>
               <code>phi.ic.psread.invert</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.psread.invert</code>
               <code>flame.pf.eta.ic.psread.invert</code>
               <code>flame.phi.ic.psread.invert</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-x0-5d95d3480e">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PSRead_8H_source.html#l00153"><code>x0</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">0 0 0</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">X-offset</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>3 executables, 9 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.psread.x0</code>
               <code>pf.eta.ic.psread.x0</code>
               <code>phi.ic.psread.x0</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.psread.x0</code>
               <code>pf.eta.ic.psread.x0</code>
               <code>phi.ic.psread.x0</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.psread.x0</code>
               <code>flame.pf.eta.ic.psread.x0</code>
               <code>flame.phi.ic.psread.x0</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-file-unit-1a12349519">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/PSRead_8H_source.html#l00160"><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, 9 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.psread.file.unit</code>
               <code>pf.eta.ic.psread.file.unit</code>
               <code>phi.ic.psread.file.unit</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.psread.file.unit</code>
               <code>pf.eta.ic.psread.file.unit</code>
               <code>phi.ic.psread.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.psread.file.unit</code>
               <code>flame.pf.eta.ic.psread.file.unit</code>
               <code>flame.phi.ic.psread.file.unit</code>
             </div>
           </div>
         </div>
       </details>
     </article>
   </div>