https://mooseframework.inl.gov
ConstantBounds.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "ConstantBounds.h"
11 
13 registerMooseObjectRenamed("MooseApp", ConstantBoundsAux, "06/30/2024 24:00", ConstantBounds);
14 
17 {
19  params.addClassDescription(
20  "Provides constant bound of a variable for the PETSc's variational inequalities solver");
21  params.addRequiredParam<Real>("bound_value", "The value of bound for the variable");
22  return params;
23 }
24 
26  : BoundsBase(parameters), _bound_value(getParam<Real>("bound_value"))
27 {
28 }
Provides constant bound of a variable for the PETSc&#39;s variational inequalities solver.
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
registerMooseObject("MooseApp", ConstantBounds)
ConstantBounds(const InputParameters &parameters)
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
static InputParameters validParams()
Definition: BoundsBase.C:16
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
registerMooseObjectRenamed("MooseApp", ConstantBoundsAux, "06/30/2024 24:00", ConstantBounds)
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
This is a base class used to set an upper and/or lower bound of a variable for the PETSc&#39;s variationa...
Definition: BoundsBase.h:17