https://mooseframework.inl.gov
CoupledForceNodalKernel.h
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 #pragma once
11 
12 #include "NodalKernel.h"
13 
18 {
19 public:
21 
23 
24 protected:
25  virtual Real computeQpResidual() override;
26  virtual Real computeQpJacobian() override;
27  virtual Real computeQpOffDiagJacobian(unsigned int jvar) override;
28 
29 private:
31  const unsigned int _v_var;
32 
34  const VariableValue & _v;
35 
37  const Real _coef;
38 };
const unsigned int _v_var
The number of the coupled variable.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Adds a force proportional to the value of the coupled variable.
virtual Real computeQpJacobian() override
The user can override this function to compute the "on-diagonal" Jacobian contribution.
OutputTools< Real >::VariableValue VariableValue
Definition: MooseTypes.h:314
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual Real computeQpResidual() override
The user can override this function to compute the residual at a node.
virtual Real computeQpOffDiagJacobian(unsigned int jvar) override
This is the virtual that derived classes should override for computing an off-diagonal jacobian compo...
const VariableValue & _v
The value of the coupled variable.
const InputParameters & parameters() const
Get the parameters of the object.
CoupledForceNodalKernel(const InputParameters &parameters)
static InputParameters validParams()
Base class for creating nodal kernels with hand-coded Jacobians.
Definition: NodalKernel.h:17
const Real _coef
A multiplicative factor for computing the coupled force.