chi_physics__ConstantTimeStepper.h

Go to the documentation of this file.

/** \defgroup chi_physics__ConstantTimeStepper chi_physics.ConstantTimeStepper
 
 
\ingroup doc_TimeStepControllers
Timestep controller that does not dynamically change.
 
 
## Example usage:
Create this object:
\code
params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
chi_physics.ConstantTimeStepper.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>dt</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspInitial timestep to use</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Initial timestep to use
</p>
  <p>Default value: <TT style="color:grey">0.01(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>dt_min</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspMinimum allowable timestep</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Minimum allowable timestep.
</p>
  <p>Default value: <TT style="color:grey">1e-05(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 &nbspEnd time</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. End time
</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>eps</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspGeneral time tolerance</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. General time tolerance. This is used in fuzzy equals.
</p>
  <p>Default value: <TT style="color:grey">1e-08(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 take</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 take. A negative number 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>start_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspStart time</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Start time
</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 &nbspInitial time</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Initial time
</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_index</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTime index</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Time index. Useful for output control.
</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
 
*/