lbs__BoundaryOptionsBlock.h

Go to the documentation of this file.

/** \defgroup lbs__BoundaryOptionsBlock lbs.BoundaryOptionsBlock
 
 
\ingroup LBSUtilities
Set options for boundary conditions. See \ref LBSBCs
 
<B>Note:</B> This object is not constructable
## 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 &nbspBoundary name that identifies the specific boundary</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Boundary name that identifies the specific boundary
</p>
  <p>Allowable values: <TT>"xmin", "xmax", "ymin", "ymax", "zmin", "zmax"</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>type</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspBoundary type specification</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Boundary type specification.
</p>
  <p>Allowable values: <TT>"vacuum", "incident_isotropic", "reflecting", "incident_anisotropic_heterogeneous"</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>function_name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspText name of the lua function to be called for this boundary condition</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Text name of the lua function to be called for this boundary condition. For more on this boundary condition type.
</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>group_strength</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspRequired only if `type` is `"incident_isotropic"`</span></button>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. Required only if `type` is `"incident_isotropic"`. An array of isotropic strength per group
</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
 
*/