https://mooseframework.inl.gov
MFEMCurlAux.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 MFEM_ENABLED
11 
12 #include "MFEMCurlAux.h"
13 #include "MFEMProblem.h"
14 
15 registerMooseObject("MooseApp", MFEMCurlAux);
16 
17 /*
18 Class to set an H(div) auxvariable to be the curl of a H(curl) vector variable.
19 */
22 {
24  params.addClassDescription(
25  "Calculates the curl of an H(curl) conforming ND source variable and stores the result"
26  " on an H(div) conforming RT result auxvariable");
27  params.addRequiredParam<VariableName>("source",
28  "Vector H(curl) MFEMVariable to take the curl of.");
29  params.addParam<mfem::real_t>("scale_factor", 1.0, "Factor to scale result auxvariable by.");
30  return params;
31 }
32 
34  : MFEMAuxKernel(parameters),
35  _source_var_name(getParam<VariableName>("source")),
36  _source_var(*getMFEMProblem().getProblemData().gridfunctions.Get(_source_var_name)),
37  _scale_factor(getParam<mfem::real_t>("scale_factor")),
38  _curl(_source_var.ParFESpace(), _result_var.ParFESpace())
39 {
40  _curl.Assemble();
41  _curl.Finalize();
42 }
43 
44 // Computes the auxvariable.
45 void
47 {
48  _result_var = 0.0;
50 }
51 
52 #endif
const mfem::real_t _scale_factor
Definition: MFEMCurlAux.h:39
MFEMCurlAux(const InputParameters &parameters)
Definition: MFEMCurlAux.C:33
virtual void execute() override
Execute method.
Definition: MFEMCurlAux.C:46
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
registerMooseObject("MooseApp", MFEMCurlAux)
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...
const mfem::ParGridFunction & _source_var
Definition: MFEMCurlAux.h:37
mfem::ParGridFunction & _result_var
Reference to result gridfunction.
Definition: MFEMAuxKernel.h:36
static InputParameters validParams()
Definition: MFEMAuxKernel.C:16
static InputParameters validParams()
Definition: MFEMCurlAux.C:21
mfem::common::ParDiscreteCurlOperator _curl
Definition: MFEMCurlAux.h:41
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...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object...