Moose::MFEM::EquationSystemProblemOperator Class Reference

Steady-state ProblemOperator that prepares and solves a single EquationSystem. More...

#include <EquationSystemProblemOperator.h>

Inheritance diagram for Moose::MFEM::EquationSystemProblemOperator:

Public Member Functions
	EquationSystemProblemOperator (MFEMProblem &problem, const std::string &weak_form_name="")
virtual void	SetGridFunctions () override
virtual void	Solve () override
virtual EquationSystem *	GetEquationSystem () const override
	Returns a pointer to the operator's equation system.
void	Mult (const mfem::Vector &, mfem::Vector &) const override
virtual void	SetTrialVariablesFromTrueVectors ()
virtual void	Init ()
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	FormEquationSystemOperator ()
	Form equation-system state used by Solve().
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.

Private Attributes
std::shared_ptr< EquationSystem >	_equation_system {nullptr}

Detailed Description

Steady-state ProblemOperator that prepares and solves a single EquationSystem.

On each call to Solve() this class:

1. Forms equation-system data (kernels -> weak forms -> constrained linear part and nonlinear action forms).
2. Calls SolveWithOperator() to pass either the EquationSystem itself or the assembled linear operator (and the bilinear form for LOR preconditioners) to the configured solver tree.
3. Dispatches to the linear or nonlinear solve path via SolveWithOperator().
4. Scatters the true-DoF solution back to the grid functions.

See also

EquationSystem for the class that owns the weak-form mathematics.

ProblemOperatorBase for the block-vector bookkeeping and solve-dispatch infrastructure.

Definition at line 34 of file EquationSystemProblemOperator.h.

Constructor & Destructor Documentation

EquationSystemProblemOperator()

Moose::MFEM::EquationSystemProblemOperator::EquationSystemProblemOperator	(	MFEMProblem &	problem,
		const std::string &	weak_form_name = ""
	)

Parameters

weak_form_name

Name of the weak form supplying this operator's EquationSystem. If empty, the problem's sole EquationSystem is used.

Definition at line 17 of file EquationSystemProblemOperator.C.

  : ProblemOperator(problem), _equation_system(problem.getEquationSystem(weak_form_name))
{
}

Member Function Documentation

FormEquationSystemOperator()

void Moose::MFEM::EquationSystemProblemOperator::FormEquationSystemOperator ( )

protected

Form equation-system state used by Solve().

Definition at line 50 of file EquationSystemProblemOperator.C.

{
  GetEquationSystem()->FormSystem(_true_x, _true_rhs);
}

Referenced by Moose::MFEM::ComplexEquationSystemProblemOperator::Solve(), and Solve().

GetEquationSystem()

virtual EquationSystem * Moose::MFEM::EquationSystemProblemOperator::GetEquationSystem ( ) const

inlineoverridevirtual

Returns a pointer to the operator's equation system.

Implements Moose::MFEM::EquationSystemInterface.

Reimplemented in Moose::MFEM::ComplexEquationSystemProblemOperator, and Moose::MFEM::EigenproblemESProblemOperator.

Definition at line 44 of file EquationSystemProblemOperator.h.

  {
    mooseAssert(_equation_system, "No EquationSystem in EquationSystemProblemOperator.");
    return _equation_system.get();
  }

Referenced by FormEquationSystemOperator(), Moose::MFEM::EigenproblemESProblemOperator::GetEquationSystem(), SetGridFunctions(), and Solve().

Init()

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

virtualinherited

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().

Mult()

void Moose::MFEM::ProblemOperator::Mult ( const mfem::Vector &  , mfem::Vector &    ) const

inlineoverrideinherited

Definition at line 28 of file ProblemOperator.h.

{}

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::EquationSystemProblemOperator::SetGridFunctions ( )

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperator.

Reimplemented in Moose::MFEM::ComplexEquationSystemProblemOperator.

Definition at line 24 of file EquationSystemProblemOperator.C.

{
  _trial_var_names = GetEquationSystem()->GetTrialVarNames();
  _test_var_names = GetEquationSystem()->GetTestVarNames();
  ProblemOperator::SetGridFunctions();
}

SetTrialVariablesFromTrueVectors()

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

virtualinherited

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()

void Moose::MFEM::EquationSystemProblemOperator::Solve ( )

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperator.

Reimplemented in Moose::MFEM::ComplexEquationSystemProblemOperator, and Moose::MFEM::EigenproblemESProblemOperator.

Definition at line 32 of file EquationSystemProblemOperator.C.

{
  auto * const es = GetEquationSystem();
 
  {
    TIME_SECTION("EquationSystemProblemOperator::FormSystem", 2, "Assembling MFEM System");
    FormEquationSystemOperator();
  }
 
  {
    TIME_SECTION("EquationSystemProblemOperator::SolveSystem", 2, "Solving MFEM System");
    SolveWithOperator(*es, _true_rhs, _true_x);
  }
 
  es->SetTrialVariablesFromTrueVectors(_true_x);
}

SolveWithOperator() [1/2]

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

inlineprotectedinherited

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  )

protectedinherited

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(), Solve(), and Moose::MFEM::ProblemOperatorBase::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

inherited

Definition at line 69 of file ProblemOperatorBase.h.

Referenced by Moose::MFEM::ProblemOperatorBase::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

inherited

Definition at line 70 of file ProblemOperatorBase.h.

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

_equation_system

std::shared_ptr<EquationSystem> Moose::MFEM::EquationSystemProblemOperator::_equation_system {nullptr}

private

Definition at line 55 of file EquationSystemProblemOperator.h.

{nullptr};

Referenced by GetEquationSystem().

_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

protectedinherited

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

protectedinherited

Definition at line 95 of file ProblemOperatorBase.h.

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

_test_var_names

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

protectedinherited

Definition at line 100 of file ProblemOperatorBase.h.

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

_test_variables

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

protectedinherited

Definition at line 102 of file ProblemOperatorBase.h.

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

_trial_true_vector

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

protectedinherited

Definition at line 103 of file ProblemOperatorBase.h.

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

_trial_var_names

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

protectedinherited

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(), Moose::MFEM::ProblemOperatorBase::SetGridFunctions(), Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), SetGridFunctions(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDependentEquationSystemProblemOperator::Solve().

_trial_variables

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

protectedinherited

Definition at line 101 of file ProblemOperatorBase.h.

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

_true_rhs

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

inherited

Definition at line 72 of file ProblemOperatorBase.h.

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

_true_solution

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

inherited

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 Moose::MFEM::ProblemOperatorBase::Init().

_true_x

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

inherited

Definition at line 72 of file ProblemOperatorBase.h.

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

---

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

• include/mfem/problem_operators/EquationSystemProblemOperator.h
• src/mfem/problem_operators/EquationSystemProblemOperator.C