https://mooseframework.inl.gov
Loading...
Searching...
No Matches
MFEMAuxKernel.C
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#include "MFEMAuxKernel.h"
13#include "MFEMProblem.h"
14
17{
19 params.registerBase("AuxKernel");
20 params.addClassDescription("Base class for MFEM objects that update auxiliary variables outside "
21 "of the main solve step.");
22 params.addRequiredParam<AuxVariableName>("variable",
23 "The name of the variable that this object applies to");
24 return params;
25}
26
28 : MFEMExecutedObject(parameters),
29 _result_var_name(getParam<AuxVariableName>("variable")),
30 _result_var(*getMFEMProblem().getGridFunction(_result_var_name))
31{
32}
33
34std::optional<std::string>
39
40#endif
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
void registerBase(const std::string &value)
This method must be called from every base "Moose System" to create linkage with the Action System.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump.
MFEMAuxKernel(const InputParameters &parameters)
virtual std::optional< std::string > suppliedVariableName() const override
Return the variable name supplied by this object, or std::nullopt if none.
static InputParameters validParams()
const AuxVariableName _result_var_name
Name of auxvariable to store the result of the auxkernel in.
Base class for MFEM objects that participate in execution ordering but are not UserObjects.
static InputParameters validParams()
Declare the common parameters used by MFEM executed objects.