https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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
13registerMooseObjectRenamed("MooseApp", ConstantBoundsAux, "06/30/2024 24:00", ConstantBounds);
14
17{
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}
registerMooseObjectRenamed("MooseApp", ConstantBoundsAux, "06/30/2024 24:00", ConstantBounds)
registerMooseObject("MooseApp", ConstantBounds)
This is a base class used to set an upper and/or lower bound of a variable for the PETSc's variationa...
Definition BoundsBase.h:18
static InputParameters validParams()
Definition BoundsBase.C:16
Provides constant bound of a variable for the PETSc's variational inequalities solver.
ConstantBounds(const InputParameters &parameters)
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
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...
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.