https://mooseframework.inl.gov
FVReaction.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 "FVReaction.h"
11 
13 
16 {
18  params.addClassDescription("Simple consuming reaction term");
19  params.addParam<Real>("rate", 1.0, "Relative amount consumed per unit time.");
20  return params;
21 }
22 
24  : FVElementalKernel(parameters), _rate(getParam<Real>("rate"))
25 {
26 }
27 
28 ADReal
30 {
31  return _rate * _u[_qp];
32 }
ADReal computeQpResidual() override
This is the primary function that must be implemented for flux kernel terms.
Definition: FVReaction.C:29
const Real & _rate
Definition: FVReaction.h:23
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
DualNumber< Real, DNDerivativeType, true > ADReal
Definition: ADRealForward.h:47
FVElemental is used for calculating residual contributions from volume integral terms of a PDE where ...
static InputParameters validParams()
Definition: FVReaction.C:15
static InputParameters validParams()
const ADVariableValue & _u
registerADMooseObject("MooseApp", FVReaction)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const unsigned int _qp
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...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object...
FVReaction(const InputParameters &parameters)
Definition: FVReaction.C:23