Add helper methods to MFEMGeneralUserObject for fetching properties

aurora-multiphysics · Dec 18, 2024 · 09b9c4c · 09b9c4c
1 parent db110ed
commit 09b9c4c
Show file tree

Hide file tree

Showing 16 changed files with 44 additions and 21 deletions.
diff --git a/include/userobjects/MFEMGeneralUserObject.h b/include/userobjects/MFEMGeneralUserObject.h
@@ -2,6 +2,7 @@
 
 // MOOSE includes
 #include "GeneralUserObject.h"
+#include "mfem.hpp"
 
 // Forwards declaration.
 class MFEMProblem;
@@ -20,6 +21,11 @@ class MFEMGeneralUserObject : public GeneralUserObject
   // FIXME: Should this be marked as const if it is returning a non-const reference?
   MFEMProblem & getMFEMProblem() const { return _mfem_problem; }
 
+  /// Returns references to coefficients stored in the MFEMProblem PropertiesManager.
+  mfem::Coefficient & getScalarProperty(const std::string & name);
+  mfem::VectorCoefficient & getVectorProperty(const std::string & name);
+  mfem::MatrixCoefficient & getMatrixProperty(const std::string & name);
+
   void execute() override {}
 
   void initialize() override {}

diff --git a/src/bcs/MFEMConvectiveHeatFluxBC.C b/src/bcs/MFEMConvectiveHeatFluxBC.C
@@ -22,10 +22,9 @@ MFEMConvectiveHeatFluxBC::validParams()
 // TODO: Currently assumes the vector function coefficient is 3D
 MFEMConvectiveHeatFluxBC::MFEMConvectiveHeatFluxBC(const InputParameters & parameters)
   : MFEMIntegratedBC(parameters),
-    _heat_transfer_coef(getMFEMProblem().getProperties().getScalarProperty(
+    _heat_transfer_coef(getScalarProperty(
         getParam<platypus::MFEMScalarCoefficientName>("heat_transfer_coefficient"))),
-    _T_inf_coef(getMFEMProblem().getProperties().getScalarProperty(
-        getParam<platypus::MFEMScalarCoefficientName>("T_infinity"))),
+    _T_inf_coef(getScalarProperty(getParam<platypus::MFEMScalarCoefficientName>("T_infinity"))),
     _external_heat_flux_coef(getMFEMProblem().makeScalarCoefficient<mfem::ProductCoefficient>(
         _heat_transfer_coef, _T_inf_coef))
 {

diff --git a/src/bcs/MFEMScalarFunctorDirichletBC.C b/src/bcs/MFEMScalarFunctorDirichletBC.C
@@ -14,7 +14,7 @@ MFEMScalarFunctorDirichletBC::validParams()
 MFEMScalarFunctorDirichletBC::MFEMScalarFunctorDirichletBC(const InputParameters & parameters)
   : MFEMEssentialBC(parameters),
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/bcs/MFEMVectorFunctorBoundaryIntegratedBC.C b/src/bcs/MFEMVectorFunctorBoundaryIntegratedBC.C
@@ -15,8 +15,8 @@ MFEMVectorFunctorBoundaryIntegratedBC::validParams()
 MFEMVectorFunctorBoundaryIntegratedBC::MFEMVectorFunctorBoundaryIntegratedBC(
     const InputParameters & parameters)
   : MFEMIntegratedBC(parameters),
-    _vec_coef(getMFEMProblem().getProperties().getVectorProperty(
-        getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
+    _vec_coef(
+        getVectorProperty(getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
 {
 }
 

diff --git a/src/bcs/MFEMVectorFunctorDirichletBCBase.C b/src/bcs/MFEMVectorFunctorDirichletBCBase.C
@@ -14,7 +14,7 @@ MFEMVectorFunctorDirichletBCBase::validParams()
 MFEMVectorFunctorDirichletBCBase::MFEMVectorFunctorDirichletBCBase(
     const InputParameters & parameters)
   : MFEMEssentialBC(parameters),
-    _vec_coef(getMFEMProblem().getProperties().getVectorProperty(
-        getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
+    _vec_coef(
+        getVectorProperty(getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
 {
 }
diff --git a/src/bcs/MFEMVectorFunctorNormalIntegratedBC.C b/src/bcs/MFEMVectorFunctorNormalIntegratedBC.C
@@ -16,8 +16,8 @@ MFEMVectorFunctorNormalIntegratedBC::validParams()
 MFEMVectorFunctorNormalIntegratedBC::MFEMVectorFunctorNormalIntegratedBC(
     const InputParameters & parameters)
   : MFEMIntegratedBC(parameters),
-    _vec_coef(getMFEMProblem().getProperties().getVectorProperty(
-        getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
+    _vec_coef(
+        getVectorProperty(getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
 {
 }
 

diff --git a/src/kernels/MFEMCurlCurlKernel.C b/src/kernels/MFEMCurlCurlKernel.C
@@ -22,7 +22,7 @@ MFEMCurlCurlKernel::MFEMCurlCurlKernel(const InputParameters & parameters)
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
     // FIXME: The MFEM bilinear form can also handle vector and matrix
     // coefficients, so ideally we'd handle all three too.
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/kernels/MFEMDiffusionKernel.C b/src/kernels/MFEMDiffusionKernel.C
@@ -21,7 +21,7 @@ MFEMDiffusionKernel::MFEMDiffusionKernel(const InputParameters & parameters)
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
     // FIXME: The MFEM bilinear form can also handle vector and matrix
     // coefficients, so ideally we'd handle all three too.
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/kernels/MFEMDivDivKernel.C b/src/kernels/MFEMDivDivKernel.C
@@ -24,7 +24,7 @@ MFEMDivDivKernel::MFEMDivDivKernel(const InputParameters & parameters)
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
     // FIXME: The MFEM bilinear form can also handle vector and matrix
     // coefficients, so ideally we'd handle all three too.
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/kernels/MFEMLinearElasticityKernel.C b/src/kernels/MFEMLinearElasticityKernel.C
@@ -28,8 +28,8 @@ MFEMLinearElasticityKernel::MFEMLinearElasticityKernel(const InputParameters & p
   : MFEMKernel(parameters),
     _lambda_name(getParam<platypus::MFEMScalarCoefficientName>("lambda")),
     _mu_name(getParam<platypus::MFEMScalarCoefficientName>("mu")),
-    _lambda(getMFEMProblem().getProperties().getScalarProperty(_lambda_name)),
-    _mu(getMFEMProblem().getProperties().getScalarProperty(_mu_name))
+    _lambda(getScalarProperty(_lambda_name)),
+    _mu(getScalarProperty(_mu_name))
 {
 }
 

diff --git a/src/kernels/MFEMMassKernel.C b/src/kernels/MFEMMassKernel.C
@@ -18,7 +18,7 @@ MFEMMassKernel::validParams()
 MFEMMassKernel::MFEMMassKernel(const InputParameters & parameters)
   : MFEMKernel(parameters),
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/kernels/MFEMMixedVectorGradientKernel.C b/src/kernels/MFEMMixedVectorGradientKernel.C
@@ -20,7 +20,7 @@ MFEMMixedVectorGradientKernel::MFEMMixedVectorGradientKernel(const InputParamete
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
     // FIXME: The MFEM bilinear form can also handle vector and matrix
     // coefficients, so ideally we'd handle all three too.
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/kernels/MFEMVectorFEDomainLFKernel.C b/src/kernels/MFEMVectorFEDomainLFKernel.C
@@ -17,8 +17,8 @@ MFEMVectorFEDomainLFKernel::validParams()
 
 MFEMVectorFEDomainLFKernel::MFEMVectorFEDomainLFKernel(const InputParameters & parameters)
   : MFEMKernel(parameters),
-    _vec_coef(getMFEMProblem().getProperties().getVectorProperty(
-        getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
+    _vec_coef(
+        getVectorProperty(getParam<platypus::MFEMVectorCoefficientName>("vector_coefficient")))
 {
 }
 

diff --git a/src/kernels/MFEMVectorFEMassKernel.C b/src/kernels/MFEMVectorFEMassKernel.C
@@ -20,7 +20,7 @@ MFEMVectorFEMassKernel::MFEMVectorFEMassKernel(const InputParameters & parameter
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
     // FIXME: The MFEM bilinear form can also handle vector and matrix
     // coefficients, so ideally we'd handle all three too.
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/kernels/MFEMVectorFEWeakDivergenceKernel.C b/src/kernels/MFEMVectorFEWeakDivergenceKernel.C
@@ -19,7 +19,7 @@ MFEMVectorFEWeakDivergenceKernel::MFEMVectorFEWeakDivergenceKernel(
     const InputParameters & parameters)
   : MFEMKernel(parameters),
     _coef_name(getParam<platypus::MFEMScalarCoefficientName>("coefficient")),
-    _coef(getMFEMProblem().getProperties().getScalarProperty(_coef_name))
+    _coef(getScalarProperty(_coef_name))
 {
 }
 

diff --git a/src/userobjects/MFEMGeneralUserObject.C b/src/userobjects/MFEMGeneralUserObject.C
@@ -15,3 +15,21 @@ MFEMGeneralUserObject::MFEMGeneralUserObject(const InputParameters & parameters)
   : GeneralUserObject(parameters), _mfem_problem(static_cast<MFEMProblem &>(_fe_problem))
 {
 }
+
+mfem::Coefficient &
+MFEMGeneralUserObject::getScalarProperty(const std::string & name)
+{
+  return getMFEMProblem().getProperties().getScalarProperty(name);
+}
+
+mfem::VectorCoefficient &
+MFEMGeneralUserObject::getVectorProperty(const std::string & name)
+{
+  return getMFEMProblem().getProperties().getVectorProperty(name);
+}
+
+mfem::MatrixCoefficient &
+MFEMGeneralUserObject::getMatrixProperty(const std::string & name)
+{
+  return getMFEMProblem().getProperties().getMatrixProperty(name);
+}