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             : #ifdef MOOSE_MFEM_ENABLED
      11             : 
      12             : #pragma once
      13             : 
      14             : #include "MFEMObject.h"
      15             : #include "MFEMContainers.h"
      16             : #include "MFEMBlockRestrictable.h"
      17             : 
      18             : /**
      19             :  * Class to construct an MFEM integrator to apply to the equation system.
      20             :  */
      21             : class MFEMKernel : public MFEMObject, public MFEMBlockRestrictable
      22             : {
      23             : public:
      24             :   static InputParameters validParams();
      25             : 
      26             :   MFEMKernel(const InputParameters & parameters);
      27             : 
      28        1833 :   virtual ~MFEMKernel() = default;
      29             : 
      30             :   /// Create MFEM integrator to apply to the RHS of the weak form. Ownership managed by the caller.
      31        2290 :   virtual mfem::LinearFormIntegrator * createLFIntegrator() { return nullptr; }
      32             : 
      33             :   /// Create MFEM integrator to apply to the LHS of the weak form. Ownership managed by the caller.
      34         728 :   virtual mfem::BilinearFormIntegrator * createBFIntegrator() { return nullptr; }
      35        2286 :   virtual mfem::NonlinearFormIntegrator * createNLIntegrator() { return nullptr; }
      36             : 
      37             :   /// Get name of the test variable labelling the weak form this kernel is added to
      38        1699 :   const VariableName & getTestVariableName() const { return _test_var_name; }
      39             : 
      40             :   /// Get name of the trial variable (gridfunction) the kernel acts on.
      41             :   /// Defaults to the name of the test variable labelling the weak form.
      42        1591 :   virtual const VariableName & getTrialVariableName() const { return _test_var_name; }
      43             : 
      44             : protected:
      45             :   /// Name of (the test variable associated with) the weak form that the kernel is applied to.
      46             :   const VariableName & _test_var_name;
      47             : };
      48             : 
      49             : #endif