Merge pull request #6 from aurora-multiphysics/EdwardPalmer99/impleme…

…nt-mfem-general-user-object Adds MFEMGeneralUserObject
aurora-multiphysics · Jul 12, 2024 · 11cf338 · 11cf338
2 parents bbb346a + b0d7b93
commit 11cf338
Show file tree

Hide file tree

Showing 31 changed files with 87 additions and 113 deletions.
diff --git a/include/bcs/MFEMBoundaryCondition.h b/include/bcs/MFEMBoundaryCondition.h
@@ -1,12 +1,12 @@
 #pragma once
 
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 #include "boundary_conditions.h"
 #include "gridfunctions.h"
 #include "coefficients.h"
 #include "Function.h"
 
-class MFEMBoundaryCondition : public GeneralUserObject
+class MFEMBoundaryCondition : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
@@ -19,10 +19,6 @@ class MFEMBoundaryCondition : public GeneralUserObject
     return _boundary_condition;
   }
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
 protected:
   std::vector<BoundaryName> _boundary_names;
   mfem::Array<int> bdr_attr;

diff --git a/include/bcs/MFEMComplexVectorDirichletBC.h b/include/bcs/MFEMComplexVectorDirichletBC.h
@@ -12,10 +12,6 @@ class MFEMComplexVectorDirichletBC : public MFEMBoundaryCondition
   MFEMComplexVectorDirichletBC(const InputParameters & parameters);
   ~MFEMComplexVectorDirichletBC() override {}
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
 protected:
   MFEMVectorCoefficient * _vec_coef_re{nullptr};
   MFEMVectorCoefficient * _vec_coef_im{nullptr};

diff --git a/include/bcs/MFEMScalarDirichletBC.h b/include/bcs/MFEMScalarDirichletBC.h
@@ -12,10 +12,6 @@ class MFEMScalarDirichletBC : public MFEMBoundaryCondition
   MFEMScalarDirichletBC(const InputParameters & parameters);
   ~MFEMScalarDirichletBC() override {}
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
 protected:
   MFEMCoefficient * _coef{nullptr};
 };
diff --git a/include/bcs/MFEMVectorDirichletBC.h b/include/bcs/MFEMVectorDirichletBC.h
@@ -12,10 +12,6 @@ class MFEMVectorDirichletBC : public MFEMBoundaryCondition
   MFEMVectorDirichletBC(const InputParameters & parameters);
   ~MFEMVectorDirichletBC() override {}
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
 protected:
   MFEMVectorCoefficient * _vec_coef{nullptr};
 };
diff --git a/include/bcs/MFEMVectorNormalIntegratedBC.h b/include/bcs/MFEMVectorNormalIntegratedBC.h
@@ -12,10 +12,6 @@ class MFEMVectorNormalIntegratedBC : public MFEMBoundaryCondition
   MFEMVectorNormalIntegratedBC(const InputParameters & parameters);
   ~MFEMVectorNormalIntegratedBC() override {}
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
 protected:
   MFEMVectorCoefficient * _vec_coef{nullptr};
 };
diff --git a/include/coefficients/MFEMCoefficient.h b/include/coefficients/MFEMCoefficient.h
@@ -1,23 +1,19 @@
 #pragma once
 
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 #include "coefficients.h"
 #include "Function.h"
 
 libMesh::Point PointFromMFEMVector(const mfem::Vector & vec);
 
-class MFEMCoefficient : public GeneralUserObject
+class MFEMCoefficient : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMCoefficient(const InputParameters & parameters);
   virtual ~MFEMCoefficient();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   virtual std::shared_ptr<mfem::Coefficient> getCoefficient() const
   {
     mooseError("Base class MFEMCoefficient cannot return a valid Coefficient. Use a child class.");

diff --git a/include/coefficients/MFEMConstantCoefficient.h b/include/coefficients/MFEMConstantCoefficient.h
@@ -11,10 +11,6 @@ class MFEMConstantCoefficient : public MFEMCoefficient
   MFEMConstantCoefficient(const InputParameters & parameters);
   virtual ~MFEMConstantCoefficient();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   std::shared_ptr<mfem::Coefficient> getCoefficient() const override { return coefficient; }
 
 private:

diff --git a/include/coefficients/MFEMFunctionCoefficient.h b/include/coefficients/MFEMFunctionCoefficient.h
@@ -9,10 +9,6 @@ class MFEMFunctionCoefficient : public MFEMCoefficient
   MFEMFunctionCoefficient(const InputParameters & parameters);
   virtual ~MFEMFunctionCoefficient();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   std::shared_ptr<mfem::Coefficient> getCoefficient() const override { return _coefficient; };
 
 private:

diff --git a/include/coefficients/MFEMVectorCoefficient.h b/include/coefficients/MFEMVectorCoefficient.h
@@ -1,21 +1,17 @@
 #pragma once
 
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 #include "coefficients.h"
 #include "Function.h"
 
-class MFEMVectorCoefficient : public GeneralUserObject
+class MFEMVectorCoefficient : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMVectorCoefficient(const InputParameters & parameters);
   virtual ~MFEMVectorCoefficient();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   virtual std::shared_ptr<mfem::VectorCoefficient> getVectorCoefficient() const
   {
     mooseError("Base class MFEMVectorCoefficient cannot return a valid VectorCoefficient. Use a "

diff --git a/include/coefficients/MFEMVectorConstantCoefficient.h b/include/coefficients/MFEMVectorConstantCoefficient.h
@@ -9,10 +9,6 @@ class MFEMVectorConstantCoefficient : public MFEMVectorCoefficient
   MFEMVectorConstantCoefficient(const InputParameters & parameters);
   virtual ~MFEMVectorConstantCoefficient();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   virtual std::shared_ptr<mfem::VectorCoefficient> getVectorCoefficient() const override
   {
     return _vector_coefficient;

diff --git a/include/coefficients/MFEMVectorFunctionCoefficient.h b/include/coefficients/MFEMVectorFunctionCoefficient.h
@@ -9,10 +9,6 @@ class MFEMVectorFunctionCoefficient : public MFEMVectorCoefficient
   MFEMVectorFunctionCoefficient(const InputParameters & parameters);
   virtual ~MFEMVectorFunctionCoefficient();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   std::shared_ptr<mfem::VectorCoefficient> getVectorCoefficient() const override
   {
     return _vector_coefficient;

diff --git a/include/fespaces/MFEMFESpace.h b/include/fespaces/MFEMFESpace.h
@@ -1,16 +1,13 @@
 #pragma once
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 
-class MFEMFESpace : public GeneralUserObject
+class MFEMFESpace : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMFESpace(const InputParameters & parameters);
   virtual ~MFEMFESpace();
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
 
   static const std::string createFECName(const std::string & fespace_type, const int order);
   const int order;

diff --git a/include/formulations/CustomFormulation.h b/include/formulations/CustomFormulation.h
@@ -11,11 +11,6 @@ class CustomFormulation : public MFEMFormulation
   CustomFormulation(const InputParameters & parameters);
   ~CustomFormulation() override = default;
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
-  /// Returns a shared pointer to the time-domain equation system problem builder.
   std::shared_ptr<platypus::ProblemBuilder> getProblemBuilder() const override
   {
     return _formulation;

diff --git a/include/formulations/MFEMFormulation.h b/include/formulations/MFEMFormulation.h
@@ -1,20 +1,16 @@
 #pragma once
 
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 #include "problem_builder_base.h"
 
-class MFEMFormulation : public GeneralUserObject
+class MFEMFormulation : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMFormulation(const InputParameters & parameters);
   virtual ~MFEMFormulation() override = default;
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   virtual std::shared_ptr<platypus::ProblemBuilder> getProblemBuilder() const
   {
     mooseError(

diff --git a/include/kernels/MFEMBilinearFormKernel.h b/include/kernels/MFEMBilinearFormKernel.h
@@ -1,20 +1,16 @@
 #pragma once
 
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 #include "kernels.h"
 #include "gridfunctions.h"
 
-class MFEMBilinearFormKernel : public GeneralUserObject
+class MFEMBilinearFormKernel : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMBilinearFormKernel(const InputParameters & parameters);
   virtual ~MFEMBilinearFormKernel() {}
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   virtual std::shared_ptr<platypus::Kernel<mfem::ParBilinearForm>> getKernel() { return nullptr; }
 };
diff --git a/include/kernels/MFEMDiffusionKernel.h b/include/kernels/MFEMDiffusionKernel.h
@@ -10,10 +10,6 @@ class MFEMDiffusionKernel : public MFEMBilinearFormKernel
   MFEMDiffusionKernel(const InputParameters & parameters);
   ~MFEMDiffusionKernel() override {}
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   std::shared_ptr<platypus::Kernel<mfem::ParBilinearForm>> getKernel() override { return _kernel; }
 
 protected:

diff --git a/include/kernels/MFEMLinearFormKernel.h b/include/kernels/MFEMLinearFormKernel.h
@@ -1,20 +1,16 @@
 #pragma once
 
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 #include "kernels.h"
 #include "gridfunctions.h"
 
-class MFEMLinearFormKernel : public GeneralUserObject
+class MFEMLinearFormKernel : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMLinearFormKernel(const InputParameters & parameters);
   virtual ~MFEMLinearFormKernel();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   virtual std::shared_ptr<platypus::Kernel<mfem::ParLinearForm>> getKernel() { return nullptr; }
 };
diff --git a/include/materials/MFEMMaterial.h b/include/materials/MFEMMaterial.h
@@ -1,21 +1,17 @@
 #pragma once
 
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 #include "MFEMCoefficient.h"
 #include "coefficients.h"
 
-class MFEMMaterial : public GeneralUserObject
+class MFEMMaterial : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMMaterial(const InputParameters & parameters);
   virtual ~MFEMMaterial();
 
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
-
   virtual void storeCoefficients(platypus::Subdomain & subdomain) {}
 
   std::vector<SubdomainName> blocks;

diff --git a/include/problem/MFEMProblem.h b/include/problem/MFEMProblem.h
@@ -101,14 +101,16 @@ class MFEMProblem : public ExternalProblem
 
   /**
    * Override of ExternalProblem::addKernel. Uses ExternalProblem::addKernel to create a
-   * GeneralUserObject representing the kernel in MOOSE, and creates corresponding MFEM kernel
+   * MFEMGeneralUserObject representing the kernel in MOOSE, and creates corresponding MFEM kernel
    * to be used in the MFEM solve.
    */
   void addKernel(const std::string & kernel_name,
                  const std::string & name,
                  InputParameters & parameters) override;
   /**
-   * Override of ExternalProblem::addAuxKernel.
+   * Override of ExternalProblem::addAuxKernel. Uses ExternalProblem::addAuxKernel to create a
+   * MFEMGeneralUserObject representing the auxkernel in MOOSE, and creates corresponding MFEM
+   * auxsolver to be used in the MFEM solve.
    */
   void addAuxKernel(const std::string & kernel_name,
                     const std::string & name,

diff --git a/include/userobjects/MFEMGeneralUserObject.h b/include/userobjects/MFEMGeneralUserObject.h
@@ -0,0 +1,30 @@
+#pragma once
+
+// MOOSE includes
+#include "GeneralUserObject.h"
+
+// Forwards declaration.
+class MFEMProblem;
+
+/*
+ * This class adds a getMFEMProblem method.
+ */
+class MFEMGeneralUserObject : public GeneralUserObject
+{
+public:
+  static InputParameters validParams();
+
+  MFEMGeneralUserObject(const InputParameters & parameters);
+
+  /// Returns a reference to the MFEMProblem instance.
+  MFEMProblem & getMFEMProblem() const { return _mfem_problem; }
+
+  void execute() override {}
+
+  void initialize() override {}
+
+  void finalize() override {}
+
+private:
+  MFEMProblem & _mfem_problem;
+};
diff --git a/include/variables/MFEMVariable.h b/include/variables/MFEMVariable.h
@@ -1,18 +1,15 @@
 #pragma once
 
 #include "MFEMFESpace.h"
-#include "GeneralUserObject.h"
+#include "MFEMGeneralUserObject.h"
 
-class MFEMVariable : public GeneralUserObject
+class MFEMVariable : public MFEMGeneralUserObject
 {
 public:
   static InputParameters validParams();
 
   MFEMVariable(const InputParameters & parameters);
   virtual ~MFEMVariable();
-  virtual void execute() override {}
-  virtual void initialize() override {}
-  virtual void finalize() override {}
 
   const MFEMFESpace & fespace;
   unsigned int components;

diff --git a/src/bcs/MFEMBoundaryCondition.C b/src/bcs/MFEMBoundaryCondition.C
@@ -5,7 +5,7 @@ registerMooseObject("PlatypusApp", MFEMBoundaryCondition);
 InputParameters
 MFEMBoundaryCondition::validParams()
 {
-  InputParameters params = GeneralUserObject::validParams();
+  InputParameters params = MFEMGeneralUserObject::validParams();
 
   params.registerBase("BoundaryCondition");
 
@@ -18,7 +18,7 @@ MFEMBoundaryCondition::validParams()
 }
 
 MFEMBoundaryCondition::MFEMBoundaryCondition(const InputParameters & parameters)
-  : GeneralUserObject(parameters),
+  : MFEMGeneralUserObject(parameters),
     _boundary_names(getParam<std::vector<BoundaryName>>("boundary")),
     bdr_attr(_boundary_names.size())
 {