chi__KBAGraphPartitioner.h

Go to the documentation of this file.

/** \defgroup chi__KBAGraphPartitioner chi.KBAGraphPartitioner
 
 
\ingroup Graphs
Koch, Baker and Alcouffe based partitioning. This is an overlayed ortho-grid based partitioner
 
 
## Example usage:
Create this object:
\code
params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
chi.KBAGraphPartitioner.Create(params)
\endcode
## 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>nx</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe number of partitions in x</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The number of partitions in x
</p>
  <p>Default value: <TT style="color:grey">1</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>ny</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe number of partitions in y</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The number of partitions in y
</p>
  <p>Default value: <TT style="color:grey">1</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>nz</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe number of partitions in z</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The number of partitions in z
</p>
  <p>Default value: <TT style="color:grey">1</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>xcuts</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspLocation of the internal x-cuts</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. Location of the internal x-cuts. Require nx-1 entries
</p>
  <p>Default value: <TT style="color:grey"></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>ycuts</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspLocation of the internal y-cuts</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. Location of the internal y-cuts. Require ny-1 entries
</p>
  <p>Default value: <TT style="color:grey"></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>zcuts</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspLocation of the internal z-cuts</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. Location of the internal z-cuts. Require nz-1 entries
</p>
  <p>Default value: <TT style="color:grey"></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
 
### Usage Examples:
\ref test_framework_chi_mesh_MeshGenerators_meshgen_extruder_KBA_lua  
\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua  
\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua  
\ref test_modules_Diffusion_Diffusion1D_KBA_lua  
\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua  
*/