www.mooseframework.org
EigenKernel.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 "Kernel.h"
13 
14 class MooseEigenSystem;
15 
23 class EigenKernel : public Kernel
24 {
25 public:
27 
28  virtual void computeResidual() override;
29  virtual void computeJacobian() override;
30  virtual void computeOffDiagJacobian(unsigned int jvar) override;
31  virtual void computeOffDiagJacobianScalar(unsigned int /*jvar*/) override {}
32 
34  virtual bool enabled() const override;
35 
36 protected:
38  bool _eigen;
39 
42 
47  const Real * _eigenvalue;
48 };
MooseEigenSystem * _eigen_sys
EigenKernel always lives in EigenSystem.
Definition: EigenKernel.h:41
const Real * _eigenvalue
A pointer to the eigenvalue that is stored in a postprocessor This is a pointer so that the method fo...
Definition: EigenKernel.h:47
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
Definition: EigenKernel.C:23
virtual void computeResidual() override
Compute this Kernel's contribution to the residual.
Definition: EigenKernel.C:80
virtual bool enabled() const override
Return the enabled status of the object.
Definition: EigenKernel.C:183
The behavior of this kernel is controlled by one problem-wise global parameter eigen_on_current - boo...
Definition: EigenKernel.h:23
virtual void computeOffDiagJacobian(unsigned int jvar) override
Computes d-residual / d-jvar... storing the result in Ke.
Definition: EigenKernel.C:129
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Definition: Kernel.h:15
const InputParameters & parameters() const
Get the parameters of the object.
virtual void computeJacobian() override
Compute this Kernel's contribution to the diagonal Jacobian entries.
Definition: EigenKernel.C:102
virtual void computeOffDiagJacobianScalar(unsigned int) override
Computes jacobian block with respect to a scalar variable.
Definition: EigenKernel.h:31
EigenKernel(const InputParameters &parameters)
Definition: EigenKernel.C:34
bool _eigen
flag for as an eigen kernel or a normal kernel
Definition: EigenKernel.h:38