doxygen/moose/MFEMAuxKernel_8h_source.html

//* This file is part of the MOOSE framework

//* https://mooseframework.inl.gov

//*

//* All rights reserved, see COPYRIGHT for full restrictions

//* https://github.com/idaholab/moose/blob/master/COPYRIGHT

//*

//* Licensed under LGPL 2.1, please see LICENSE for details

//* https://www.gnu.org/licenses/lgpl-2.1.html


#ifdef MOOSE_MFEM_ENABLED


#pragma once


#include "MFEMExecutedObject.h"

#include "MFEMContainers.h"


class MFEMAuxKernel : public MFEMExecutedObject

{

public:

  static InputParameters validParams();


  MFEMAuxKernel(const InputParameters & parameters);

  virtual ~MFEMAuxKernel() = default;


  virtual void update() {}


  virtual std::optional<std::string> suppliedVariableName() const override;


protected:

  const AuxVariableName _result_var_name;


  mfem::ParGridFunction & _result_var;


  long _sequence{0};

};


#endif

MFEMContainers.h

MFEMExecutedObject.h

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition InputParameters.h:68

MFEMAuxKernel
Class to construct an auxiliary solver used to update a real auxvariable.
Definition MFEMAuxKernel.h:21

MFEMAuxKernel::suppliedVariableName
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

MFEMAuxKernel::validParams
static InputParameters validParams()
Definition MFEMAuxKernel.C:16

MFEMAuxKernel::_sequence
long _sequence
Counter to keep track of FE space updates.
Definition MFEMAuxKernel.h:41

MFEMAuxKernel::~MFEMAuxKernel
virtual ~MFEMAuxKernel()=default

MFEMAuxKernel::_result_var_name
const AuxVariableName _result_var_name
Name of auxvariable to store the result of the auxkernel in.
Definition MFEMAuxKernel.h:35

MFEMAuxKernel::update
virtual void update()
Method called to update any owned objects upon an FE space update.
Definition MFEMAuxKernel.h:29

MFEMAuxKernel::_result_var
mfem::ParGridFunction & _result_var
Reference to result gridfunction.
Definition MFEMAuxKernel.h:38

MFEMExecutedObject
Base class for MFEM objects that participate in execution ordering but are not UserObjects.
Definition MFEMExecutedObject.h:27

MooseBase::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131