https://mooseframework.inl.gov
Loading...
Searching...
No Matches
UserForcingFunctorNodalKernel.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
11#include "MooseFunctor.h"
12
14
17{
20 "Residual contribution to an ODE from a source functor acting at nodes.");
21 params.addRequiredParam<MooseFunctorName>("functor", "The forcing functor");
22 return params;
23}
24
26 : ADNodalKernel(parameters), _functor(getFunctor<ADReal>("functor"))
27{
28}
29
DualNumber< Real, DNDerivativeType, true > ADReal
registerMooseObject("MooseApp", UserForcingFunctorNodalKernel)
Base class for creating nodal kernels with AD-computed Jacobians.
static InputParameters validParams()
Class constructor.
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.
Moose::NodeArg nodeArg() const
Moose::StateArg determineState() const
Create a functor state argument that corresponds to the implicit state of this object.
Represents the rate in a simple ODE of du/dt = f.
virtual ADReal computeQpResidual() override
The user can override this function to compute the residual at a node.
static InputParameters validParams()
Constructor grabs the Function.
UserForcingFunctorNodalKernel(const InputParameters &parameters)
const Moose::Functor< ADReal > & _functor