https://mooseframework.inl.gov
Loading...
Searching...
No Matches
ConstantScalarAux.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 "ConstantScalarAux.h"
11
13
16{
18 params.addClassDescription("Sets an auxiliary field variable to a controllable constant value.");
19 params.addRequiredParam<Real>("value", "The value to be set to the scalar variable.");
20 params.declareControllable("value");
21 return params;
22}
23
25 : AuxScalarKernel(parameters), _value(getParam<Real>("value"))
26{
27}
28
29Real
registerMooseObject("MooseApp", ConstantScalarAux)
Base class for making kernels that work on auxiliary scalar variables.
static InputParameters validParams()
Sets a constant value on a scalar variable.
virtual Real computeValue() override
Compute the value of this kernel.
static InputParameters validParams()
ConstantScalarAux(const InputParameters &parameters)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void declareControllable(const std::string &name, std::set< ExecFlagType > execute_flags={})
Declare the given parameters as controllable.
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.