Moose::MFEM::EquationSystem Class Reference

Class to store weak form components (bilinear and linear forms, and optionally mixed and nonlinear forms) and build methods. More...

#include <EquationSystem.h>

Inheritance diagram for Moose::MFEM::EquationSystem:

Public Member Functions
	EquationSystem ()=default
	~EquationSystem () override
virtual void	AddTestVariableNameIfMissing (const std::string &test_var_name)
	Add test variable to EquationSystem. More...
virtual void	AddCoupledVariableNameIfMissing (const std::string &coupled_var_name)
	Add coupled variable to EquationSystem. More...
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 (Moose::MFEM::GridFunctions &gridfunctions, mfem::AssemblyLevel assembly_level)
	Initialise. More...
virtual void	BuildLinearForms ()
	Build linear forms and eliminate constrained DoFs. More...
virtual void	ApplyEssentialBC (const std::string &test_var_name, mfem::ParGridFunction &trial_gf, mfem::Array< int > &global_ess_markers)
	Apply essential BC(s) associated with test_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	BuildBilinearForms ()
	Build bilinear forms (diagonal Jacobian contributions) More...
virtual void	BuildMixedBilinearForms ()
	Build mixed bilinear forms (off-diagonal Jacobian contributions) More...
virtual void	BuildEquationSystem ()
	Build all forms comprising this EquationSystem. More...
void	AssembleJacobian (Moose::MFEM::NamedFieldsMap< mfem::ParBilinearForm > &jac_blfs, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< mfem::ParMixedBilinearForm >> &jac_mblfs, Moose::MFEM::NamedFieldsMap< mfem::ParLinearForm > &rhs_lfs, std::vector< mfem::Array< int >> &ess_tdof_lists, std::vector< std::unique_ptr< mfem::ParGridFunction >> &var_ess_constraints, mfem::OperatorHandle &op, mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
	Form Jacobian operator based on on- and off-diagonal bilinear form contributions, populate solution and RHS vectors of true DoFs, and apply constraints. More...
virtual void	FormLinearSystem (mfem::OperatorHandle &op, mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
	Form linear system, with essential boundary conditions accounted for. More...
virtual void	FormSystem (mfem::OperatorHandle &op, mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
virtual void	FormLegacySystem (mfem::OperatorHandle &op, mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
virtual void	BuildJacobian (mfem::BlockVector &trueX, mfem::BlockVector &trueRHS)
	Build linear system, with essential boundary conditions accounted for. More...
void	Mult (const mfem::Vector &u, mfem::Vector &residual) const override
	Compute residual y = Mu. More...
mfem::Operator &	GetGradient (const mfem::Vector &u) const override
	Compute J = M + grad_H(u) More...
virtual void	RecoverFEMSolution (mfem::BlockVector &trueX, Moose::MFEM::GridFunctions &gridfunctions)
	Update variable from solution vector after solve. More...
const std::vector< std::string > &	TrialVarNames () const
const std::vector< std::string > &	TestVarNames () const

Public Attributes
std::vector< mfem::Array< int > >	_ess_tdof_lists

Protected Member Functions
void	DeleteAllBlocks ()
	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...
bool	VectorContainsName (const std::vector< std::string > &the_vector, const std::string &name) const
template<class FormType >
void	ApplyDomainBLFIntegrators (const std::string &trial_var_name, const std::string &test_var_name, std::shared_ptr< FormType > form, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &kernels_map)
	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, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &kernels_map)
template<class FormType >
void	ApplyBoundaryBLFIntegrators (const std::string &trial_var_name, const std::string &test_var_name, std::shared_ptr< FormType > form, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &integrated_bc_map)
void	ApplyBoundaryLFIntegrators (const std::string &test_var_name, std::shared_ptr< mfem::ParLinearForm > form, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &integrated_bc_map)

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...
Moose::MFEM::NamedFieldsMap< mfem::ParBilinearForm >	_blfs
Moose::MFEM::NamedFieldsMap< mfem::ParLinearForm >	_lfs
Moose::MFEM::NamedFieldsMap< mfem::ParNonlinearForm >	_nlfs
Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< mfem::ParMixedBilinearForm > >	_mblfs
std::vector< std::unique_ptr< mfem::ParGridFunction > >	_var_ess_constraints
	Gridfunctions holding essential constraints from Dirichlet BCs. More...
mfem::Array2D< const mfem::HypreParMatrix * >	_h_blocks
Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel > > > >	_kernels_map
	Arrays to store kernels to act on each component of weak form. More...
Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC > > > >	_integrated_bc_map
	Arrays to store integrated BCs to act on each component of weak form. More...
Moose::MFEM::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::AssemblyLevel	_assembly_level

Private Member Functions
virtual void	SetTrialVariableNames ()
	Set trial variable names from subset of coupled variables that have an associated test variable. More...

Friends
class	EquationSystemProblemOperator
class	TimeDomainEquationSystemProblemOperator

Detailed Description

Class to store weak form components (bilinear and linear forms, and optionally mixed and nonlinear forms) and build methods.

Definition at line 30 of file EquationSystem.h.

Constructor & Destructor Documentation

EquationSystem()

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

default

~EquationSystem()

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

override

Definition at line 18 of file EquationSystem.C.

{ DeleteAllBlocks(); }

Member Function Documentation

AddCoupledVariableNameIfMissing()

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

virtual

Add coupled variable to EquationSystem.

Definition at line 38 of file EquationSystem.C.

Referenced by AddIntegratedBC(), AddKernel(), Moose::MFEM::TimeDependentEquationSystem::AddKernel(), and Moose::MFEM::TimeDependentEquationSystem::SetTrialVariableNames().

{
  if (!VectorContainsName(_coupled_var_names, coupled_var_name))
    _coupled_var_names.push_back(coupled_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 112 of file EquationSystem.C.

{
  auto test_var_name = bc->getTestVariableName();
  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 89 of file EquationSystem.C.

{
  AddTestVariableNameIfMissing(bc->getTestVariableName());
  AddCoupledVariableNameIfMissing(bc->getTrialVariableName());
  auto trial_var_name = bc->getTrialVariableName();
  auto test_var_name = bc->getTestVariableName();
  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 66 of file EquationSystem.C.

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

{
  AddTestVariableNameIfMissing(kernel->getTestVariableName());
  AddCoupledVariableNameIfMissing(kernel->getTrialVariableName());
  auto trial_var_name = kernel->getTrialVariableName();
  auto test_var_name = kernel->getTestVariableName();
  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 )

virtual

Add test variable to EquationSystem.

Definition at line 45 of file EquationSystem.C.

Referenced by AddIntegratedBC(), AddKernel(), and Moose::MFEM::TimeDependentEquationSystem::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, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &  integrated_bc_map  )

protected

Definition at line 269 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 != nullptr)
      {
        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, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMIntegratedBC >>>> &  integrated_bc_map  )

inlineprotected

Definition at line 295 of file EquationSystem.h.

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 != nullptr)
      {
        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, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &  kernels_map  )

protected

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

Definition at line 221 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 != nullptr)
      {
        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, Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< std::vector< std::shared_ptr< MFEMKernel >>>> &  kernels_map  )

inlineprotected

Definition at line 245 of file EquationSystem.h.

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 != nullptr)
      {
        kernel->isSubdomainRestricted()
            ? form->AddDomainIntegrator(std::move(integ), kernel->getSubdomainMarkers())
            : form->AddDomainIntegrator(std::move(integ));
      }
    }
  }
}

ApplyEssentialBC()

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

virtual

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

Definition at line 159 of file EquationSystem.C.

Referenced by ApplyEssentialBCs(), and Moose::MFEM::TimeDependentEquationSystem::ApplyEssentialBCs().

{
  if (_essential_bc_map.Has(var_name))
  {
    auto & bcs = _essential_bc_map.GetRef(var_name);
    for (auto & bc : bcs)
    {
      // 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 (auto it = 0; it != trial_gf.ParFESpace()->GetParMesh()->bdr_attributes.Max(); ++it)
        global_ess_markers[it] = std::max(global_ess_markers[it], ess_bdrs[it]);
    }
  }
}

ApplyEssentialBCs()

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

virtual

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

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 180 of file EquationSystem.C.

Referenced by BuildLinearForms().

{
  _ess_tdof_lists.resize(_test_var_names.size());
  for (const auto i : index_range(_test_var_names))
  {
    const auto & test_var_name = _test_var_names.at(i);
    mfem::ParGridFunction & trial_gf = *(_var_ess_constraints.at(i));
    mfem::Array<int> global_ess_markers(trial_gf.ParFESpace()->GetParMesh()->bdr_attributes.Max());
    global_ess_markers = 0;
    // Set strongly constrained DoFs of trial_gf on essential boundaries and add markers for all
    // essential boundaries to the global_ess_markers array
    ApplyEssentialBC(test_var_name, trial_gf, global_ess_markers);
    trial_gf.ParFESpace()->GetEssentialTrueDofs(global_ess_markers, _ess_tdof_lists.at(i));
  }
}

AssembleJacobian()

void Moose::MFEM::EquationSystem::AssembleJacobian	(	Moose::MFEM::NamedFieldsMap< mfem::ParBilinearForm > &	jac_blfs,
		Moose::MFEM::NamedFieldsMap< Moose::MFEM::NamedFieldsMap< mfem::ParMixedBilinearForm >> &	jac_mblfs,
		Moose::MFEM::NamedFieldsMap< mfem::ParLinearForm > &	rhs_lfs,
		std::vector< mfem::Array< int >> &	ess_tdof_lists,
		std::vector< std::unique_ptr< mfem::ParGridFunction >> &	var_ess_constraints,
		mfem::OperatorHandle &	op,
		mfem::BlockVector &	trueX,
		mfem::BlockVector &	trueRHS
	)

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

Definition at line 261 of file EquationSystem.C.

Referenced by FormLegacySystem(), and Moose::MFEM::TimeDependentEquationSystem::FormLegacySystem().

{
  // Allocate block operator
  DeleteAllBlocks();
  _h_blocks.SetSize(_test_var_names.size(), _test_var_names.size());
  // Form diagonal blocks.
  for (const auto i : index_range(_test_var_names))
  {
    auto & test_var_name = _test_var_names.at(i);
    auto blf = jac_blfs.Get(test_var_name);
    auto lf = rhs_lfs.Get(test_var_name);
    mfem::Vector aux_x, aux_rhs;
    mfem::HypreParMatrix * aux_a = new mfem::HypreParMatrix;
    blf->FormLinearSystem(
        ess_tdof_lists.at(i), *(var_ess_constraints.at(i)), *lf, *aux_a, aux_x, aux_rhs);
    _h_blocks(i, i) = aux_a;
    trueX.GetBlock(i) = aux_x;
    trueRHS.GetBlock(i) = aux_rhs;
  }

  // Form off-diagonal blocks
  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));
      aux_lf = 0.0;
      if (jac_mblfs.Has(test_var_name) && jac_mblfs.Get(test_var_name)->Has(trial_var_name))
      {
        auto mblf = jac_mblfs.Get(test_var_name)->Get(trial_var_name);
        mfem::HypreParMatrix * aux_a = new mfem::HypreParMatrix;
        mblf->FormRectangularLinearSystem(ess_tdof_lists.at(j),
                                          ess_tdof_lists.at(i),
                                          *(var_ess_constraints.at(j)),
                                          aux_lf,
                                          *aux_a,
                                          aux_x,
                                          aux_rhs);
        _h_blocks(i, j) = aux_a;
        trueRHS.GetBlock(i) += aux_rhs;
      }
    }
  }
  // Sync memory
  trueX.SyncFromBlocks();
  trueRHS.SyncFromBlocks();

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

BuildBilinearForms()

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

virtual

Build bilinear forms (diagonal Jacobian contributions)

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 395 of file EquationSystem.C.

Referenced by Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), and 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.

Definition at line 457 of file EquationSystem.C.

Referenced by Moose::MFEM::EquationSystemProblemOperator::Init(), Moose::MFEM::TimeDomainEquationSystemProblemOperator::Init(), and Moose::MFEM::TimeDependentEquationSystem::UpdateEquationSystem().

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

BuildJacobian()

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

virtual

Build linear system, with essential boundary conditions accounted for.

Definition at line 334 of file EquationSystem.C.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::BuildEquationSystemOperator(), and Moose::MFEM::EquationSystemProblemOperator::Solve().

{
  height = trueX.Size();
  width = trueRHS.Size();
  FormLinearSystem(_jacobian, trueX, trueRHS);
}

BuildLinearForms()

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

virtual

Build linear forms and eliminate constrained DoFs.

Definition at line 368 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 ( )

virtual

Build mixed bilinear forms (off-diagonal Jacobian contributions)

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 416 of file EquationSystem.C.

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

{
  // 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);
  }
}

DeleteAllBlocks()

void Moose::MFEM::EquationSystem::DeleteAllBlocks ( )

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 21 of file EquationSystem.C.

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

{
  for (const auto i : make_range(_h_blocks.NumRows()))
    for (const auto j : make_range(_h_blocks.NumCols()))
      delete _h_blocks(i, j);
  _h_blocks.DeleteAll();
}

EliminateCoupledVariables()

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

virtual

Perform trivial eliminations of coupled variables lacking corresponding test variables.

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 197 of file EquationSystem.C.

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

{
  for (const auto & test_var_name : _test_var_names)
  {
    auto lf = _lfs.Get(test_var_name);
    for (const auto & eliminated_var_name : _eliminated_var_names)
    {
      if (_mblfs.Has(test_var_name) && _mblfs.Get(test_var_name)->Has(eliminated_var_name))
      {
        auto mblf = _mblfs.Get(test_var_name)->Get(eliminated_var_name);
        // The AddMult method in mfem::BilinearForm is not defined for non-legacy assembly
        mfem::Vector lf_prev(lf->Size());
        mblf->Mult(*_eliminated_variables.Get(eliminated_var_name), lf_prev);
        *lf -= lf_prev;
      }
    }
  }
}

FormLegacySystem()

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

virtual

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 326 of file EquationSystem.C.

Referenced by FormLinearSystem().

{
  AssembleJacobian(_blfs, _mblfs, _lfs, _ess_tdof_lists, _var_ess_constraints, op, trueX, trueRHS);
}

FormLinearSystem()

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

virtual

Form linear system, with essential boundary conditions accounted for.

Definition at line 217 of file EquationSystem.C.

Referenced by BuildJacobian().

{

  switch (_assembly_level)
  {
    case mfem::AssemblyLevel::LEGACY:
      FormLegacySystem(op, trueX, trueRHS);
      break;
    default:
      mooseAssert(_test_var_names.size() == 1,
                  "Non-legacy assembly is only supported for single-variable systems");
      mooseAssert(
          _test_var_names.size() == _trial_var_names.size(),
          "Non-legacy assembly is only supported for single test and trial variable systems");
      FormSystem(op, trueX, trueRHS);
  }
}

FormSystem()

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

virtual

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 238 of file EquationSystem.C.

Referenced by FormLinearSystem().

{
  auto & test_var_name = _test_var_names.at(0);
  auto blf = _blfs.Get(test_var_name);
  auto lf = _lfs.Get(test_var_name);
  mfem::BlockVector aux_x, aux_rhs;
  mfem::OperatorPtr aux_a;

  blf->FormLinearSystem(
      _ess_tdof_lists.at(0), *(_var_ess_constraints.at(0)), *lf, aux_a, aux_x, aux_rhs);

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

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

GetGradient()

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

override

Compute J = M + grad_H(u)

Definition at line 350 of file EquationSystem.C.

{
  return *_jacobian;
}

Init()

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

virtual

Initialise.

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 124 of file EquationSystem.C.

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

{
  _assembly_level = assembly_level;

  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 initialisation was "
                 "not found in gridfunctions");
    }
    // Store pointers to test FESpaces
    _test_pfespaces.push_back(gridfunctions.Get(test_var_name)->ParFESpace());
    // Create auxiliary gridfunctions for storing essential constraints from Dirichlet conditions
    _var_ess_constraints.emplace_back(
        std::make_unique<mfem::ParGridFunction>(gridfunctions.Get(test_var_name)->ParFESpace()));
  }

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

  // 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));
}

Mult()

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

override

Compute residual y = Mu.

Definition at line 342 of file EquationSystem.C.

{
  _jacobian->Mult(x, residual);
  x.HostRead();
  residual.HostRead();
}

RecoverFEMSolution()

void Moose::MFEM::EquationSystem::RecoverFEMSolution ( mfem::BlockVector &  trueX, Moose::MFEM::GridFunctions &  gridfunctions  )

virtual

Update variable from solution vector after solve.

Definition at line 356 of file EquationSystem.C.

Referenced by Moose::MFEM::EquationSystemProblemOperator::Solve().

{
  for (const auto i : index_range(_trial_var_names))
  {
    auto & trial_var_name = _trial_var_names.at(i);
    trueX.GetBlock(i).SyncAliasMemory(trueX);
    gridfunctions.Get(trial_var_name)->Distribute(&(trueX.GetBlock(i)));
  }
}

SetTrialVariableNames()

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

privatevirtual

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

Reimplemented in Moose::MFEM::TimeDependentEquationSystem.

Definition at line 52 of file EquationSystem.C.

Referenced by Init().

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

TestVarNames()

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

inline

Definition at line 116 of file EquationSystem.h.

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

{ return _test_var_names; }

TrialVarNames()

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

inline

Definition at line 115 of file EquationSystem.h.

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

{ return _trial_var_names; }

VectorContainsName()

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

protected

Definition at line 30 of file EquationSystem.C.

Referenced by AddCoupledVariableNameIfMissing(), AddTestVariableNameIfMissing(), SetTrialVariableNames(), and Moose::MFEM::TimeDependentEquationSystem::SetTrialVariableNames().

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

Friends And Related Function Documentation

EquationSystemProblemOperator

friend class EquationSystemProblemOperator

friend

Definition at line 34 of file EquationSystem.h.

TimeDomainEquationSystemProblemOperator

friend class TimeDomainEquationSystemProblemOperator

friend

Definition at line 35 of file EquationSystem.h.

Member Data Documentation

_assembly_level

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

protected

Definition at line 216 of file EquationSystem.h.

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

_blfs

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

protected

Definition at line 156 of file EquationSystem.h.

Referenced by BuildBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::EliminateCoupledVariables(), FormLegacySystem(), FormSystem(), and Moose::MFEM::TimeDependentEquationSystem::SetTimeStep().

_coupled_pfespaces

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

protected

Pointers to finite element spaces associated with coupled variables.

Definition at line 153 of file EquationSystem.h.

Referenced by BuildMixedBilinearForms(), 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 139 of file EquationSystem.h.

Referenced by AddCoupledVariableNameIfMissing(), BuildMixedBilinearForms(), Init(), SetTrialVariableNames(), and Moose::MFEM::TimeDependentEquationSystem::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 145 of file EquationSystem.h.

Referenced by EliminateCoupledVariables(), Init(), SetTrialVariableNames(), and Moose::MFEM::TimeDependentEquationSystem::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 147 of file EquationSystem.h.

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

_ess_tdof_lists

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

Definition at line 113 of file EquationSystem.h.

Referenced by ApplyEssentialBCs(), Moose::MFEM::TimeDependentEquationSystem::ApplyEssentialBCs(), FormLegacySystem(), Moose::MFEM::TimeDependentEquationSystem::FormLegacySystem(), FormSystem(), and Moose::MFEM::TimeDependentEquationSystem::FormSystem().

_essential_bc_map

Moose::MFEM::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 212 of file EquationSystem.h.

Referenced by AddEssentialBC(), and ApplyEssentialBC().

_h_blocks

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

protected

Definition at line 199 of file EquationSystem.h.

Referenced by AssembleJacobian(), and DeleteAllBlocks().

_integrated_bc_map

Moose::MFEM::NamedFieldsMap< Moose::MFEM::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 209 of file EquationSystem.h.

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

_jacobian

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

mutableprotected

Definition at line 214 of file EquationSystem.h.

Referenced by BuildJacobian(), GetGradient(), and Mult().

_kernels_map

Moose::MFEM::NamedFieldsMap<Moose::MFEM::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 204 of file EquationSystem.h.

Referenced by AddKernel(), BuildBilinearForms(), BuildLinearForms(), and BuildMixedBilinearForms().

_lfs

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

protected

Definition at line 157 of file EquationSystem.h.

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

_mblfs

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

protected

Definition at line 160 of file EquationSystem.h.

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

_nlfs

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

protected

Definition at line 158 of file EquationSystem.h.

_test_pfespaces

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

protected

Pointers to finite element spaces associated with test variables.

Definition at line 151 of file EquationSystem.h.

Referenced by AssembleJacobian(), BuildBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), BuildLinearForms(), BuildMixedBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), 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 149 of file EquationSystem.h.

Referenced by AddTestVariableNameIfMissing(), ApplyEssentialBCs(), Moose::MFEM::TimeDependentEquationSystem::ApplyEssentialBCs(), AssembleJacobian(), BuildBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildBilinearForms(), BuildLinearForms(), BuildMixedBilinearForms(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), EliminateCoupledVariables(), Moose::MFEM::TimeDependentEquationSystem::EliminateCoupledVariables(), FormLinearSystem(), FormSystem(), Moose::MFEM::TimeDependentEquationSystem::FormSystem(), Init(), Moose::MFEM::TimeDependentEquationSystem::Init(), Moose::MFEM::TimeDependentEquationSystem::SetTimeStep(), SetTrialVariableNames(), Moose::MFEM::TimeDependentEquationSystem::SetTrialVariableNames(), and TestVarNames().

_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 143 of file EquationSystem.h.

Referenced by AssembleJacobian(), Moose::MFEM::TimeDependentEquationSystem::BuildMixedBilinearForms(), FormLinearSystem(), RecoverFEMSolution(), SetTrialVariableNames(), Moose::MFEM::TimeDependentEquationSystem::SetTrialVariableNames(), and TrialVarNames().

_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 197 of file EquationSystem.h.

Referenced by ApplyEssentialBCs(), Moose::MFEM::TimeDependentEquationSystem::ApplyEssentialBCs(), FormLegacySystem(), FormSystem(), 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