IC::BMP
=======

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

Initialize a field using a bitmap image. (2D only)

Note that in GIMP, you must select "do not write color space information"
and "24 bit R8 G8 B8" when exporting the BMP file.

.. raw:: html

   <div class="input-reference-list">
     <article class="input-reference-item" id="input-filename-eb800dd61e">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/IC_2BMP_8H_source.html#l00190"><code>filename</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">BMP filename.</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>4 executables, 14 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.bmp.filename</code>
               <code>pf.eta.ic.bmp.filename</code>
               <code>phi.ic.bmp.filename</code>
               <code>temp.ic.bmp.filename</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.bmp.filename</code>
               <code>pf.eta.ic.bmp.filename</code>
               <code>phi.ic.bmp.filename</code>
               <code>temp.ic.bmp.filename</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>hydro-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>eta.ic.bmp.filename</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.bmp.filename</code>
               <code>flame.pf.eta.ic.bmp.filename</code>
               <code>flame.phi.ic.bmp.filename</code>
               <code>flame.temp.ic.bmp.filename</code>
               <code>hydro.eta.ic.bmp.filename</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-fit-234f2efaf3">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/IC_2BMP_8H_source.html#l00193"><code>fit</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-option">coord</span> <span class="input-reference-badge input-reference-badge-option">fitheight</span> <span class="input-reference-badge input-reference-badge-option">fitwidth</span> <span class="input-reference-badge input-reference-badge-option">stretch</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">how to position the image</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>4 executables, 14 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.bmp.fit</code>
               <code>pf.eta.ic.bmp.fit</code>
               <code>phi.ic.bmp.fit</code>
               <code>temp.ic.bmp.fit</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.bmp.fit</code>
               <code>pf.eta.ic.bmp.fit</code>
               <code>phi.ic.bmp.fit</code>
               <code>temp.ic.bmp.fit</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>hydro-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>eta.ic.bmp.fit</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.bmp.fit</code>
               <code>flame.pf.eta.ic.bmp.fit</code>
               <code>flame.phi.ic.bmp.fit</code>
               <code>flame.temp.ic.bmp.fit</code>
               <code>hydro.eta.ic.bmp.fit</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-coord-lo-64e24f0e9a">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/IC_2BMP_8H_source.html#l00206"><code>coord.lo</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-required">required</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Lower-left coordinates of image in domain</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>4 executables, 14 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.bmp.coord.lo</code>
               <code>pf.eta.ic.bmp.coord.lo</code>
               <code>phi.ic.bmp.coord.lo</code>
               <code>temp.ic.bmp.coord.lo</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.bmp.coord.lo</code>
               <code>pf.eta.ic.bmp.coord.lo</code>
               <code>phi.ic.bmp.coord.lo</code>
               <code>temp.ic.bmp.coord.lo</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>hydro-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>eta.ic.bmp.coord.lo</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.bmp.coord.lo</code>
               <code>flame.pf.eta.ic.bmp.coord.lo</code>
               <code>flame.phi.ic.bmp.coord.lo</code>
               <code>flame.temp.ic.bmp.coord.lo</code>
               <code>hydro.eta.ic.bmp.coord.lo</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-coord-hi-71b4e65e9b">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/IC_2BMP_8H_source.html#l00208"><code>coord.hi</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-required">required</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Upper-right coordinates of image in domain</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>4 executables, 14 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.bmp.coord.hi</code>
               <code>pf.eta.ic.bmp.coord.hi</code>
               <code>phi.ic.bmp.coord.hi</code>
               <code>temp.ic.bmp.coord.hi</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.bmp.coord.hi</code>
               <code>pf.eta.ic.bmp.coord.hi</code>
               <code>phi.ic.bmp.coord.hi</code>
               <code>temp.ic.bmp.coord.hi</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>hydro-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>eta.ic.bmp.coord.hi</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.bmp.coord.hi</code>
               <code>flame.pf.eta.ic.bmp.coord.hi</code>
               <code>flame.phi.ic.bmp.coord.hi</code>
               <code>flame.temp.ic.bmp.coord.hi</code>
               <code>hydro.eta.ic.bmp.coord.hi</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-channel-db20eb6f99">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/IC_2BMP_8H_source.html#l00214"><code>channel</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-option">B</span> <span class="input-reference-badge input-reference-badge-option">G</span> <span class="input-reference-badge input-reference-badge-option">R</span> <span class="input-reference-badge input-reference-badge-option">b</span> <span class="input-reference-badge input-reference-badge-option">g</span> <span class="input-reference-badge input-reference-badge-option">r</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Color channel to use</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>4 executables, 14 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.bmp.channel</code>
               <code>pf.eta.ic.bmp.channel</code>
               <code>phi.ic.bmp.channel</code>
               <code>temp.ic.bmp.channel</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.bmp.channel</code>
               <code>pf.eta.ic.bmp.channel</code>
               <code>phi.ic.bmp.channel</code>
               <code>temp.ic.bmp.channel</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>hydro-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>eta.ic.bmp.channel</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.bmp.channel</code>
               <code>flame.pf.eta.ic.bmp.channel</code>
               <code>flame.phi.ic.bmp.channel</code>
               <code>flame.temp.ic.bmp.channel</code>
               <code>hydro.eta.ic.bmp.channel</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-min-65e87e3f51">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/IC_2BMP_8H_source.html#l00222"><code>min</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">Scaling value - minimum</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>4 executables, 14 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.bmp.min</code>
               <code>pf.eta.ic.bmp.min</code>
               <code>phi.ic.bmp.min</code>
               <code>temp.ic.bmp.min</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.bmp.min</code>
               <code>pf.eta.ic.bmp.min</code>
               <code>phi.ic.bmp.min</code>
               <code>temp.ic.bmp.min</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>hydro-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>eta.ic.bmp.min</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.bmp.min</code>
               <code>flame.pf.eta.ic.bmp.min</code>
               <code>flame.phi.ic.bmp.min</code>
               <code>flame.temp.ic.bmp.min</code>
               <code>hydro.eta.ic.bmp.min</code>
             </div>
           </div>
         </div>
       </details>
     </article>
     <article class="input-reference-item" id="input-max-2fc29d1a92">
       <header class="input-reference-item-header">
         <a class="input-reference-name" href="../../doxygen/IC_2BMP_8H_source.html#l00223"><code>max</code></a>
         <div class="input-reference-badges"><span class="input-reference-badge input-reference-badge-default">255</span> <span class="input-reference-badge input-reference-badge-meta">conditional</span></div>
       </header>
       <p class="input-reference-description">Scaling value - maximum</p>
       <details class="input-reference-resolved">
         <summary>Names by executable <span>4 executables, 14 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.bmp.max</code>
               <code>pf.eta.ic.bmp.max</code>
               <code>phi.ic.bmp.max</code>
               <code>temp.ic.bmp.max</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>alamo-3d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>alpha.ic.bmp.max</code>
               <code>pf.eta.ic.bmp.max</code>
               <code>phi.ic.bmp.max</code>
               <code>temp.ic.bmp.max</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>hydro-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>eta.ic.bmp.max</code>
             </div>
           </div>
           <div class="input-reference-executable">
             <strong>sfi-2d-coverage-g++</strong>
             <div class="input-reference-paths">
               <code>allencahn.alpha.ic.bmp.max</code>
               <code>flame.pf.eta.ic.bmp.max</code>
               <code>flame.phi.ic.bmp.max</code>
               <code>flame.temp.ic.bmp.max</code>
               <code>hydro.eta.ic.bmp.max</code>
             </div>
           </div>
         </div>
       </details>
     </article>
   </div>