chi_mesh__RPPLogicalVolume.h

Go to the documentation of this file.

/** \defgroup chi_mesh__RPPLogicalVolume chi_mesh.RPPLogicalVolume
 
 
\ingroup LuaLogicVolumes
 
 
 
## Example usage:
Create this object:
\code
params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
chi_mesh.RPPLogicalVolume.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>infx</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag, when true, will ignore xmin and xmax</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag, when true, will ignore xmin and xmax.
</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>infy</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag, when true, will ignore ymin and ymax</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag, when true, will ignore ymin and ymax.
</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>infz</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag, when true, will ignore zmin and zmax</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag, when true, will ignore zmin and zmax.
</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>xmax</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspX-max of the volume</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. X-max of the volume
</p>
  <p>Default value: <TT style="color:grey">1(double)</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>xmin</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspX-min of the volume</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. X-min of the volume
</p>
  <p>Default value: <TT style="color:grey">0(double)</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>ymax</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspY-max of the volume</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Y-max of the volume
</p>
  <p>Default value: <TT style="color:grey">1(double)</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>ymin</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspY-min of the volume</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Y-min of the volume
</p>
  <p>Default value: <TT style="color:grey">0(double)</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>zmax</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspZ-max of the volume</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Z-max of the volume
</p>
  <p>Default value: <TT style="color:grey">1(double)</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>zmin</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspZ-min of the volume</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Z-min of the volume
</p>
  <p>Default value: <TT style="color:grey">0(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
 
### Usage Examples:
\ref test_framework_chi_mesh_LogicalVolume_lv_rpp_test1_lua  
\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua  
\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua  
\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua  
\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua  
\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua  
\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua  
\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua  
\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua  
\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua  
\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua  
\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua  
\ref test_modules_Diffusion_Diffusion1D_IP_lua  
\ref test_modules_Diffusion_Diffusion1D_lua  
\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua  
\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua  
\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua  
\ref test_modules_Diffusion_Diffusion3D_1Poly_lua  
\ref test_modules_Diffusion_Diffusion2D_1Poly_lua  
\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua  
\ref test_modules_Diffusion_Diffusion3D_4VTU_lua  
\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua  
\ref test_modules_Diffusion_Diffusion1D_KBA_lua  
\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua  
\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua  
\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_mesh_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_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_Transport2D_4a_DSA_ortho_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_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_Transport1D_1_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_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_Transport3D_1b_Ortho_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua  
\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_mesh_lua  
\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua  
\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua  
*/