Line data    Source code

       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 "HDGKernel.h"
      13             : 
      14             : class ElementAndTraceScalarHDGAssemblyHelper;
      15             : 
      16             : /**
      17             :  * Base kernel for helper-backed HDG discretizations with an element-interior scalar and scalar
      18             :  * facet trace.
      19             :  */
      20             : class ElementAndTraceScalarHDGKernel : public HDGKernel
      21             : {
      22             : public:
      23             :   static InputParameters validParams();
      24             : 
      25             :   ElementAndTraceScalarHDGKernel(const InputParameters & parameters);
      26             : 
      27             :   virtual void computeResidual() override;
      28             :   virtual void computeJacobian() override;
      29             :   virtual void computeOffDiagJacobian(unsigned int jvar) override;
      30             :   virtual void computeResidualAndJacobian() override;
      31             :   virtual void jacobianSetup() override;
      32             :   virtual void computeResidualOnSide() override;
      33             :   virtual void computeJacobianOnSide() override;
      34             :   virtual void computeResidualAndJacobianOnSide() override;
      35             : 
      36             :   virtual std::set<std::string> additionalROVariables() override;
      37             :   virtual const std::unordered_set<unsigned int> & getMatPropDependencies() const override;
      38             :   virtual bool getMaterialPropertyCalled() const override;
      39             : 
      40             : private:
      41             :   /// Returns the helper used for common element-and-trace scalar HDG assembly.
      42             :   virtual ElementAndTraceScalarHDGAssemblyHelper & hdgHelper() = 0;
      43             :   const ElementAndTraceScalarHDGAssemblyHelper & hdgHelper() const;
      44             : 
      45             :   /// Assembles the element-interior residual data.
      46             :   void compute(ElementAndTraceScalarHDGAssemblyHelper & helper);
      47             : 
      48             :   /// Assembles the face residual data.
      49             :   void computeOnSide(ElementAndTraceScalarHDGAssemblyHelper & helper);
      50             : 
      51             :   /// Used to assemble the complete AD Jacobian only once per element.
      52             :   const Elem * _cached_elem;
      53             : };
      54             : 
      55             : inline const ElementAndTraceScalarHDGAssemblyHelper &
      56        1437 : ElementAndTraceScalarHDGKernel::hdgHelper() const
      57             : {
      58        1437 :   return const_cast<ElementAndTraceScalarHDGKernel *>(this)->hdgHelper();
      59             : }