https://mooseframework.inl.gov
MFEMAuxKernel.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 #ifdef MOOSE_MFEM_ENABLED
11 
12 #pragma once
13 
14 #include "MFEMExecutedObject.h"
15 #include "MFEMContainers.h"
16 
21 {
22 public:
24 
26  virtual ~MFEMAuxKernel() = default;
27 
29  virtual void update() {}
30 
31  virtual std::optional<std::string> suppliedVariableName() const override;
32 
33 protected:
35  const AuxVariableName _result_var_name;
36 
38  mfem::ParGridFunction & _result_var;
39 
41  long _sequence{0};
42 };
43 
44 #endif
Base class for MFEM objects that participate in execution ordering but are not UserObjects.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseBase.h:131
const AuxVariableName _result_var_name
Name of auxvariable to store the result of the auxkernel in.
Definition: MFEMAuxKernel.h:35
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
long _sequence
Counter to keep track of FE space updates.
Definition: MFEMAuxKernel.h:41
mfem::ParGridFunction & _result_var
Reference to result gridfunction.
Definition: MFEMAuxKernel.h:38
Class to construct an auxiliary solver used to update a real auxvariable.
Definition: MFEMAuxKernel.h:20
virtual ~MFEMAuxKernel()=default
static InputParameters validParams()
Definition: MFEMAuxKernel.C:16
MFEMAuxKernel(const InputParameters &parameters)
Definition: MFEMAuxKernel.C:27
virtual std::optional< std::string > suppliedVariableName() const override
Return the variable name supplied by this object, or std::nullopt if none.
Definition: MFEMAuxKernel.C:35
virtual void update()
Method called to update any owned objects upon an FE space update.
Definition: MFEMAuxKernel.h:29