https://mooseframework.inl.gov
Loading...
Searching...
No Matches
IntegratedBC.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 "IntegratedBCBase.h"
14
19{
20public:
22
24
25 virtual const MooseVariable & variable() const override { return _var; }
26
27 virtual void computeResidual() override;
28 virtual void computeJacobian() override;
32 virtual void computeOffDiagJacobian(unsigned int jvar) override;
37 void computeOffDiagJacobianScalar(unsigned int jvar) override;
38 virtual void computeResidualAndJacobian() override;
39
40protected:
44 virtual Real computeQpResidual() = 0;
45
49 virtual Real computeQpJacobian() { return 0; }
50
54 virtual Real computeQpOffDiagJacobian(unsigned int /*jvar*/) { return 0; }
55
59 virtual Real computeQpOffDiagJacobianScalar(unsigned int jvar)
60 {
61 // Backwards compatibility
62 return computeQpOffDiagJacobian(jvar);
63 }
64
68 virtual void precalculateQpResidual() {}
69
74 virtual void precalculateQpJacobian() {}
75
80 virtual void precalculateQpOffDiagJacobian(const MooseVariableFEBase & /*jvar*/) {}
81
83
86
87 // shape functions
88
93
94 // test functions
95
100
101 // unknown
102
107};
OutputTools< Real >::VariablePhiValue VariablePhiValue
Definition MooseTypes.h:353
OutputTools< Real >::VariableTestValue VariableTestValue
Definition MooseTypes.h:358
OutputTools< Real >::VariableGradient VariableGradient
Definition MooseTypes.h:349
OutputTools< Real >::VariableTestGradient VariableTestGradient
Definition MooseTypes.h:359
OutputTools< Real >::VariableValue VariableValue
Definition MooseTypes.h:348
OutputTools< Real >::VariablePhiGradient VariablePhiGradient
Definition MooseTypes.h:354
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Base class for deriving any boundary condition of a integrated type.
Base class for deriving any boundary condition of a integrated type.
const VariableTestGradient & _grad_test
gradients of test functions (in QPs)
void computeOffDiagJacobianScalar(unsigned int jvar) override
Computes jacobian block with respect to a scalar variable.
const VariablePhiGradient & _grad_phi
gradients of shape functions (in QPs)
virtual void precalculateQpOffDiagJacobian(const MooseVariableFEBase &)
Insertion point for evaluations that depend on qp but are independent of the test and shape functions...
virtual Real computeQpOffDiagJacobianScalar(unsigned int jvar)
Method for computing an off-diagonal jacobian component from a scalar var.
MooseVariable & _var
const VariableGradient & _grad_u
the gradient of the unknown variable this BC is acting on
virtual const MooseVariable & variable() const override
Returns the variable that this object operates on.
virtual void computeOffDiagJacobian(unsigned int jvar) override
Computes d-ivar-residual / d-jvar...
virtual void precalculateQpJacobian()
Insertion point for evaluations that depend on qp but are independent of the test and shape functions...
const VariableValue & _u
the values of the unknown variable this BC is acting on
static InputParameters validParams()
virtual void computeResidualAndJacobian() override
Compute this object's contribution to the residual and Jacobian simultaneously.
virtual Real computeQpJacobian()
Method for computing the diagonal Jacobian at quadrature points.
virtual Real computeQpOffDiagJacobian(unsigned int)
Method for computing an off-diagonal jacobian component at quadrature points.
virtual Real computeQpResidual()=0
Method for computing the residual at quadrature points.
virtual void computeJacobian() override
Compute this object's contribution to the diagonal Jacobian entries.
virtual void precalculateQpResidual()
Insertion point for evaluations that depend on qp but are independent of the test functions.
virtual void computeResidual() override
Compute this object's contribution to the residual.
const VariablePhiValue & _phi
shape function values (in QPs)
const MooseArray< Point > & _normals
normals at quadrature points
const VariableTestValue & _test
test function values (in QPs)
forward declarations
Definition MooseArray.h:18
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
This class provides an interface for common operations on field variables of both FE and FV types wit...
Interface for objects that need to get values of MooseVariables.