Moose::MFEM::EquationSystem Class Reference

Owns the weak-form mathematics of a MOOSE MFEM problem. More...

#include <EquationSystem.h>

Inheritance diagram for Moose::MFEM::EquationSystem:

Public Member Functions
	EquationSystem ()=default
	~EquationSystem () override
virtual void	AddKernel (std::shared_ptr< MFEMKernel > kernel)
	Add kernels. More...
virtual void	AddIntegratedBC (std::shared_ptr< MFEMIntegratedBC > kernel)
virtual void	AddEssentialBC (std::shared_ptr< MFEMEssentialBC > bc)
	Add BC associated with essentially constrained DoFs on boundaries. More...
virtual void	Init (GridFunctions &gridfunctions, ComplexGridFunctions &cmplx_gridfunctions, mfem::AssemblyLevel assembly_level)
	Initialise. More...
void	FormSystem (mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
	Build all weak-form components via BuildEquationSystem(), form the constrained linear part of the system, and populate the true-DoF vectors used by the solve. More...
void	Mult (const mfem::Vector &u, mfem::Vector &residual) const override
	Compute residual y = Mu. More...
virtual void	ComputeNonlinearResidual (const mfem::Vector &u, mfem::Vector &residual) const
	Compute the contribution to the residual from nonlinear forms only. More...
mfem::Operator &	GetGradient (const mfem::Vector &u) const override
	Get Jacobian at the provided vector of true DoFs of trial variables. More...
mfem::OperatorHandle &	GetLinearOperator () const
	Get operator handle for linear component of system operator. More...
virtual void	SetTrialVariablesFromTrueVectors (const mfem::BlockVector &trueX) const
	Update variable from solution vector after solve. More...
void	SetGradientRequired (bool requires_gradient)
	Set whether an external object (such as a nonlinear solver) requires Jacobian information for this EquationSystem. More...
void	SetCoefficientManager (CoefficientManager &coefficients)
	Set the coefficient manager to notify when trial variables are updated, so that stored projections of solution-dependent coefficients are invalidated. More...
const std::vector< std::string > &	GetTrialVarNames () const
const std::vector< std::string > &	GetTestVarNames () const
const mfem::Array< int > &	GetBlockOffsets () const
	Getter for block true offsets associated with the EquationSystem operator. More...
mfem::ParBilinearForm &	GetBilinearForm (const std::string &test_var_name)
mfem::ParGridFunction &	GetGridFunction (const std::string &trial_var_name)
bool	Nonlinear () const
const mfem::Vector &	GetLinearizationPoint () const
	The true-DoF vector used for the most recent Jacobian linearization. More...
std::shared_ptr< mfem::ParBilinearForm >	BuildBilinearFormForFESpace (const std::string &var_name, mfem::ParFiniteElementSpace &fespace, mfem::AssemblyLevel assembly_level)
	Build a fresh ParBilinearForm on the given FESpace using the same kernels as the main system's bilinear form for var_name. More...
std::shared_ptr< mfem::ParNonlinearForm >	BuildNonlinearFormForFESpace (const std::string &var_name, mfem::ParFiniteElementSpace &fespace, mfem::AssemblyLevel assembly_level)
	Build a fresh ParNonlinearForm on the given FESpace using the same kernels as the main system's nonlinear form for var_name. More...
mfem::Array< int > &	GetEssentialBoundaryMarkers (const std::string &var_name)
	Return the essential boundary attribute marker array for a given trial variable. More...
virtual bool	IsComplex () const
virtual bool	IsEigen () const
virtual bool	IsTimeDependent () const
bool	IsMultivariate () const
bool	IsNonlinear () const
virtual void	BuildEquationSystem ()
	Build all forms comprising this EquationSystem. More...

Protected Member Functions
virtual void	AddCoupledVariableNameIfMissing (const std::string &coupled_var_name)
	Add coupled variable to EquationSystem. More...
virtual void	AddEliminatedVariableNameIfMissing (const std::string &eliminated_var_name)
	Add eliminated variable to EquationSystem. More...
virtual void	AddTestVariableNameIfMissing (const std::string &test_var_name)
	Add test variable to EquationSystem. More...
virtual void	SetTrialVariableNames ()
	Set trial variable names from subset of coupled variables that have an associated test variable. More...
void	DeleteHBlocks ()
	Deletes the HypreParMatrix associated with any pointer stored in _h_blocks, and then proceeds to delete all dynamically allocated memory for _h_blocks itself, resetting all dimensions to zero. More...
void	DeleteJacobianBlocks ()
	Deletes the HypreParMatrix associated with any pointer stored in _jacobian_blocks, and then proceeds to delete all dynamically allocated memory for _jacobian_blocks itself, resetting all dimensions to zero. More...
bool	VectorContainsName (const std::vector< std::string > &the_vector, const std::string &name) const
virtual void	ApplyEssentialBC (const std::string &var_name, mfem::ParGridFunction &trial_gf, mfem::Array< int > &global_ess_markers)
	Apply essential BC(s) associated with var_name to set true DoFs of trial_gf and update markers of all essential boundaries. More...
virtual void	ApplyEssentialBCs ()
	Update all essentially constrained true DoF markers and values on boundaries. More...
virtual void	EliminateCoupledVariables ()
	Perform trivial eliminations of coupled variables lacking corresponding test variables. More...
virtual void	BuildLinearForms ()
	Build linear forms and eliminate constrained DoFs. More...
virtual void	BuildNonlinearForms ()
	Build non-linear action forms. More...
virtual void	BuildBilinearForms ()
	Build bilinear forms (diagonal Jacobian contributions) More...
virtual void	BuildMixedBilinearForms ()
	Build mixed bilinear forms (off-diagonal Jacobian contributions) More...
virtual void	FormLinearSystem (mfem::OperatorHandle &op, mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
	Form linear components of system based on on- and off-diagonal bilinear form contributions, populate solution and RHS vectors of true DoFs, and apply constraints. More...
virtual void	FormSystemOperator (mfem::OperatorHandle &op, mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
	Form matrix-free representation of linear components of system operator. More...
virtual void	FormSystemMatrix (mfem::OperatorHandle &op, mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
	Form matrix representation of linear components of system operator as a HypreParMatrix. More...
void	FormJacobianMatrix (const mfem::Vector &u)
	Compute Jacobian matrix at the provided vector of true DoFs of trial variables. More...
template<class FormType >
void	ApplyDomainBLFIntegrators (const std::string &trial_var_name, const std::string &test_var_name, std::shared_ptr< FormType > form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &kernels_map, std::optional< mfem::real_t > scale_factor=std::nullopt)
	Template method for applying BilinearFormIntegrators on domains from kernels to a BilinearForm, or MixedBilinearForm. More...
void	ApplyDomainLFIntegrators (const std::string &test_var_name, std::shared_ptr< mfem::ParLinearForm > form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &kernels_map)
	Apply domain LinearFormIntegrators from kernels to the linear form associated with the supplied test variable. More...
void	ApplyDomainNLFIntegrators (const std::string &test_var_name, std::shared_ptr< mfem::ParNonlinearForm > form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &kernels_map, std::optional< mfem::real_t > scale_factor=std::nullopt)
	Apply domain NonlinearFormIntegrators from kernels to the nonlinear form associated with the supplied test variable. More...
template<class FormType >
void	ApplyBoundaryBLFIntegrators (const std::string &trial_var_name, const std::string &test_var_name, std::shared_ptr< FormType > form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &integrated_bc_map, std::optional< mfem::real_t > scale_factor=std::nullopt)
	Template method for applying BilinearFormIntegrators on boundaries from integrated boundary conditions to a BilinearForm, or MixedBilinearForm. More...
void	ApplyBoundaryLFIntegrators (const std::string &test_var_name, std::shared_ptr< mfem::ParLinearForm > form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &integrated_bc_map)
	Apply boundary LinearFormIntegrators from integrated boundary conditions to the linear form associated with the supplied test variable. More...
void	ApplyBoundaryNLFIntegrators (const std::string &test_var_name, std::shared_ptr< mfem::ParNonlinearForm > form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &integrated_bc_map, std::optional< mfem::real_t > scale_factor=std::nullopt)
	Apply boundary NonlinearFormIntegrators from integrated boundary conditions to the nonlinear form associated with the supplied test variable. More...

Protected Attributes
std::vector< std::string >	_coupled_var_names
	Names of all trial variables of kernels and boundary conditions added to this EquationSystem. More...
std::vector< std::string >	_trial_var_names
	Subset of _coupled_var_names of all variables corresponding to gridfunctions with degrees of freedom that comprise the state vector of this EquationSystem. More...
std::vector< std::string >	_eliminated_var_names
	Names of all coupled variables without a corresponding test variable. More...
Moose::MFEM::GridFunctions	_eliminated_variables
	Pointers to coupled variables not part of the reduced EquationSystem. More...
std::vector< std::string >	_test_var_names
	Names of all test variables corresponding to linear forms in this equation system. More...
std::vector< mfem::ParFiniteElementSpace * >	_test_pfespaces
	Pointers to finite element spaces associated with test variables. More...
std::vector< mfem::ParFiniteElementSpace * >	_coupled_pfespaces
	Pointers to finite element spaces associated with coupled variables. More...
NamedFieldsMap< mfem::ParBilinearForm >	_blfs
NamedFieldsMap< mfem::ParLinearForm >	_lfs
NamedFieldsMap< mfem::ParNonlinearForm >	_nlfs
NamedFieldsMap< NamedFieldsMap< mfem::ParMixedBilinearForm > >	_mblfs
std::vector< std::unique_ptr< mfem::ParGridFunction > >	_var_ess_constraints
	Gridfunctions holding essential constraints from Dirichlet BCs. More...
std::vector< mfem::Array< int > >	_ess_tdof_lists
std::vector< mfem::Array< int > >	_ess_markers
mfem::Array2D< const mfem::HypreParMatrix * >	_h_blocks
mfem::Array2D< const mfem::HypreParMatrix * >	_jacobian_blocks
NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel > > > >	_kernels_map
	Arrays to store kernels to act on each component of weak form. More...
NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC > > > >	_integrated_bc_map
	Arrays to store integrated BCs to act on each component of weak form. More...
NamedFieldsMap< std::vector< std::shared_ptr< MFEMEssentialBC > > >	_essential_bc_map
	Arrays to store essential BCs to act on each component of weak form. More...
mfem::OperatorHandle	_jacobian
mfem::OperatorHandle	_linear_operator
mfem::AssemblyLevel	_assembly_level
Moose::MFEM::GridFunctions *	_gfuncs
mfem::Array< int >	_block_true_offsets
const mfem::Vector *	_linearization_point = nullptr
bool	_non_linear = false
bool	_gradient_required = false
CoefficientManager *	_coefficient_manager = nullptr

Detailed Description

Owns the weak-form mathematics of a MOOSE MFEM problem.

An EquationSystem stores weak-form components (bilinear, linear, mixed-bilinear, and nonlinear forms) contributed by kernels and boundary conditions. It forms the constrained linear part, keeps nonlinear action forms for residual/Jacobian evaluation, and exposes the solve interface as an mfem::Operator. It is responsible for applying essential-DoF constraints and propagating either itself or the assembled linear operator (and bilinear form, for LOR) to the configured solver tree.

EquationSystem is not responsible for grid-function bookkeeping, time stepping, or solver selection - those belong to the ProblemOperator layer.

See also

ProblemOperatorBase for the conceptual split between the two layers.

Definition at line 44 of file EquationSystem.h.

Constructor & Destructor Documentation

EquationSystem()

Moose::MFEM::EquationSystem::EquationSystem ( )

default

~EquationSystem()

Moose::MFEM::EquationSystem::~EquationSystem ( )

override

Definition at line 20 of file EquationSystem.C.

{
  DeleteHBlocks();
  DeleteJacobianBlocks();
}

Member Function Documentation

AddCoupledVariableNameIfMissing()

void Moose::MFEM::EquationSystem::AddCoupledVariableNameIfMissing ( const std::string &  coupled_var_name )

protectedvirtual

Add coupled variable to EquationSystem.

Definition at line 57 of file EquationSystem.C.

Referenced by Moose::MFEM::ComplexEquationSystem::AddComplexIntegratedBC(), Moose::MFEM::ComplexEquationSystem::AddComplexKernel(), AddIntegratedBC(), and AddKernel().

{
  if (!VectorContainsName(_coupled_var_names, coupled_var_name))
    _coupled_var_names.push_back(coupled_var_name);
}

AddEliminatedVariableNameIfMissing()

void Moose::MFEM::EquationSystem::AddEliminatedVariableNameIfMissing ( const std::string &  eliminated_var_name )

protectedvirtual

Add eliminated variable to EquationSystem.

Definition at line 64 of file EquationSystem.C.

Referenced by Moose::MFEM::TimeDependentEquationSystem::AddKernel().

{
  if (!VectorContainsName(_eliminated_var_names, eliminated_var_name))
    _eliminated_var_names.push_back(eliminated_var_name);
}

AddEssentialBC()

void Moose::MFEM::EquationSystem::AddEssentialBC ( std::shared_ptr< MFEMEssentialBC >  bc )

virtual

Add BC associated with essentially constrained DoFs on boundaries.

Definition at line 139 of file EquationSystem.C.

Referenced by MFEMProblem::addBoundaryCondition().

{
  const auto & test_var_name = bc->getTestVariableName();
  AddTestVariableNameIfMissing(test_var_name);
  // Register new essential bc map if not present for the test variable
  if (!_essential_bc_map.Has(test_var_name))
  {
    auto bcs = std::make_shared<std::vector<std::shared_ptr<MFEMEssentialBC>>>();
    _essential_bc_map.Register(test_var_name, std::move(bcs));
  }
  _essential_bc_map.GetRef(test_var_name).push_back(std::move(bc));
}

AddIntegratedBC()

void Moose::MFEM::EquationSystem::AddIntegratedBC ( std::shared_ptr< MFEMIntegratedBC >  kernel )

virtual

Definition at line 116 of file EquationSystem.C.

Referenced by MFEMProblem::addBoundaryCondition().

{
  const auto & trial_var_name = bc->getTrialVariableName();
  const auto & test_var_name = bc->getTestVariableName();
  AddCoupledVariableNameIfMissing(trial_var_name);
  AddTestVariableNameIfMissing(test_var_name);
  // Register new integrated bc map if not present for the test variable
  if (!_integrated_bc_map.Has(test_var_name))
  {
    auto integrated_bc_field_map = std::make_shared<
        Moose::MFEM::NamedFieldsMap<std::vector<std::shared_ptr<MFEMIntegratedBC>>>>();
    _integrated_bc_map.Register(test_var_name, std::move(integrated_bc_field_map));
  }
  // Register new integrated bc map if not present for the test/trial variable pair
  if (!_integrated_bc_map.Get(test_var_name)->Has(trial_var_name))
  {
    auto bcs = std::make_shared<std::vector<std::shared_ptr<MFEMIntegratedBC>>>();
    _integrated_bc_map.Get(test_var_name)->Register(trial_var_name, std::move(bcs));
  }
  _integrated_bc_map.GetRef(test_var_name).Get(trial_var_name)->push_back(std::move(bc));
}

AddKernel()

void Moose::MFEM::EquationSystem::AddKernel ( std::shared_ptr< MFEMKernel >  kernel )

virtual

Add kernels.

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 93 of file EquationSystem.C.

Referenced by Moose::MFEM::TimeDependentEquationSystem::AddKernel(), and MFEMProblem::addKernel().

{
  const auto & trial_var_name = kernel->getTrialVariableName();
  const auto & test_var_name = kernel->getTestVariableName();
  AddCoupledVariableNameIfMissing(trial_var_name);
  AddTestVariableNameIfMissing(test_var_name);
  // Register new kernels map if not present for the test variable
  if (!_kernels_map.Has(test_var_name))
  {
    auto kernel_field_map =
        std::make_shared<Moose::MFEM::NamedFieldsMap<std::vector<std::shared_ptr<MFEMKernel>>>>();
    _kernels_map.Register(test_var_name, std::move(kernel_field_map));
  }
  // Register new kernels map if not present for the test/trial variable pair
  if (!_kernels_map.Get(test_var_name)->Has(trial_var_name))
  {
    auto kernels = std::make_shared<std::vector<std::shared_ptr<MFEMKernel>>>();
    _kernels_map.Get(test_var_name)->Register(trial_var_name, std::move(kernels));
  }
  _kernels_map.GetRef(test_var_name).Get(trial_var_name)->push_back(std::move(kernel));
}

AddTestVariableNameIfMissing()

void Moose::MFEM::EquationSystem::AddTestVariableNameIfMissing ( const std::string &  test_var_name )

protectedvirtual

Add test variable to EquationSystem.

Definition at line 71 of file EquationSystem.C.

Referenced by Moose::MFEM::ComplexEquationSystem::AddComplexEssentialBCs(), Moose::MFEM::ComplexEquationSystem::AddComplexIntegratedBC(), Moose::MFEM::ComplexEquationSystem::AddComplexKernel(), AddEssentialBC(), AddIntegratedBC(), Moose::MFEM::TimeDependentEquationSystem::AddKernel(), and AddKernel().

{
  if (!VectorContainsName(_test_var_names, test_var_name))
    _test_var_names.push_back(test_var_name);
}

ApplyBoundaryBLFIntegrators()

template<class FormType >

void Moose::MFEM::EquationSystem::ApplyBoundaryBLFIntegrators ( const std::string &  trial_var_name, const std::string &  test_var_name, std::shared_ptr< FormType >  form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &  integrated_bc_map, std::optional< mfem::real_t >  scale_factor = std::nullopt  )

protected

Template method for applying BilinearFormIntegrators on boundaries from integrated boundary conditions to a BilinearForm, or MixedBilinearForm.

Definition at line 385 of file EquationSystem.h.

{
  if (integrated_bc_map.Has(test_var_name) &&
      integrated_bc_map.Get(test_var_name)->Has(trial_var_name))
  {
    auto bcs = integrated_bc_map.GetRef(test_var_name).GetRef(trial_var_name);
    for (auto & bc : bcs)
    {
      mfem::BilinearFormIntegrator * integ = bc->createBFIntegrator();

      if (integ)
      {
        if (scale_factor.has_value())
          integ = new ScaleIntegrator(integ, scale_factor.value(), true);
        bc->isBoundaryRestricted()
            ? form->AddBoundaryIntegrator(std::move(integ), bc->getBoundaryMarkers())
            : form->AddBoundaryIntegrator(std::move(integ));
      }
    }
  }
}

ApplyBoundaryLFIntegrators()

void Moose::MFEM::EquationSystem::ApplyBoundaryLFIntegrators ( const std::string &  test_var_name, std::shared_ptr< mfem::ParLinearForm >  form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &  integrated_bc_map  )

protected

Apply boundary LinearFormIntegrators from integrated boundary conditions to the linear form associated with the supplied test variable.

Definition at line 649 of file EquationSystem.C.

Referenced by BuildLinearForms().

{
  if (integrated_bc_map.Has(test_var_name) &&
      integrated_bc_map.Get(test_var_name)->Has(test_var_name))
  {
    auto bcs = integrated_bc_map.GetRef(test_var_name).GetRef(test_var_name);
    for (auto & bc : bcs)
    {
      mfem::LinearFormIntegrator * integ = bc->createLFIntegrator();

      if (integ)
      {
        bc->isBoundaryRestricted()
            ? form->AddBoundaryIntegrator(std::move(integ), bc->getBoundaryMarkers())
            : form->AddBoundaryIntegrator(std::move(integ));
      }
    }
  }
}

ApplyBoundaryNLFIntegrators()

void Moose::MFEM::EquationSystem::ApplyBoundaryNLFIntegrators ( const std::string &  test_var_name, std::shared_ptr< mfem::ParNonlinearForm >  form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &  integrated_bc_map, std::optional< mfem::real_t >  scale_factor = std::nullopt  )

protected

Apply boundary NonlinearFormIntegrators from integrated boundary conditions to the nonlinear form associated with the supplied test variable.

Definition at line 674 of file EquationSystem.C.

Referenced by BuildNonlinearFormForFESpace(), Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), and BuildNonlinearForms().

{
  if (integrated_bc_map.Has(test_var_name))
    for (const auto & [trial_var_name, bcs] : integrated_bc_map.GetRef(test_var_name))
      for (auto & bc : *bcs)
        if (auto * integ = bc->createNLIntegrator())
        {
          if (_gradient_required && (test_var_name != trial_var_name))
            mooseError(
                "Support for Off-diagonal MFEM nonlinear boundary integrators in conjunction with "
                "a nonlinear solver that requires a gradient is not currently "
                "implemented. Boundary condition '",
                bc->name(),
                "' contributes to test variable '",
                test_var_name,
                "' from trial variable '",
                trial_var_name,
                "'.");

          _non_linear = true;
          if (scale_factor.has_value())
            integ = new NLScaleIntegrator(integ, scale_factor.value(), true);
          bc->isBoundaryRestricted()
              ? form->AddBoundaryIntegrator(std::move(integ), bc->getBoundaryMarkers())
              : form->AddBoundaryIntegrator(std::move(integ));
        }
}

ApplyDomainBLFIntegrators()

template<class FormType >

void Moose::MFEM::EquationSystem::ApplyDomainBLFIntegrators ( const std::string &  trial_var_name, const std::string &  test_var_name, std::shared_ptr< FormType >  form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &  kernels_map, std::optional< mfem::real_t >  scale_factor = std::nullopt  )

protected

Template method for applying BilinearFormIntegrators on domains from kernels to a BilinearForm, or MixedBilinearForm.

Definition at line 357 of file EquationSystem.h.

{
  if (kernels_map.Has(test_var_name) && kernels_map.Get(test_var_name)->Has(trial_var_name))
  {
    auto kernels = kernels_map.GetRef(test_var_name).GetRef(trial_var_name);
    for (auto & kernel : kernels)
    {
      mfem::BilinearFormIntegrator * integ = kernel->createBFIntegrator();

      if (integ)
      {
        if (scale_factor.has_value())
          integ = new ScaleIntegrator(integ, scale_factor.value(), true);
        kernel->isSubdomainRestricted()
            ? form->AddDomainIntegrator(std::move(integ), kernel->getSubdomainMarkers())
            : form->AddDomainIntegrator(std::move(integ));
      }
    }
  }
}

ApplyDomainLFIntegrators()

void Moose::MFEM::EquationSystem::ApplyDomainLFIntegrators ( const std::string &  test_var_name, std::shared_ptr< mfem::ParLinearForm >  form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &  kernels_map  )

protected

Apply domain LinearFormIntegrators from kernels to the linear form associated with the supplied test variable.

Definition at line 594 of file EquationSystem.C.

Referenced by BuildLinearForms().

{
  if (kernels_map.Has(test_var_name) && kernels_map.Get(test_var_name)->Has(test_var_name))
  {
    auto kernels = kernels_map.GetRef(test_var_name).GetRef(test_var_name);
    for (auto & kernel : kernels)
    {
      mfem::LinearFormIntegrator * integ = kernel->createLFIntegrator();

      if (integ)
      {
        kernel->isSubdomainRestricted()
            ? form->AddDomainIntegrator(std::move(integ), kernel->getSubdomainMarkers())
            : form->AddDomainIntegrator(std::move(integ));
      }
    }
  }
}

ApplyDomainNLFIntegrators()

void Moose::MFEM::EquationSystem::ApplyDomainNLFIntegrators ( const std::string &  test_var_name, std::shared_ptr< mfem::ParNonlinearForm >  form, NamedFieldsMap< NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &  kernels_map, std::optional< mfem::real_t >  scale_factor = std::nullopt  )

protected

Apply domain NonlinearFormIntegrators from kernels to the nonlinear form associated with the supplied test variable.

Definition at line 617 of file EquationSystem.C.

Referenced by BuildNonlinearFormForFESpace(), Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), and BuildNonlinearForms().

{
  if (kernels_map.Has(test_var_name))
    for (const auto & [trial_var_name, kernels] : kernels_map.GetRef(test_var_name))
      for (auto & kernel : *kernels)
        if (auto * integ = kernel->createNLIntegrator())
        {
          if (_gradient_required && (trial_var_name != test_var_name))
            mooseError("Support for off-diagonal MFEM nonlinear domain integrators in conjunction "
                       "with a nonlinear solver that requires a gradient is not currently "
                       "implemented. Kernel '",
                       kernel->name(),
                       "' contributes to test variable '",
                       test_var_name,
                       "' from trial variable '",
                       trial_var_name,
                       "'.");

          _non_linear = true;
          if (scale_factor.has_value())
            integ = new NLScaleIntegrator(integ, scale_factor.value(), true);
          kernel->isSubdomainRestricted()
              ? form->AddDomainIntegrator(std::move(integ), kernel->getSubdomainMarkers())
              : form->AddDomainIntegrator(std::move(integ));
        }
}

ApplyEssentialBC()

void Moose::MFEM::EquationSystem::ApplyEssentialBC ( const std::string &  var_name, mfem::ParGridFunction &  trial_gf, mfem::Array< int > &  global_ess_markers  )

protectedvirtual

Apply essential BC(s) associated with var_name to set true DoFs of trial_gf and update markers of all essential boundaries.

Definition at line 204 of file EquationSystem.C.

Referenced by ApplyEssentialBCs().

{
  if (_essential_bc_map.Has(var_name))
    for (auto & bc : _essential_bc_map.GetRef(var_name))
    {
      // Set constrained DoFs values on essential boundaries
      bc->ApplyBC(trial_gf);
      // Fetch marker array labelling essential boundaries of current BC
      mfem::Array<int> ess_bdrs(bc->getBoundaryMarkers());
      // Add these boundary markers to the set of markers labelling all essential boundaries
      for (const auto i : make_range(ess_bdrs.Size()))
        global_ess_markers[i] |= ess_bdrs[i];
    }
}

ApplyEssentialBCs()

void Moose::MFEM::EquationSystem::ApplyEssentialBCs ( )

protectedvirtual

Update all essentially constrained true DoF markers and values on boundaries.

Reimplemented in Moose::MFEM::ComplexEquationSystem, and Moose::MFEM::EigenproblemEquationSystem.

Definition at line 222 of file EquationSystem.C.

Referenced by BuildLinearForms().

{
  _ess_tdof_lists.resize(_trial_var_names.size());
  _ess_markers.resize(_trial_var_names.size());
  for (const auto i : index_range(_trial_var_names))
  {
    const auto & trial_var_name = _trial_var_names.at(i);
    mfem::ParGridFunction & trial_gf = *_var_ess_constraints.at(i);

    // Make sure we update the size, if this mesh has changed recently for instance
    trial_gf.Update();

    // Initial guess for iterative solvers (initial condition or the previous time step solution)
    trial_gf = _gfuncs->GetRef(trial_var_name);

    _ess_markers.at(i).SetSize(trial_gf.ParFESpace()->GetParMesh()->bdr_attributes.Max(), 0);
    // Set strongly constrained DoFs of trial_gf on essential boundaries and add markers for all
    // essential boundaries to the _ess_markers array
    ApplyEssentialBC(trial_var_name, trial_gf, _ess_markers.at(i));
    trial_gf.ParFESpace()->GetEssentialTrueDofs(_ess_markers.at(i), _ess_tdof_lists.at(i));
  }
}

BuildBilinearFormForFESpace()

std::shared_ptr< mfem::ParBilinearForm > Moose::MFEM::EquationSystem::BuildBilinearFormForFESpace	(	const std::string &	var_name,
		mfem::ParFiniteElementSpace &	fespace,
		mfem::AssemblyLevel	assembly_level
	)

Build a fresh ParBilinearForm on the given FESpace using the same kernels as the main system's bilinear form for var_name.

Caller owns the returned form.

Definition at line 716 of file EquationSystem.C.

{
  auto blf = std::make_shared<mfem::ParBilinearForm>(&fespace);
  blf->SetAssemblyLevel(assembly_level);
  ApplyBoundaryBLFIntegrators<mfem::ParBilinearForm>(var_name, var_name, blf, _integrated_bc_map);
  ApplyDomainBLFIntegrators<mfem::ParBilinearForm>(var_name, var_name, blf, _kernels_map);
  blf->Assemble();
  return blf;
}

BuildBilinearForms()

void Moose::MFEM::EquationSystem::BuildBilinearForms ( )

protectedvirtual

Build bilinear forms (diagonal Jacobian contributions)

Reimplemented in Moose::MFEM::ComplexEquationSystem, and Moose::MFEM::TimeDependentEquationSystem.

Definition at line 525 of file EquationSystem.C.

Referenced by BuildEquationSystem().

{
  // Register bilinear forms
  for (const auto i : index_range(_test_var_names))
  {
    auto test_var_name = _test_var_names.at(i);
    _blfs.Register(test_var_name, std::make_shared<mfem::ParBilinearForm>(_test_pfespaces.at(i)));

    // Apply kernels
    auto blf = _blfs.GetShared(test_var_name);
    blf->SetAssemblyLevel(_assembly_level);
    ApplyBoundaryBLFIntegrators<mfem::ParBilinearForm>(
        test_var_name, test_var_name, blf, _integrated_bc_map);
    ApplyDomainBLFIntegrators<mfem::ParBilinearForm>(
        test_var_name, test_var_name, blf, _kernels_map);
    // Assemble
    blf->Assemble();
  }
}

BuildEquationSystem()

void Moose::MFEM::EquationSystem::BuildEquationSystem ( )

virtual

Build all forms comprising this EquationSystem.

Reimplemented in Moose::MFEM::ComplexEquationSystem.

Definition at line 585 of file EquationSystem.C.

Referenced by Moose::MFEM::EigenproblemESProblemOperator::FormEquationSystemOperator(), and FormSystem().

{
  BuildBilinearForms();
  BuildMixedBilinearForms();
  BuildLinearForms();
  BuildNonlinearForms();
}

BuildLinearForms()

void Moose::MFEM::EquationSystem::BuildLinearForms ( )

protectedvirtual

Build linear forms and eliminate constrained DoFs.

Reimplemented in Moose::MFEM::ComplexEquationSystem.

Definition at line 482 of file EquationSystem.C.

Referenced by BuildEquationSystem().

{
  // Register linear forms
  for (const auto i : index_range(_test_var_names))
  {
    auto test_var_name = _test_var_names.at(i);
    _lfs.Register(test_var_name, std::make_shared<mfem::ParLinearForm>(_test_pfespaces.at(i)));
    _lfs.GetRef(test_var_name) = 0.0;
  }

  for (auto & test_var_name : _test_var_names)
  {
    // Apply kernels
    auto lf = _lfs.GetShared(test_var_name);
    ApplyDomainLFIntegrators(test_var_name, lf, _kernels_map);
    ApplyBoundaryLFIntegrators(test_var_name, lf, _integrated_bc_map);
    lf->Assemble();
  }

  // Apply essential boundary conditions
  ApplyEssentialBCs();

  // Eliminate trivially eliminated variables by subtracting contributions from linear forms
  EliminateCoupledVariables();
}

BuildMixedBilinearForms()

void Moose::MFEM::EquationSystem::BuildMixedBilinearForms ( )

protectedvirtual

Build mixed bilinear forms (off-diagonal Jacobian contributions)

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 546 of file EquationSystem.C.

Referenced by BuildEquationSystem().

{
  // Register mixed bilinear forms. Note that not all combinations may
  // have a kernel.

  // Create mblf for each test/coupled variable pair with an added kernel.
  // Mixed bilinear forms with coupled variables that are not trial variables are
  // associated with contributions from eliminated variables.
  for (const auto i : index_range(_test_var_names))
  {
    auto test_var_name = _test_var_names.at(i);
    auto test_mblfs = std::make_shared<Moose::MFEM::NamedFieldsMap<mfem::ParMixedBilinearForm>>();
    for (const auto j : index_range(_coupled_var_names))
    {
      const auto & coupled_var_name = _coupled_var_names.at(j);
      auto mblf = std::make_shared<mfem::ParMixedBilinearForm>(_coupled_pfespaces.at(j),
                                                               _test_pfespaces.at(i));
      // Register MixedBilinearForm if kernels exist for it, and assemble kernels
      if (_kernels_map.Has(test_var_name) &&
          _kernels_map.Get(test_var_name)->Has(coupled_var_name) &&
          test_var_name != coupled_var_name)
      {
        mblf->SetAssemblyLevel(_assembly_level);
        // Apply all mixed kernels with this test/trial pair
        ApplyDomainBLFIntegrators<mfem::ParMixedBilinearForm>(
            coupled_var_name, test_var_name, mblf, _kernels_map);
        // Assemble mixed bilinear forms
        mblf->Assemble();
        // Register mixed bilinear forms associated with a single trial variable
        // for the current test variable
        test_mblfs->Register(coupled_var_name, mblf);
      }
    }
    // Register all mixed bilinear form sets associated with a single test variable
    _mblfs.Register(test_var_name, test_mblfs);
  }
}

BuildNonlinearFormForFESpace()

std::shared_ptr< mfem::ParNonlinearForm > Moose::MFEM::EquationSystem::BuildNonlinearFormForFESpace	(	const std::string &	var_name,
		mfem::ParFiniteElementSpace &	fespace,
		mfem::AssemblyLevel	assembly_level
	)

Build a fresh ParNonlinearForm on the given FESpace using the same kernels as the main system's nonlinear form for var_name.

Caller owns the returned form.

Definition at line 729 of file EquationSystem.C.

{
  auto nlf = std::make_shared<mfem::ParNonlinearForm>(&fespace);
  ApplyDomainNLFIntegrators(var_name, nlf, _kernels_map, std::nullopt);
  ApplyBoundaryNLFIntegrators(var_name, nlf, _integrated_bc_map, std::nullopt);
  return nlf;
}

BuildNonlinearForms()

void Moose::MFEM::EquationSystem::BuildNonlinearForms ( )

protectedvirtual

Build non-linear action forms.

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 509 of file EquationSystem.C.

Referenced by BuildEquationSystem().

{
  // Register non-linear Action forms
  for (const auto i : index_range(_test_var_names))
  {
    auto test_var_name = _test_var_names.at(i);
    _nlfs.Register(test_var_name, std::make_shared<mfem::ParNonlinearForm>(_test_pfespaces.at(i)));
    // Apply kernels
    auto nlf = _nlfs.GetShared(test_var_name);
    nlf->SetEssentialTrueDofs(_ess_tdof_lists.at(i));
    ApplyDomainNLFIntegrators(test_var_name, nlf, _kernels_map, std::nullopt);
    ApplyBoundaryNLFIntegrators(test_var_name, nlf, _integrated_bc_map, std::nullopt);
  }
}

ComputeNonlinearResidual()

void Moose::MFEM::EquationSystem::ComputeNonlinearResidual ( const mfem::Vector &  u, mfem::Vector &  residual  ) const

virtual

Compute the contribution to the residual from nonlinear forms only.

Definition at line 400 of file EquationSystem.C.

Referenced by Mult().

{
  mooseAssert(_non_linear, "Should not be calling this method if our forms are not nonlinear");
  residual = 0.0;

  const mfem::BlockVector block_solution(const_cast<mfem::Vector &>(sol), _block_true_offsets);
  SetTrialVariablesFromTrueVectors(block_solution);

  mfem::BlockVector block_residual(residual, _block_true_offsets);
  for (unsigned int i = 0; i < _test_var_names.size(); i++)
  {
    auto & test_var_name = _test_var_names.at(i);
    auto nlf = _nlfs.GetShared(test_var_name);
    nlf->Mult(block_solution.GetBlock(i), block_residual.GetBlock(i));
    block_residual.GetBlock(i).SyncAliasMemory(block_residual);
  }
}

DeleteHBlocks()

void Moose::MFEM::EquationSystem::DeleteHBlocks ( )

protected

Deletes the HypreParMatrix associated with any pointer stored in _h_blocks, and then proceeds to delete all dynamically allocated memory for _h_blocks itself, resetting all dimensions to zero.

Definition at line 27 of file EquationSystem.C.

Referenced by Moose::MFEM::ComplexEquationSystem::FormSystemMatrix(), FormSystemMatrix(), and ~EquationSystem().

{
  for (const auto i : make_range(_h_blocks.NumRows()))
    for (const auto j : make_range(_h_blocks.NumCols()))
    {
      if (_jacobian_blocks.NumRows() && _jacobian_blocks(i, j) == _h_blocks(i, j))
        _jacobian_blocks(i, j) = nullptr;
      delete _h_blocks(i, j);
    }
  _h_blocks.DeleteAll();
}

DeleteJacobianBlocks()

void Moose::MFEM::EquationSystem::DeleteJacobianBlocks ( )

protected

Deletes the HypreParMatrix associated with any pointer stored in _jacobian_blocks, and then proceeds to delete all dynamically allocated memory for _jacobian_blocks itself, resetting all dimensions to zero.

Definition at line 40 of file EquationSystem.C.

Referenced by FormJacobianMatrix(), and ~EquationSystem().

{
  for (const auto i : make_range(_jacobian_blocks.NumRows()))
    for (const auto j : make_range(_jacobian_blocks.NumCols()))
      if (!_h_blocks.NumRows() || _jacobian_blocks(i, j) != _h_blocks(i, j))
        delete _jacobian_blocks(i, j);
  _jacobian_blocks.DeleteAll();
}

EliminateCoupledVariables()

void Moose::MFEM::EquationSystem::EliminateCoupledVariables ( )

protectedvirtual

Perform trivial eliminations of coupled variables lacking corresponding test variables.

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 246 of file EquationSystem.C.

Referenced by BuildLinearForms(), and Moose::MFEM::TimeDependentEquationSystem::EliminateCoupledVariables().

{
  for (const auto & test_var_name : _test_var_names)
    for (const auto & eliminated_var_name : _eliminated_var_names)
      if (_mblfs.Has(test_var_name) && _mblfs.Get(test_var_name)->Has(eliminated_var_name) &&
          !VectorContainsName(_test_var_names, eliminated_var_name))
      {
        auto & mblf = *_mblfs.Get(test_var_name)->Get(eliminated_var_name);
        mblf.AddMult(*_eliminated_variables.Get(eliminated_var_name), *_lfs.Get(test_var_name), -1);
      }
}

FormJacobianMatrix()

void Moose::MFEM::EquationSystem::FormJacobianMatrix ( const mfem::Vector &  u )

protected

Compute Jacobian matrix at the provided vector of true DoFs of trial variables.

Definition at line 419 of file EquationSystem.C.

Referenced by GetGradient().

{
  DeleteJacobianBlocks();
  _jacobian_blocks.SetSize(_test_var_names.size(), _trial_var_names.size());
  _jacobian_blocks = nullptr;

  const mfem::BlockVector update_vector(const_cast<mfem::Vector &>(u), _block_true_offsets);
  for (const auto i : index_range(_test_var_names))
  {
    auto test_var_name = _test_var_names.at(i);
    if (_nlfs.Has(test_var_name))
    {
      auto nlf = _nlfs.Get(test_var_name);
      mfem::HypreParMatrix * nlf_jac =
          dynamic_cast<mfem::HypreParMatrix *>(&nlf->GetGradient(update_vector.GetBlock(i)));
      mooseAssert(nlf_jac,
                  "Jacobian contribution of nonlinear form associated with " + test_var_name +
                      " is not castable into a HypreParMatrix");
      _jacobian_blocks(i, i) = mfem::ParAdd(_h_blocks(i, i), nlf_jac);
    }
    else
      _jacobian_blocks(i, i) = _h_blocks(i, i);
    for (const auto j : index_range(_trial_var_names))
      if (i != j) // nlf->GetGradient only contributes to on-diagonal blocks
        _jacobian_blocks(i, j) = _h_blocks(i, j);
  }
  // Create monolithic matrix
  _jacobian.Reset(mfem::HypreParMatrixFromBlocks(_jacobian_blocks));
}

FormLinearSystem()

void Moose::MFEM::EquationSystem::FormLinearSystem ( mfem::OperatorHandle &  op, mfem::BlockVector &  trueX, mfem::BlockVector &  trueRHS  )

protectedvirtual

Form linear components of system based on on- and off-diagonal bilinear form contributions, populate solution and RHS vectors of true DoFs, and apply constraints.

Definition at line 259 of file EquationSystem.C.

Referenced by FormSystem().

{
  mooseAssert(_test_var_names.size() == _trial_var_names.size(),
              "Number of test and trial variables must be the same for block matrix assembly.");

  if (_assembly_level == mfem::AssemblyLevel::LEGACY)
    FormSystemMatrix(op, trueX, trueRHS);
  else
    FormSystemOperator(op, trueX, trueRHS);
}

FormSystem()

void Moose::MFEM::EquationSystem::FormSystem	(	mfem::BlockVector &	trueX,
		mfem::BlockVector &	trueRHS
	)

Build all weak-form components via BuildEquationSystem(), form the constrained linear part of the system, and populate the true-DoF vectors used by the solve.

For nonlinear problems, nonlinear forms are registered here but are not folded into the assembled linear operator. Their residual action is evaluated by Mult(), and any Jacobian contribution is formed at the current nonlinear iterate by GetGradient().

This is the single public entry point for callers that want the equation system prepared for a solve. Subclasses customize the form-building step by overriding BuildEquationSystem().

Definition at line 367 of file EquationSystem.C.

Referenced by Moose::MFEM::TimeDependentEquationSystemProblemOperator::FormEquationSystemOperator(), and Moose::MFEM::EquationSystemProblemOperator::FormEquationSystemOperator().

{
  BuildEquationSystem();
  height = trueX.Size();
  width = trueRHS.Size();
  // Store block offsets
  _block_true_offsets.SetSize(trueX.NumBlocks() + 1);
  _block_true_offsets[0] = 0;
  for (unsigned i = 0; i < _trial_var_names.size(); i++)
    _block_true_offsets[i + 1] = trueX.BlockSize(i);
  _block_true_offsets.PartialSum();
  FormLinearSystem(_linear_operator, trueX, trueRHS);
}

FormSystemMatrix()

void Moose::MFEM::EquationSystem::FormSystemMatrix ( mfem::OperatorHandle &  op, mfem::BlockVector &  trueX, mfem::BlockVector &  trueRHS  )

protectedvirtual

Form matrix representation of linear components of system operator as a HypreParMatrix.

Used when EquationSystem assembly level is set to 'LEGACY'.

Reimplemented in Moose::MFEM::ComplexEquationSystem.

Definition at line 303 of file EquationSystem.C.

Referenced by FormLinearSystem().

{
  // Allocate block operator
  DeleteHBlocks();
  _h_blocks.SetSize(_test_var_names.size(), _trial_var_names.size());
  _h_blocks = nullptr;
  // Zero out RHS and sync memory
  trueRHS = 0.0;
  trueRHS.SyncToBlocks();

  for (const auto i : index_range(_test_var_names))
  {
    auto test_var_name = _test_var_names.at(i);

    for (const auto j : index_range(_trial_var_names))
    {
      auto trial_var_name = _trial_var_names.at(j);

      mfem::Vector aux_x, aux_rhs;
      mfem::ParLinearForm aux_lf(_test_pfespaces.at(i));
      mfem::HypreParMatrix * aux_a = new mfem::HypreParMatrix;

      if (test_var_name == trial_var_name)
      {
        mooseAssert(i == j, "Trial and test variables must have the same ordering.");
        auto blf = _blfs.Get(test_var_name);
        blf->FormLinearSystem(_ess_tdof_lists.at(j),
                              *_var_ess_constraints.at(j),
                              *_lfs.Get(test_var_name),
                              *aux_a,
                              aux_x,
                              aux_rhs,
                              /*copy_interior=*/true);
        trueX.GetBlock(j) = aux_x;
      }
      else if (_mblfs.Has(test_var_name) && _mblfs.Get(test_var_name)->Has(trial_var_name))
      {
        auto mblf = _mblfs.Get(test_var_name)->Get(trial_var_name);
        mblf->FormRectangularLinearSystem(_ess_tdof_lists.at(j),
                                          _ess_tdof_lists.at(i),
                                          *_var_ess_constraints.at(j),
                                          aux_lf = 0,
                                          *aux_a,
                                          aux_x,
                                          aux_rhs);
      }
      else
        continue;

      trueRHS.GetBlock(i) += aux_rhs;
      _h_blocks(i, j) = aux_a;
    }
  }
  // Sync memory
  trueX.SyncFromBlocks();
  trueRHS.SyncFromBlocks();

  // Create monolithic matrix
  op.Reset(mfem::HypreParMatrixFromBlocks(_h_blocks));
}

FormSystemOperator()

void Moose::MFEM::EquationSystem::FormSystemOperator ( mfem::OperatorHandle &  op, mfem::BlockVector &  trueX, mfem::BlockVector &  trueRHS  )

protectedvirtual

Form matrix-free representation of linear components of system operator.

Used when EquationSystem assembly level is set to 'FULL', 'ELEMENT', 'PARTIAL', or 'NONE'.

Reimplemented in Moose::MFEM::ComplexEquationSystem.

Definition at line 273 of file EquationSystem.C.

Referenced by FormLinearSystem().

{
  mooseAssert(_test_var_names.size() == 1 && _test_var_names.size() == _trial_var_names.size(),
              "Non-legacy assembly is only supported for single test and trial variable systems");

  auto & test_var_name = _test_var_names.at(0);
  mfem::Vector aux_x, aux_rhs;
  mfem::OperatorPtr aux_a;

  auto blf = _blfs.Get(test_var_name);
  blf->FormLinearSystem(_ess_tdof_lists.at(0),
                        *_var_ess_constraints.at(0),
                        *_lfs.Get(test_var_name),
                        aux_a,
                        aux_x,
                        aux_rhs,
                        /*copy_interior=*/true);

  trueX.GetBlock(0) = aux_x;
  trueRHS.GetBlock(0) = aux_rhs;
  trueX.SyncFromBlocks();
  trueRHS.SyncFromBlocks();

  op.Reset(aux_a.Ptr());
  aux_a.SetOperatorOwner(false);
}

GetBilinearForm()

mfem::ParBilinearForm& Moose::MFEM::EquationSystem::GetBilinearForm ( const std::string &  test_var_name )

inline

Returns

a reference to the MFEM ParBilinearForm corresponding to test_var_name

Definition at line 106 of file EquationSystem.h.

  {
    return _blfs.GetRef(test_var_name);
  }

GetBlockOffsets()

const mfem::Array<int>& Moose::MFEM::EquationSystem::GetBlockOffsets ( ) const

inline

Getter for block true offsets associated with the EquationSystem operator.

Definition at line 101 of file EquationSystem.h.

{ return _block_true_offsets; }

GetEssentialBoundaryMarkers()

mfem::Array< int > & Moose::MFEM::EquationSystem::GetEssentialBoundaryMarkers

(

const std::string &

var_name

)

Return the essential boundary attribute marker array for a given trial variable.

The returned array has size == pmesh.bdr_attributes.Max() with 1 at essential boundaries.

Definition at line 740 of file EquationSystem.C.

{
  for (const auto i : index_range(_trial_var_names))
    if (_trial_var_names.at(i) == var_name)
      return _ess_markers.at(i);

  mooseError("No essential boundary markers found for variable '", var_name, "'.");
}

GetGradient()

mfem::Operator & Moose::MFEM::EquationSystem::GetGradient ( const mfem::Vector &  u ) const

override

Get Jacobian at the provided vector of true DoFs of trial variables.

Definition at line 450 of file EquationSystem.C.

{
  _linearization_point = &u;

  if (_non_linear)
  {
    if (_assembly_level != mfem::AssemblyLevel::LEGACY)
      mooseError("MFEM nonlinear solvers that require GetGradient() currently require legacy "
                 "assembly in EquationSystem.");
    const_cast<EquationSystem *>(this)->FormJacobianMatrix(u);
  }
  else
    _jacobian = _linear_operator;

  return *_jacobian;
}

GetGridFunction()

mfem::ParGridFunction& Moose::MFEM::EquationSystem::GetGridFunction ( const std::string &  trial_var_name )

inline

Returns

a reference to the MFEM ParGridFunction corresponding to trial_var_name

Definition at line 114 of file EquationSystem.h.

  {
    return _gfuncs->GetRef(trial_var_name);
  }

GetLinearizationPoint()

const mfem::Vector & Moose::MFEM::EquationSystem::GetLinearizationPoint

(

)

const

The true-DoF vector used for the most recent Jacobian linearization.

Definition at line 708 of file EquationSystem.C.

{
  if (!_linearization_point)
    mooseError("EquationSystem::GetLinearizationPoint() called before GetGradient().");
  return *_linearization_point;
}

GetLinearOperator()

mfem::OperatorHandle& Moose::MFEM::EquationSystem::GetLinearOperator ( ) const

inline

Get operator handle for linear component of system operator.

Definition at line 80 of file EquationSystem.h.

{ return _linear_operator; };

GetTestVarNames()

const std::vector<std::string>& Moose::MFEM::EquationSystem::GetTestVarNames ( ) const

inline

Definition at line 98 of file EquationSystem.h.

Referenced by Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::SetGridFunctions(), and Moose::MFEM::EquationSystemProblemOperator::SetGridFunctions().

{ return _test_var_names; }

GetTrialVarNames()

const std::vector<std::string>& Moose::MFEM::EquationSystem::GetTrialVarNames ( ) const

inline

Definition at line 97 of file EquationSystem.h.

Referenced by Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::SetGridFunctions(), and Moose::MFEM::EquationSystemProblemOperator::SetGridFunctions().

{ return _trial_var_names; }

Init()

void Moose::MFEM::EquationSystem::Init ( GridFunctions &  gridfunctions, ComplexGridFunctions &  cmplx_gridfunctions, mfem::AssemblyLevel  assembly_level  )

virtual

Initialise.

Reimplemented in Moose::MFEM::ComplexEquationSystem.

Definition at line 153 of file EquationSystem.C.

{
  _assembly_level = assembly_level;

  // Extract which coupled variables are to be trivially eliminated and which are trial variables
  SetTrialVariableNames();

  for (auto & test_var_name : _test_var_names)
  {
    if (!gridfunctions.Has(test_var_name))
    {
      mooseError("MFEM variable ",
                 test_var_name,
                 " requested by equation system during initialization was "
                 "not found in gridfunctions");
    }
    // Store pointers to test FESpaces
    _test_pfespaces.push_back(gridfunctions.Get(test_var_name)->ParFESpace());
  }

  for (auto & trial_var_name : _trial_var_names)
  {
    if (!gridfunctions.Has(trial_var_name))
    {
      mooseError("MFEM variable ",
                 trial_var_name,
                 " requested by equation system during initialization was "
                 "not found in gridfunctions");
    }
    // Create auxiliary gridfunctions for storing essential constraints from Dirichlet conditions
    _var_ess_constraints.emplace_back(
        std::make_unique<mfem::ParGridFunction>(gridfunctions.Get(trial_var_name)->ParFESpace()));
  }

  // Store pointers to FESpaces of all coupled variables
  for (auto & coupled_var_name : _coupled_var_names)
    _coupled_pfespaces.push_back(gridfunctions.Get(coupled_var_name)->ParFESpace());

  // Store pointers to coupled variable GridFunctions that are to be eliminated prior to forming the
  // jacobian
  for (auto & eliminated_var_name : _eliminated_var_names)
    _eliminated_variables.Register(eliminated_var_name,
                                   gridfunctions.GetShared(eliminated_var_name));

  // Get a reference to the GridFunctions
  _gfuncs = &gridfunctions;
}

IsComplex()

virtual bool Moose::MFEM::EquationSystem::IsComplex ( ) const

inlinevirtual

Returns

Whether this EquationSystem includes complex components

Reimplemented in Moose::MFEM::ComplexEquationSystem.

Definition at line 152 of file EquationSystem.h.

{ return false; }

IsEigen()

virtual bool Moose::MFEM::EquationSystem::IsEigen ( ) const

inlinevirtual

Returns

Whether this EquationSystem represents an eigenproblem

Reimplemented in Moose::MFEM::EigenproblemEquationSystem.

Definition at line 154 of file EquationSystem.h.

{ return false; }

IsMultivariate()

bool Moose::MFEM::EquationSystem::IsMultivariate ( ) const

inline

Returns

Whether this is a multivariate (maybe mixed) equation system

Definition at line 158 of file EquationSystem.h.

{ return _test_var_names.size() > 1; }

IsNonlinear()

bool Moose::MFEM::EquationSystem::IsNonlinear ( ) const

inline

Returns

Whether nonlinear integrators are present in the equation system

Definition at line 160 of file EquationSystem.h.

{ return _non_linear; }

IsTimeDependent()

virtual bool Moose::MFEM::EquationSystem::IsTimeDependent ( ) const

inlinevirtual

Returns

Whether this EquationSystem has time-dependent components

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 156 of file EquationSystem.h.

{ return false; }

Mult()

void Moose::MFEM::EquationSystem::Mult ( const mfem::Vector &  u, mfem::Vector &  residual  ) const

override

Compute residual y = Mu.

Definition at line 382 of file EquationSystem.C.

{
  if (_non_linear)
  {
    ComputeNonlinearResidual(sol, residual);
    _linear_operator->AddMult(sol, residual);
  }
  else
  {
    residual = 0.0;
    _linear_operator->Mult(sol, residual);
  }

  sol.HostRead();
  residual.HostRead();
}

Nonlinear()

bool Moose::MFEM::EquationSystem::Nonlinear ( ) const

inline

Returns

Whether nonlinear integrators are present

Definition at line 122 of file EquationSystem.h.

{ return _non_linear; }

SetCoefficientManager()

void Moose::MFEM::EquationSystem::SetCoefficientManager ( CoefficientManager &  coefficients )

inline

Set the coefficient manager to notify when trial variables are updated, so that stored projections of solution-dependent coefficients are invalidated.

Definition at line 90 of file EquationSystem.h.

  {
    _coefficient_manager = &coefficients;
  }

SetGradientRequired()

void Moose::MFEM::EquationSystem::SetGradientRequired ( bool  requires_gradient )

inline

Set whether an external object (such as a nonlinear solver) requires Jacobian information for this EquationSystem.

Definition at line 86 of file EquationSystem.h.

{ _gradient_required = requires_gradient; }

SetTrialVariableNames()

void Moose::MFEM::EquationSystem::SetTrialVariableNames ( )

protectedvirtual

Set trial variable names from subset of coupled variables that have an associated test variable.

Definition at line 78 of file EquationSystem.C.

Referenced by Moose::MFEM::ComplexEquationSystem::Init(), and Init().

{
  // If a coupled variable has an equation associated with it,
  // add it to the set of trial variables.
  for (const auto & test_var_name : _test_var_names)
    if (VectorContainsName(_coupled_var_names, test_var_name))
      _trial_var_names.push_back(test_var_name);

  // Otherwise, add it to the set of eliminated variables.
  for (const auto & coupled_var_name : _coupled_var_names)
    if (!VectorContainsName(_test_var_names, coupled_var_name))
      _eliminated_var_names.push_back(coupled_var_name);
}

SetTrialVariablesFromTrueVectors()

void Moose::MFEM::EquationSystem::SetTrialVariablesFromTrueVectors ( const mfem::BlockVector &  trueX ) const

virtual

Update variable from solution vector after solve.

Reimplemented in Moose::MFEM::ComplexEquationSystem.

Definition at line 468 of file EquationSystem.C.

Referenced by ComputeNonlinearResidual().

{
  for (const auto i : index_range(_trial_var_names))
  {
    auto & trial_var_name = _trial_var_names.at(i);
    trueX.GetBlock(i).SyncMemory(trueX);
    _gfuncs->Get(trial_var_name)->Distribute(&(trueX.GetBlock(i)));
  }
  // Solution variables changed: stored projections of solution-dependent coefficients are stale.
  if (_coefficient_manager)
    _coefficient_manager->markSolutionChanged();
}

VectorContainsName()

bool Moose::MFEM::EquationSystem::VectorContainsName ( const std::vector< std::string > &  the_vector, const std::string &  name  ) const

protected

Definition at line 50 of file EquationSystem.C.

Referenced by AddCoupledVariableNameIfMissing(), AddEliminatedVariableNameIfMissing(), AddTestVariableNameIfMissing(), EliminateCoupledVariables(), and SetTrialVariableNames().

{
  return std::find(the_vector.begin(), the_vector.end(), name) != the_vector.end();
}

Member Data Documentation

_assembly_level

mfem::AssemblyLevel Moose::MFEM::EquationSystem::_assembly_level

protected

Definition at line 334 of file EquationSystem.h.

Referenced by Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), Moose::MFEM::ComplexEquationSystem::BuildBilinearForms(), BuildBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildMixedBilinearForms(), FormLinearSystem(), GetGradient(), Moose::MFEM::ComplexEquationSystem::Init(), and Init().

_blfs

NamedFieldsMap<mfem::ParBilinearForm> Moose::MFEM::EquationSystem::_blfs

protected

Definition at line 309 of file EquationSystem.h.

Referenced by Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), BuildBilinearForms(), Moose::MFEM::EigenproblemEquationSystem::FormEigenproblemMatrix(), FormSystemMatrix(), FormSystemOperator(), and GetBilinearForm().

_block_true_offsets

mfem::Array<int> Moose::MFEM::EquationSystem::_block_true_offsets

protected

Definition at line 339 of file EquationSystem.h.

Referenced by ComputeNonlinearResidual(), FormJacobianMatrix(), FormSystem(), and GetBlockOffsets().

_coefficient_manager

CoefficientManager* Moose::MFEM::EquationSystem::_coefficient_manager = nullptr

protected

Definition at line 348 of file EquationSystem.h.

Referenced by SetCoefficientManager(), Moose::MFEM::ComplexEquationSystem::SetTrialVariablesFromTrueVectors(), and SetTrialVariablesFromTrueVectors().

_coupled_pfespaces

std::vector<mfem::ParFiniteElementSpace *> Moose::MFEM::EquationSystem::_coupled_pfespaces

protected

Pointers to finite element spaces associated with coupled variables.

Definition at line 306 of file EquationSystem.h.

Referenced by Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildMixedBilinearForms(), Moose::MFEM::ComplexEquationSystem::Init(), and Init().

_coupled_var_names

std::vector<std::string> Moose::MFEM::EquationSystem::_coupled_var_names

protected

Names of all trial variables of kernels and boundary conditions added to this EquationSystem.

Definition at line 292 of file EquationSystem.h.

Referenced by AddCoupledVariableNameIfMissing(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildMixedBilinearForms(), Moose::MFEM::ComplexEquationSystem::Init(), Init(), and SetTrialVariableNames().

_eliminated_var_names

std::vector<std::string> Moose::MFEM::EquationSystem::_eliminated_var_names

protected

Names of all coupled variables without a corresponding test variable.

Definition at line 298 of file EquationSystem.h.

Referenced by AddEliminatedVariableNameIfMissing(), Moose::MFEM::TimeDependentEquationSystem::EliminateCoupledVariables(), EliminateCoupledVariables(), Moose::MFEM::ComplexEquationSystem::Init(), Init(), and SetTrialVariableNames().

_eliminated_variables

Moose::MFEM::GridFunctions Moose::MFEM::EquationSystem::_eliminated_variables

protected

Pointers to coupled variables not part of the reduced EquationSystem.

Definition at line 300 of file EquationSystem.h.

Referenced by Moose::MFEM::TimeDependentEquationSystem::EliminateCoupledVariables(), EliminateCoupledVariables(), and Init().

_ess_markers

std::vector<mfem::Array<int> > Moose::MFEM::EquationSystem::_ess_markers

protected

Definition at line 317 of file EquationSystem.h.

Referenced by Moose::MFEM::EigenproblemEquationSystem::ApplyEssentialBCs(), Moose::MFEM::ComplexEquationSystem::ApplyEssentialBCs(), ApplyEssentialBCs(), Moose::MFEM::EigenproblemEquationSystem::FormEigenproblemMatrix(), Moose::MFEM::EigenproblemEquationSystem::FormMassMatrix(), and GetEssentialBoundaryMarkers().

_ess_tdof_lists

std::vector<mfem::Array<int> > Moose::MFEM::EquationSystem::_ess_tdof_lists

protected

Definition at line 316 of file EquationSystem.h.

Referenced by Moose::MFEM::EigenproblemEquationSystem::ApplyEssentialBCs(), Moose::MFEM::ComplexEquationSystem::ApplyEssentialBCs(), ApplyEssentialBCs(), Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), BuildNonlinearForms(), Moose::MFEM::ComplexEquationSystem::FormSystemMatrix(), FormSystemMatrix(), Moose::MFEM::ComplexEquationSystem::FormSystemOperator(), and FormSystemOperator().

_essential_bc_map

NamedFieldsMap<std::vector<std::shared_ptr<MFEMEssentialBC> > > Moose::MFEM::EquationSystem::_essential_bc_map

protected

Arrays to store essential BCs to act on each component of weak form.

Named according to test variable.

Definition at line 328 of file EquationSystem.h.

Referenced by AddEssentialBC(), and ApplyEssentialBC().

_gfuncs

Moose::MFEM::GridFunctions* Moose::MFEM::EquationSystem::_gfuncs

protected

Definition at line 337 of file EquationSystem.h.

Referenced by Moose::MFEM::EigenproblemEquationSystem::ApplyEssentialBCs(), ApplyEssentialBCs(), GetGridFunction(), Init(), and SetTrialVariablesFromTrueVectors().

_gradient_required

bool Moose::MFEM::EquationSystem::_gradient_required = false

protected

Definition at line 345 of file EquationSystem.h.

Referenced by ApplyBoundaryNLFIntegrators(), ApplyDomainNLFIntegrators(), and SetGradientRequired().

_h_blocks

mfem::Array2D<const mfem::HypreParMatrix *> Moose::MFEM::EquationSystem::_h_blocks

protected

Definition at line 319 of file EquationSystem.h.

Referenced by DeleteHBlocks(), DeleteJacobianBlocks(), FormJacobianMatrix(), Moose::MFEM::ComplexEquationSystem::FormSystemMatrix(), and FormSystemMatrix().

_integrated_bc_map

NamedFieldsMap<NamedFieldsMap<std::vector<std::shared_ptr<MFEMIntegratedBC> > > > Moose::MFEM::EquationSystem::_integrated_bc_map

protected

Arrays to store integrated BCs to act on each component of weak form.

Named according to test and trial variables.

Definition at line 325 of file EquationSystem.h.

Referenced by AddIntegratedBC(), BuildBilinearFormForFESpace(), Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), BuildBilinearForms(), BuildLinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildNonlinearFormForFESpace(), Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), and BuildNonlinearForms().

_jacobian

mfem::OperatorHandle Moose::MFEM::EquationSystem::_jacobian

mutableprotected

Definition at line 331 of file EquationSystem.h.

Referenced by Moose::MFEM::EigenproblemEquationSystem::FormEigenproblemMatrix(), FormJacobianMatrix(), GetGradient(), and Moose::MFEM::EigenproblemEquationSystem::PrepareEigensolver().

_jacobian_blocks

mfem::Array2D<const mfem::HypreParMatrix *> Moose::MFEM::EquationSystem::_jacobian_blocks

protected

Definition at line 319 of file EquationSystem.h.

Referenced by DeleteHBlocks(), DeleteJacobianBlocks(), and FormJacobianMatrix().

_kernels_map

NamedFieldsMap<NamedFieldsMap<std::vector<std::shared_ptr<MFEMKernel> > > > Moose::MFEM::EquationSystem::_kernels_map

protected

Arrays to store kernels to act on each component of weak form.

Named according to test and trial variables.

Definition at line 322 of file EquationSystem.h.

Referenced by AddKernel(), BuildBilinearFormForFESpace(), Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), BuildBilinearForms(), BuildLinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildMixedBilinearForms(), BuildNonlinearFormForFESpace(), Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), and BuildNonlinearForms().

_lfs

NamedFieldsMap<mfem::ParLinearForm> Moose::MFEM::EquationSystem::_lfs

protected

Definition at line 310 of file EquationSystem.h.

Referenced by BuildLinearForms(), Moose::MFEM::TimeDependentEquationSystem::EliminateCoupledVariables(), EliminateCoupledVariables(), FormSystemMatrix(), and FormSystemOperator().

_linear_operator

mfem::OperatorHandle Moose::MFEM::EquationSystem::_linear_operator

mutableprotected

Definition at line 333 of file EquationSystem.h.

Referenced by FormSystem(), GetGradient(), GetLinearOperator(), Moose::MFEM::ComplexEquationSystem::Mult(), and Mult().

_linearization_point

const mfem::Vector* Moose::MFEM::EquationSystem::_linearization_point = nullptr

mutableprotected

Definition at line 341 of file EquationSystem.h.

Referenced by GetGradient(), and GetLinearizationPoint().

_mblfs

NamedFieldsMap<NamedFieldsMap<mfem::ParMixedBilinearForm> > Moose::MFEM::EquationSystem::_mblfs

protected

Definition at line 312 of file EquationSystem.h.

Referenced by Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildMixedBilinearForms(), EliminateCoupledVariables(), and FormSystemMatrix().

_nlfs

NamedFieldsMap<mfem::ParNonlinearForm> Moose::MFEM::EquationSystem::_nlfs

protected

Definition at line 311 of file EquationSystem.h.

Referenced by Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), BuildNonlinearForms(), ComputeNonlinearResidual(), and FormJacobianMatrix().

_non_linear

bool Moose::MFEM::EquationSystem::_non_linear = false

protected

Definition at line 343 of file EquationSystem.h.

Referenced by ApplyBoundaryNLFIntegrators(), ApplyDomainNLFIntegrators(), ComputeNonlinearResidual(), GetGradient(), IsNonlinear(), Mult(), and Nonlinear().

_test_pfespaces

std::vector<mfem::ParFiniteElementSpace *> Moose::MFEM::EquationSystem::_test_pfespaces

protected

Pointers to finite element spaces associated with test variables.

Definition at line 304 of file EquationSystem.h.

Referenced by Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), Moose::MFEM::ComplexEquationSystem::BuildBilinearForms(), BuildBilinearForms(), Moose::MFEM::ComplexEquationSystem::BuildLinearForms(), BuildLinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildMixedBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), BuildNonlinearForms(), Moose::MFEM::EigenproblemEquationSystem::FormMassMatrix(), FormSystemMatrix(), Moose::MFEM::ComplexEquationSystem::Init(), and Init().

_test_var_names

std::vector<std::string> Moose::MFEM::EquationSystem::_test_var_names

protected

Names of all test variables corresponding to linear forms in this equation system.

Definition at line 302 of file EquationSystem.h.

Referenced by AddTestVariableNameIfMissing(), Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), Moose::MFEM::ComplexEquationSystem::BuildBilinearForms(), BuildBilinearForms(), Moose::MFEM::EigenproblemEquationSystem::BuildEigenproblemJacobian(), Moose::MFEM::ComplexEquationSystem::BuildLinearForms(), BuildLinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), BuildMixedBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildNonlinearForms(), BuildNonlinearForms(), ComputeNonlinearResidual(), Moose::MFEM::TimeDependentEquationSystem::EliminateCoupledVariables(), EliminateCoupledVariables(), Moose::MFEM::EigenproblemEquationSystem::FormEigenproblemMatrix(), FormJacobianMatrix(), FormLinearSystem(), Moose::MFEM::ComplexEquationSystem::FormSystemMatrix(), FormSystemMatrix(), Moose::MFEM::ComplexEquationSystem::FormSystemOperator(), FormSystemOperator(), GetTestVarNames(), Moose::MFEM::ComplexEquationSystem::Init(), Init(), IsMultivariate(), and SetTrialVariableNames().

_trial_var_names

std::vector<std::string> Moose::MFEM::EquationSystem::_trial_var_names

protected

Subset of _coupled_var_names of all variables corresponding to gridfunctions with degrees of freedom that comprise the state vector of this EquationSystem.

This will differ from _coupled_var_names when time derivatives or other eliminated variables are present.

Definition at line 296 of file EquationSystem.h.

Referenced by Moose::MFEM::EigenproblemEquationSystem::ApplyEssentialBCs(), Moose::MFEM::ComplexEquationSystem::ApplyEssentialBCs(), ApplyEssentialBCs(), Moose::MFEM::EigenproblemEquationSystem::BuildEigenproblemJacobian(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), FormJacobianMatrix(), FormLinearSystem(), FormSystem(), Moose::MFEM::ComplexEquationSystem::FormSystemMatrix(), FormSystemMatrix(), FormSystemOperator(), GetEssentialBoundaryMarkers(), GetTrialVarNames(), Init(), SetTrialVariableNames(), Moose::MFEM::ComplexEquationSystem::SetTrialVariablesFromTrueVectors(), and SetTrialVariablesFromTrueVectors().

_var_ess_constraints

std::vector<std::unique_ptr<mfem::ParGridFunction> > Moose::MFEM::EquationSystem::_var_ess_constraints

protected

Gridfunctions holding essential constraints from Dirichlet BCs.

Definition at line 315 of file EquationSystem.h.

Referenced by Moose::MFEM::EigenproblemEquationSystem::ApplyEssentialBCs(), ApplyEssentialBCs(), FormSystemMatrix(), FormSystemOperator(), and Init().

---

The documentation for this class was generated from the following files:

• include/mfem/equation_systems/EquationSystem.h
• src/mfem/equation_systems/EquationSystem.C