chi_physics__FieldFunctionGridBased.h

Go to the documentation of this file.

/** \defgroup chi_physics__FieldFunctionGridBased chi_physics.FieldFunctionGridBased
 
 
\ingroup DocFieldFunction
 
 
 
## Example usage:
Create this object:
\code
params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
chi_physics.FieldFunctionGridBased.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>name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspNamed to be associated with this field function</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Named to be associated with this field function
</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>sdm_type</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe spatial discretization type to be used</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The spatial discretization type to be used
</p>
  <p>Allowable values: <TT>"FV", "PWLC", "PWLD", "LagrangeC", "LagrangeD"</TT></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>coordinate_system</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspCoordinate system to apply to element mappings</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Coordinate system to apply to element mappings
</p>
  <p>Default value: <TT style="color:grey">"cartesian"</TT></p>
  <p>Allowable values: <TT>"cartesian", "cylindrical", "spherical"</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>initial_value</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe initial value to assign to the field function</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. The initial value to assign to the field function
</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>num_components</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe number of components to attach to the variable</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The number of components to attach to the variable. Only effective when "type" is VectorN.
</p>
  <p>Default value: <TT style="color:grey">1</TT></p>
  <p>Allowable values: <TT>>= 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>quadrature_order</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspIf supplied, will overwrite the default for the specific discretization-coordinate system combination</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. If supplied, will overwrite the default for the specific discretization-coordinate system combination.
</p>
  <p>Default value: <TT style="color:grey">0</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>unknown_type</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe type of the variable for this field function</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The type of the variable for this field function
</p>
  <p>Default value: <TT style="color:grey">"Scalar"</TT></p>
  <p>Allowable values: <TT>"Scalar", "Vector2", "Vector3", "VectorN"</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
 
*/