lbs__SteadyStateSolver.h

Go to the documentation of this file.

/** \defgroup lbs__SteadyStateSolver lbs.SteadyStateSolver
 
 
\ingroup LBSExecutors
Generalized implementation of a steady state solver. This solver calls the Across-Groupset (AGS) solver for the lbs-data block.
 
 
## Example usage:
Create this object:
\code
params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
lbs.SteadyStateSolver.Create(params)
\endcode
## Required 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>lbs_solver_handle</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to an existing lbs solver</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Handle to an existing lbs solver
</p>
</div>
 
</div>
\endhtmlonly
 
## 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>dt</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspDesired initial timestep size</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Desired initial timestep size.
</p>
  <p>Default value: <TT style="color:grey">0.01(double)</TT></p>
  <p>Allowable values: <TT>>= 1e-12(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>end_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTransient end-time if applicable</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Transient end-time if applicable.
</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>max_time_steps</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspMaximum number of timesteps to allow</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Maximum number of timesteps to allow. Negative values disables this.
</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>name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA text name to associate with the solver</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. A text name to associate with the solver. This name will be used in status messages and verbose iterative convergence monitors.
</p>
  <p>Default value: <TT style="color:grey">"SteadyStateSolver"</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>start_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTransient start-time if applicable</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Transient start-time if applicable.
</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>time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspCurrent time of the solver</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Current time of the solver.
</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>timestepper</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to a timestepper</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Handle to a timestepper. If not supplied then a ConstantTimeStepper will be created.
</p>
  <p>Default value: <TT style="color:grey">0</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_tutorials_tutorial_93_raytracing_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_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_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_6ASplitMesh_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_Transport3D_6BSplitMesh_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_Transport1D_4_DSA_ortho_inf_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_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua  
\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua  
*/