https://mooseframework.inl.gov
ConstantRate.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 "ConstantRate.h"
11 
13 
16 {
18  params.addClassDescription("Computes residual or the rate in a simple ODE of du/dt = rate.");
19  params.addRequiredParam<Real>("rate", "The constant rate in 'du/dt = rate'");
20  params.declareControllable("rate");
21  return params;
22 }
23 
25  : NodalKernel(parameters), _rate(getParam<Real>("rate"))
26 {
27 }
28 
29 Real
31 {
32  return -_rate;
33 }
34 
35 Real
37 {
38  return 0;
39 }
virtual Real computeQpResidual() override
The user can override this function to compute the residual at a node.
Definition: ConstantRate.C:30
registerMooseObject("MooseApp", ConstantRate)
static InputParameters validParams()
Constructor initializes the rate.
Definition: ConstantRate.C:15
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...
virtual Real computeQpJacobian() override
The user can override this function to compute the "on-diagonal" Jacobian contribution.
Definition: ConstantRate.C:36
ConstantRate(const InputParameters &parameters)
Definition: ConstantRate.C:24
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const Real & _rate
The rate.
Definition: ConstantRate.h:33
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...
Represents the rate in a simple ODE of du/dt = rate.
Definition: ConstantRate.h:17
static InputParameters validParams()
Class constructor.
Definition: NodalKernel.C:18
Base class for creating nodal kernels with hand-coded Jacobians.
Definition: NodalKernel.h:17
void declareControllable(const std::string &name, std::set< ExecFlagType > execute_flags={})
Declare the given parameters as controllable.