Connects MFEMProblem's MOOSE solver objects to EquationSystem's mathematics. More...

#include <ProblemOperatorBase.h>

Inheritance diagram for Moose::MFEM::ProblemOperatorBase:

Public Member Functions
	ProblemOperatorBase (MFEMProblem &problem)

virtual	~ProblemOperatorBase ()=default

virtual void	SetGridFunctions ()

virtual void	SetTrialVariablesFromTrueVectors ()

virtual void	Init ()

virtual void	Solve ()=0

PerfGraph &	perfGraph ()
	Get the PerfGraph.

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
mfem::Array< int >	_block_true_offsets_test

mfem::Array< int >	_block_true_offsets_trial

mfem::BlockVector	_true_x

mfem::BlockVector	_true_rhs

mfem::BlockVector	_true_solution
	Persistent true-DoF solution vector backing this operator's trial grid functions after Init().

Protected Member Functions
void	SolveWithOperator (mfem::Operator &system_operator, mfem::Operator &linear_operator, const mfem::Vector &rhs, mfem::Vector &x)
	Solve the current system operator using the configured nonlinear and linear solvers.

void	SolveWithOperator (mfem::Operator &system_operator, const mfem::Vector &rhs, mfem::Vector &x)
	Solve the current system operator using system_operator.GetGradient(x) as the linear operator.

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const
	Call to register a named section for timing.

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
	Call to register a named section for timing.

std::string	timedSectionName (const std::string &section_name) const

Protected Attributes
MFEMProblem &	_problem
	Reference to the current problem.

MFEMProblemData &	_problem_data

std::vector< std::string >	_trial_var_names
	Vector of names of state gridfunctions used in formulation, ordered by appearance in block vector during solve.

std::vector< std::string >	_test_var_names

std::vector< mfem::ParGridFunction * >	_trial_variables

std::vector< mfem::ParGridFunction * >	_test_variables

mfem::Vector *	_trial_true_vector = nullptr

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph.

const std::string	_prefix
	A prefix to use for all sections.

Detailed Description

Connects MFEMProblem's MOOSE solver objects to EquationSystem's mathematics.

Three distinct layers collaborate to run an MFEM solve inside MOOSE:

MFEMProblem owns MOOSE infrastructure: the object factory, the action system, ProblemData, and the configured solver objects. Embedding the mfem::Operator solve-dispatch logic here would couple MOOSE's object-management layer directly to specific MFEM operator patterns, so it delegates to ProblemOperator instead.
EquationSystem owns the mathematics: it builds weak-form components (bilinear/linear/nonlinear forms contributed by kernels and BCs), forms the constrained linear part, retains nonlinear action forms for residual/Jacobian evaluation, and exposes the resulting mfem::Operator interface consumed by both linear solvers (CG, GMRES, direct) and nonlinear solvers (Newton). Solver selection is a user-configuration concern owned by MFEMProblem; coupling it into EquationSystem would conflate the mathematical description of a PDE with how MOOSE happens to solve it.
ProblemOperator (this class) connects the two. It provides:
1. The steady vs. time-dependent dispatch boundary: all subclasses implement Solve() as the MOOSE-level entry point ("do whatever this step requires"). Transient subclasses additionally inherit from mfem::TimeDependentOperator and implement ImplicitSolve(dt, t, x) - a different, MFEM-level contract that MFEM's ODE solvers (BackwardEuler, SDIRK, etc.) call internally. Solve() and ImplicitSolve() live at different abstraction layers and are not interchangeable; ImplicitSolve() carries dt and t precisely because it is the per-step callback in an ODE integration loop.
2. SolveWithOperator() - the linear/nonlinear dispatch that requires knowing which MOOSE solver objects are configured (jacobian_solver, nonlinear_solver).
3. Block-vector bookkeeping (trial/test true-DoF offsets and vectors) that bridges between the true-DoF algebraic world with the FE gridfunction world.

Definition at line 58 of file ProblemOperatorBase.h.

Constructor & Destructor Documentation

◆ ProblemOperatorBase()

Moose::MFEM::ProblemOperatorBase::ProblemOperatorBase ( MFEMProblem & problem )

Definition at line 18 of file ProblemOperatorBase.C.

  : PerfGraphInterface(problem.getMooseApp()),
    _problem(problem),
    _problem_data(problem.getProblemData())
{
}

◆ ~ProblemOperatorBase()

virtual Moose::MFEM::ProblemOperatorBase::~ProblemOperatorBase ( )

virtualdefault

Member Function Documentation

◆ Init()

void Moose::MFEM::ProblemOperatorBase::Init ( )

virtual

Reimplemented in Moose::MFEM::TimeDependentEquationSystemProblemOperator.

Definition at line 50 of file ProblemOperatorBase.C.

{
  SetGridFunctions();
  _true_solution.Update(_block_true_offsets_trial);
  for (const auto i : index_range(_trial_variables))
    _true_solution.GetBlock(i) = _trial_variables[i]->GetTrueVector();
  // Sync the flags from the global vector with the sub-vectors (copies to global vector location)
  _true_solution.SyncFromBlocks();
 
  // After initial assignment of the true solution from the grid function, which may contain
  // initial conditions, we alias the grid function to it
  for (const auto i : index_range(_trial_variables))
    _trial_variables[i]->MakeTRef(
        _trial_variables[i]->ParFESpace(), _true_solution, _block_true_offsets_trial[i]);
  _trial_true_vector = &_true_solution;
}

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

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 86 of file PerfGraphInterface.C.

{
  return _pg_moose_app.perfGraph();
}

Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), PerfGraphReporter::finalize(), and PerfGraphOutput::output().

◆ registerTimedSection() [1/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 61 of file PerfGraphInterface.C.

{
  const auto timed_section_name = timedSectionName(section_name);
  if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
    return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
  else
    return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
}

◆ registerTimedSection() [2/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 72 of file PerfGraphInterface.C.

{
  const auto timed_section_name = timedSectionName(section_name);
  if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
    return moose::internal::getPerfGraphRegistry().registerSection(
        timedSectionName(section_name), level, live_message, print_dots);
  else
    return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
}

◆ SetGridFunctions()

void Moose::MFEM::ProblemOperatorBase::SetGridFunctions ( )

virtual

Reimplemented in Moose::MFEM::ComplexEquationSystemProblemOperator, Moose::MFEM::EquationSystemProblemOperator, Moose::MFEM::ProblemOperator, Moose::MFEM::TimeDependentEquationSystemProblemOperator, and Moose::MFEM::TimeDependentProblemOperator.

Definition at line 26 of file ProblemOperatorBase.C.

{
  _trial_variables = _problem_data.gridfunctions.Get(_trial_var_names);
  _test_variables = _problem_data.gridfunctions.Get(_test_var_names);
 
  // Set operator size and block structure for trial spaces
  _block_true_offsets_trial.SetSize(_trial_variables.size() + 1);
  _block_true_offsets_trial[0] = 0;
  for (const auto ind : index_range(_trial_variables))
    _block_true_offsets_trial[ind + 1] = _trial_variables.at(ind)->ParFESpace()->TrueVSize();
  _block_true_offsets_trial.PartialSum();
 
  // Set operator size and block structure for test spaces
  _block_true_offsets_test.SetSize(_test_variables.size() + 1);
  _block_true_offsets_test[0] = 0;
  for (const auto ind : index_range(_test_variables))
    _block_true_offsets_test[ind + 1] = _test_variables.at(ind)->ParFESpace()->TrueVSize();
  _block_true_offsets_test.PartialSum();
 
  _true_x.Update(_block_true_offsets_trial);
  _true_rhs.Update(_block_true_offsets_test);
}

Referenced by Init(), Moose::MFEM::ProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDependentProblemOperator::SetGridFunctions().

◆ SetTrialVariablesFromTrueVectors()

void Moose::MFEM::ProblemOperatorBase::SetTrialVariablesFromTrueVectors ( )

virtual

Definition at line 68 of file ProblemOperatorBase.C.

{
  mooseAssert(_trial_true_vector, "The true vector should already have been set");
  for (const auto trial_var : _trial_variables)
  {
    // Sync the memory flags from the global true vector to the gridfunction aliases
    trial_var->GetTrueVector().SyncMemory(*_trial_true_vector);
    trial_var->SetFromTrueVector();
  }
}

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

◆ Solve()

virtual void Moose::MFEM::ProblemOperatorBase::Solve ( )

pure virtual

Implemented in Moose::MFEM::ComplexEquationSystemProblemOperator, Moose::MFEM::EigenproblemESProblemOperator, Moose::MFEM::EquationSystemProblemOperator, Moose::MFEM::ProblemOperator, Moose::MFEM::TimeDependentEquationSystemProblemOperator, and Moose::MFEM::TimeDependentProblemOperator.

◆ SolveWithOperator() [1/2]

void Moose::MFEM::ProblemOperatorBase::SolveWithOperator	(	mfem::Operator &	system_operator,
		const mfem::Vector &	rhs,
		mfem::Vector &	x
	)

inlineprotected

Solve the current system operator using system_operator.GetGradient(x) as the linear operator.

Definition at line 88 of file ProblemOperatorBase.h.

  {
    return SolveWithOperator(system_operator, system_operator.GetGradient(x), rhs, x);
  }

◆ SolveWithOperator() [2/2]

void Moose::MFEM::ProblemOperatorBase::SolveWithOperator	(	mfem::Operator &	system_operator,
		mfem::Operator &	linear_operator,
		const mfem::Vector &	rhs,
		mfem::Vector &	x
	)

protected

Solve the current system operator using the configured nonlinear and linear solvers.

Definition at line 80 of file ProblemOperatorBase.C.

{
  // Nonlinear solver path for both linear and nonlinear problems. (as a linear problem may still
  // intentionally be solved through the nonlinear solver machinery when one is provided)
  if (_problem_data.nonlinear_solver)
  {
    auto & nonlinear_solver = *_problem_data.nonlinear_solver;
    if (nonlinear_solver.RequiresExternalLinearSolver())
    {
      if (!_problem_data.jacobian_solver)
        mooseError("The configured MFEM nonlinear solver requires an external linear solver, but "
                   "none was provided.");
      auto & linear_solver = *_problem_data.jacobian_solver;
      linear_solver.SetOperator(linear_operator);
      nonlinear_solver.SetLinearSolver(linear_solver.GetSolver());
    }
 
    nonlinear_solver.SetOperator(system_operator);
    nonlinear_solver.Mult(rhs, x);
  }
  // Linear solver path for linear problems.
  else
  {
    if (!_problem_data.jacobian_solver)
      mooseError("A linear MFEM solve requires a linear solver, but none was provided.");
 
    auto & linear_solver = *_problem_data.jacobian_solver;
    linear_solver.SetOperator(linear_operator);
    linear_solver.Mult(rhs, x);
  }
}

Referenced by Moose::MFEM::TimeDependentEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::ComplexEquationSystemProblemOperator::Solve(), Moose::MFEM::EquationSystemProblemOperator::Solve(), and SolveWithOperator().

◆ timedSectionName()

std::string PerfGraphInterface::timedSectionName ( const std::string & section_name ) const

protectedinherited

Returns: The name of the timed section with the name section_name.

Optionally adds a prefix if one is defined.

Definition at line 55 of file PerfGraphInterface.C.

{
  return _prefix.empty() ? section_name : _prefix + "::" + section_name;
}

Referenced by PerfGraphInterface::registerTimedSection(), and PerfGraphInterface::registerTimedSection().

◆ validParams()

InputParameters PerfGraphInterface::validParams ( )

staticinherited

Definition at line 16 of file PerfGraphInterface.C.

{
  InputParameters params = emptyInputParameters();
  return params;
}

Referenced by Convergence::validParams().

Member Data Documentation

◆ _block_true_offsets_test

mfem::Array<int> Moose::MFEM::ProblemOperatorBase::_block_true_offsets_test

Definition at line 69 of file ProblemOperatorBase.h.

Referenced by SetGridFunctions(), Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::ProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDependentProblemOperator::SetGridFunctions().

◆ _block_true_offsets_trial

mfem::Array<int> Moose::MFEM::ProblemOperatorBase::_block_true_offsets_trial

Definition at line 70 of file ProblemOperatorBase.h.

Referenced by Init(), SetGridFunctions(), Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::ProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDependentProblemOperator::SetGridFunctions().

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 135 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 138 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _problem

MFEMProblem& Moose::MFEM::ProblemOperatorBase::_problem

protected

Reference to the current problem.

Definition at line 94 of file ProblemOperatorBase.h.

Referenced by Moose::MFEM::EigenproblemESProblemOperator::FormEquationSystemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::Init(), and Moose::MFEM::TimeDependentEquationSystemProblemOperator::Solve().

◆ _problem_data

MFEMProblemData& Moose::MFEM::ProblemOperatorBase::_problem_data

protected

Definition at line 95 of file ProblemOperatorBase.h.

Referenced by Moose::MFEM::TimeDependentEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::Init(), Moose::MFEM::EigenproblemESProblemOperator::RecoverEigenproblemSolution(), SetGridFunctions(), Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::EigenproblemESProblemOperator::Solve(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::Solve(), and SolveWithOperator().

◆ _test_var_names

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

protected

Definition at line 100 of file ProblemOperatorBase.h.

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

◆ _test_variables

std::vector<mfem::ParGridFunction *> Moose::MFEM::ProblemOperatorBase::_test_variables

protected

Definition at line 102 of file ProblemOperatorBase.h.

Referenced by SetGridFunctions(), Moose::MFEM::ProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDependentProblemOperator::SetGridFunctions().

◆ _trial_true_vector

mfem::Vector* Moose::MFEM::ProblemOperatorBase::_trial_true_vector = nullptr

protected

Definition at line 103 of file ProblemOperatorBase.h.

Referenced by Init(), SetTrialVariablesFromTrueVectors(), and Moose::MFEM::TimeDependentEquationSystemProblemOperator::Solve().

◆ _trial_var_names

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

protected

Vector of names of state gridfunctions used in formulation, ordered by appearance in block vector during solve.

Definition at line 99 of file ProblemOperatorBase.h.

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

◆ _trial_variables

std::vector<mfem::ParGridFunction *> Moose::MFEM::ProblemOperatorBase::_trial_variables

protected

Definition at line 101 of file ProblemOperatorBase.h.

Referenced by Init(), SetGridFunctions(), Moose::MFEM::ProblemOperator::SetGridFunctions(), Moose::MFEM::TimeDependentProblemOperator::SetGridFunctions(), and SetTrialVariablesFromTrueVectors().

◆ _true_rhs

mfem::BlockVector Moose::MFEM::ProblemOperatorBase::_true_rhs

Definition at line 72 of file ProblemOperatorBase.h.

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

◆ _true_solution

mfem::BlockVector Moose::MFEM::ProblemOperatorBase::_true_solution

Persistent true-DoF solution vector backing this operator's trial grid functions after Init().

Each operator owns its own, because Init() aliases its trial grid functions into this vector; sharing one across operators would make each alias the same storage.

Definition at line 77 of file ProblemOperatorBase.h.

Referenced by Init().

◆ _true_x

mfem::BlockVector Moose::MFEM::ProblemOperatorBase::_true_x

Definition at line 72 of file ProblemOperatorBase.h.

Referenced by Moose::MFEM::EigenproblemESProblemOperator::FormEquationSystemOperator(), Moose::MFEM::EquationSystemProblemOperator::FormEquationSystemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::FormEquationSystemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::ImplicitSolve(), SetGridFunctions(), Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::ComplexEquationSystemProblemOperator::Solve(), and Moose::MFEM::EquationSystemProblemOperator::Solve().

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

include/mfem/problem_operators/ProblemOperatorBase.h
src/mfem/problem_operators/ProblemOperatorBase.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProblemOperatorBase()

◆ ~ProblemOperatorBase()

Member Function Documentation

◆ Init()

◆ perfGraph()

◆ registerTimedSection() [1/2]

◆ registerTimedSection() [2/2]

◆ SetGridFunctions()

◆ SetTrialVariablesFromTrueVectors()

◆ Solve()

◆ SolveWithOperator() [1/2]

◆ SolveWithOperator() [2/2]

◆ timedSectionName()

◆ validParams()

Member Data Documentation

◆ _block_true_offsets_test

◆ _block_true_offsets_trial

◆ _pg_moose_app

◆ _prefix

◆ _problem

◆ _problem_data

◆ _test_var_names

◆ _test_variables

◆ _trial_true_vector

◆ _trial_var_names

◆ _trial_variables

◆ _true_rhs

◆ _true_solution

◆ _true_x