Skip to content
Permalink
Browse files

Merge pull request #12978 from aeslaughter/tutorial-fixups-9638

Tutorial fixups 9638
  • Loading branch information...
milljm committed Feb 27, 2019
2 parents 5445757 + 52eff4b commit 92721de55171920a679bebd7d17058f639093f7c
@@ -758,9 +758,6 @@ footer.page-footer {
margin-right:1ex;
}

.moose-html-syntax-list-item{
font=size:

.moose-syntax-item-description{
padding-left:10px;
font-weight:100;
@@ -22,6 +22,8 @@ InputParameters
validParams<EigenExecutionerBase>()
{
InputParameters params = validParams<Executioner>();
params.addClassDescription("Executioner for Eigen value problems.");

params.addRequiredParam<PostprocessorName>("bx_norm", "To evaluate |Bx| for the eigenvalue");
params.addParam<PostprocessorName>("normalization", "To evaluate |x| for normalization");
params.addParam<Real>("normal_factor", "Normalize x to make |x| equal to this factor");
@@ -16,6 +16,7 @@ InputParameters
validParams<InversePowerMethod>()
{
InputParameters params = validParams<EigenExecutionerBase>();
params.addClassDescription("Inverse power method for Eigen value problems.");
params.addParam<PostprocessorName>(
"xdiff", "", "To evaluate |x-x_previous| for power iterations");
params.addParam<unsigned int>(
@@ -23,6 +23,7 @@ InputParameters
validParams<Steady>()
{
InputParameters params = validParams<Executioner>();
params.addClassDescription("Executioner for steady-state simulations.");
params.addParam<Real>("time", 0.0, "System time");
return params;
}
@@ -43,6 +43,8 @@ InputParameters
validParams<Transient>()
{
InputParameters params = validParams<Executioner>();
params.addClassDescription("Executioner for time varying simulations.");

std::vector<Real> sync_times(1);
sync_times[0] = -std::numeric_limits<Real>::max();

@@ -18,6 +18,8 @@ validParams<AnalyticalIndicator>()
{
InputParameters params = validParams<ElementIntegralIndicator>();
params.addRequiredParam<FunctionName>("function", "The analytic solution to compare against");
params.addClassDescription(
"Compute the difference between an unknown variable and an analytical solution.");
return params;
}

@@ -16,6 +16,7 @@ InputParameters
validParams<GradientJumpIndicator>()
{
InputParameters params = validParams<InternalSideIndicator>();
params.addClassDescription("Compute the jump of the solution gradient across element bondaries.");
return params;
}

@@ -16,6 +16,8 @@ InputParameters
validParams<LaplacianJumpIndicator>()
{
InputParameters params = validParams<InternalSideIndicator>();
params.addClassDescription(
"Compute the jump of the solution laplacian across element bondaries.");
return params;
}

@@ -16,6 +16,7 @@ InputParameters
validParams<ValueJumpIndicator>()
{
InputParameters params = validParams<InternalSideIndicator>();
params.addClassDescription("Compute the jump of the solution across element bondaries.");
return params;
}

@@ -20,7 +20,8 @@ validParams<CSV>()
{
// Get the parameters from the parent object
InputParameters params = validParams<TableOutput>();

params.addClassDescription("Output for postprocessors, vector postprocessors, and scalar "
"variables using comma seperated values (CSV).");
params.addParam<bool>("sort_columns", false, "Toggle the sorting of columns alphabetically.");

// Options for aligning csv output with whitespace padding
@@ -29,6 +29,7 @@ validParams<Checkpoint>()
{
// Get the parameters from the base classes
InputParameters params = validParams<FileOutput>();
params.addClassDescription("Output for MOOSE recovery checkpoint files.");

// Typical checkpoint options
params.addParam<unsigned int>("num_files", 2, "Number of the restart files to save");
@@ -34,6 +34,8 @@ validParams<Console>()

// Get the parameters from the base class
InputParameters params = validParams<TableOutput>();
params.addClassDescription("Object for screen output.");

params += TableOutput::enableOutputTypes("system_information scalar postprocessor input");

// Screen and file output toggles
@@ -22,6 +22,9 @@ validParams<ControlOutput>()
{
// Get the base class parameters
InputParameters params = validParams<Output>();
params.addClassDescription(
"Output for displaying objects and parameters associated with the Control system.");

params.set<ExecFlagEnum>("execute_on", true) = {EXEC_INITIAL, EXEC_TIMESTEP_BEGIN};
params.addParam<bool>(
"clear_after_output", true, "Clear the active control display after each output.");
@@ -31,6 +31,7 @@ validParams<DOFMapOutput>()
{
// Get the parameters from the base class
InputParameters params = validParams<FileOutput>();
params.addClassDescription("Output degree-of-freedom (DOF) map.");

// Screen and file output toggles
params.addParam<bool>("output_screen", false, "Output to the screen");
@@ -18,6 +18,7 @@ validParams<Gnuplot>()
{
// Get the parameters from the parent object
InputParameters params = validParams<TableOutput>();
params.addClassDescription("Output for postprocessors and scalar variables in GNU plot format.");

// Set an enum for the possible file extensions
MooseEnum ext("png ps gif", "png", true);
@@ -24,6 +24,7 @@ InputParameters
validParams<MaterialPropertyDebugOutput>()
{
InputParameters params = validParams<Output>();
params.addClassDescription("Debug output object for displaying material property information.");

// This object only outputs data once, in the constructor, so disable fine control
params.suppressParameter<ExecFlagEnum>("execute_on");
@@ -22,6 +22,7 @@ validParams<SolutionHistory>()
{
// Get the parameters from the parent object
InputParameters params = validParams<FileOutput>();
params.addClassDescription("Output for the nonlinear solution history.");

// Return the parameters
return params;
@@ -27,6 +27,7 @@ InputParameters
validParams<TopResidualDebugOutput>()
{
InputParameters params = validParams<PetscOutput>();
params.addClassDescription("Debug output object for displaying the top contributing residuals.");

// Create parameters for allowing debug outputter to be defined within the [Outputs] block
params.addParam<unsigned int>(
@@ -19,6 +19,7 @@ InputParameters
validParams<VTKOutput>()
{
InputParameters params = validParams<OversampleOutput>();
params.addClassDescription("Output data using the Visualization Toolkit (VTK).");

// Set default padding to 3
params.set<unsigned int>("padding") = 3;
@@ -568,7 +568,7 @@ def createHTML(self, parent, token, page):
p = html.Tag(parent, 'p', class_='moose-syntax-list-item')
html.Tag(p, 'span', string=u'{}: '.format(token['syntax']),
class_='moose-syntax-list-item-syntax')
return html.Tag(p, 'span', string=unicode(token['syntax']),
return html.Tag(p, 'span',
class_='moose-syntax-list-item-details')

def createMaterialize(self, parent, token, page):
@@ -1,4 +1,4 @@
<!DOCTYPE html><head><link href="../contrib/katex/katex.min.css" rel="stylesheet" type="text/css"></link><link href="../css/katex_moose.css" rel="stylesheet" type="text/css"></link><script src="../contrib/katex/katex.min.js" type="text/javascript"></script></head><body><h1 id="application-syntax-extension">Application Syntax Extension</h1><p>Sets the value of a 'Real' input parameters to the value of a provided function.</p><h2 id="input-parameters">Input Parameters</h2><h2 id="input-parameters">Input Parameters</h2><h2 id="available-objects-actions-and-subsystems">Available Objects, Actions, and Subsystems</h2><div class="moose-syntax-list"><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">: </span><span class="moose-syntax-list-item-details"></span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">AddControlAction: </span><span class="moose-syntax-list-item-details">AddControlAction</span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">RealFunctionControl: </span><span class="moose-syntax-list-item-details">RealFunctionControlSets the value of a 'Real' input parameters to the value of a provided function.</span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">TimePeriod: </span><span class="moose-syntax-list-item-details">TimePeriodControl the enabled/disabled state of objects with time.</span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">: </span><span class="moose-syntax-list-item-details"></span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">TestControl: </span><span class="moose-syntax-list-item-details">TestControl</span></p></div><h2 id="input-files">Input Files</h2><ul class="moose-list-inputs"><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">test/tests/controls/real_function_control/real_function_control.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">modules/stochastic_tools/test/tests/transfers/sampler_transfer/errors/sub_wrong_control.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">test/tests/controls/real_function_control/multi_real_function_control.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">test/tests/controls/dependency/test.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">modules/stochastic_tools/test/tests/transfers/errors/sub_wrong_control.i</a></li></ul>test/tests/controls/real_function_control/real_function_control.i<pre class="moose-pre"><code class="language-text">[Mesh]
<!DOCTYPE html><head><link href="../contrib/katex/katex.min.css" rel="stylesheet" type="text/css"></link><link href="../css/katex_moose.css" rel="stylesheet" type="text/css"></link><script src="../contrib/katex/katex.min.js" type="text/javascript"></script></head><body><h1 id="application-syntax-extension">Application Syntax Extension</h1><p>Sets the value of a 'Real' input parameters to the value of a provided function.</p><h2 id="input-parameters">Input Parameters</h2><h2 id="input-parameters">Input Parameters</h2><h2 id="available-objects-actions-and-subsystems">Available Objects, Actions, and Subsystems</h2><div class="moose-syntax-list"><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">: </span><span class="moose-syntax-list-item-details"></span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">AddControlAction: </span><span class="moose-syntax-list-item-details"></span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">RealFunctionControl: </span><span class="moose-syntax-list-item-details">Sets the value of a 'Real' input parameters to the value of a provided function.</span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">TimePeriod: </span><span class="moose-syntax-list-item-details">Control the enabled/disabled state of objects with time.</span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">: </span><span class="moose-syntax-list-item-details"></span></p><p class="moose-syntax-list-item"><span class="moose-syntax-list-item-syntax">TestControl: </span><span class="moose-syntax-list-item-details"></span></p></div><h2 id="input-files">Input Files</h2><ul class="moose-list-inputs"><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">test/tests/controls/real_function_control/real_function_control.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">modules/stochastic_tools/test/tests/transfers/sampler_transfer/errors/sub_wrong_control.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">test/tests/controls/real_function_control/multi_real_function_control.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">test/tests/controls/dependency/test.i</a></li><li><a class="modal-trigger" href="#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX">modules/stochastic_tools/test/tests/transfers/errors/sub_wrong_control.i</a></li></ul>test/tests/controls/real_function_control/real_function_control.i<pre class="moose-pre"><code class="language-text">[Mesh]
type = GeneratedMesh
dim = 2
nx = 10

0 comments on commit 92721de

Please sign in to comment.
You can’t perform that action at this time.