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)
virtual void	SetGridFunctions () override
virtual void	Solve () override
virtual EquationSystem *	GetEquationSystem () const override
	Returns a pointer to the operator's equation system. More...
void	Mult (const mfem::Vector &, mfem::Vector &) const override
virtual void	SetTrialVariablesFromTrueVectors ()
virtual void	Init (mfem::BlockVector &X)

Public Attributes
mfem::Array< int >	_block_true_offsets_test
mfem::Array< int >	_block_true_offsets_trial
mfem::BlockVector	_true_x
mfem::BlockVector	_true_rhs

Protected Member Functions
void	FormEquationSystemOperator ()
	Form equation-system state used by Solve(). More...
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. More...
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. More...

Protected Attributes
MFEMProblem &	_problem
	Reference to the current problem. More...
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. More...
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

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 )

inline

Definition at line 37 of file EquationSystemProblemOperator.h.

    : ProblemOperator(problem), _equation_system(_problem_data.eqn_system)
  {
  }

Member Function Documentation

FormEquationSystemOperator()

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

protected

Form equation-system state used by Solve().

Definition at line 36 of file EquationSystemProblemOperator.C.

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

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

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 45 of file EquationSystemProblemOperator.h.

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

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

Init()

void Moose::MFEM::ProblemOperatorBase::Init ( mfem::BlockVector &  X )

virtualinherited

Reimplemented in Moose::MFEM::TimeDependentEquationSystemProblemOperator.

Definition at line 49 of file ProblemOperatorBase.C.

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

{
  X.Update(_block_true_offsets_trial);
  for (const auto i : index_range(_trial_variables))
    X.GetBlock(i) = _trial_variables[i]->GetTrueVector();
  // Sync the flags from the global vector with the sub-vectors (copies to global vector location)
  X.SyncFromBlocks();

  // After initial assignment of X from the grid function, which may contain initial conditions,
  // we alias the grid function to X
  for (const auto i : index_range(_trial_variables))
    _trial_variables[i]->MakeTRef(
        _trial_variables[i]->ParFESpace(), X, _block_true_offsets_trial[i]);
  _trial_true_vector = &X;
}

Mult()

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

inlineoverrideinherited

Definition at line 28 of file ProblemOperator.h.

{}

SetGridFunctions()

void Moose::MFEM::EquationSystemProblemOperator::SetGridFunctions ( )

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperator.

Reimplemented in Moose::MFEM::ComplexEquationSystemProblemOperator.

Definition at line 17 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 66 of file ProblemOperatorBase.C.

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

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

Solve()

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

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperator.

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

Definition at line 25 of file EquationSystemProblemOperator.C.

{
  FormEquationSystemOperator();

  auto * const es = GetEquationSystem();
  SolveWithOperator(*es, _true_rhs, _true_x);

  es->SetTrialVariablesFromTrueVectors(_true_x);
}

SolveWithOperator() [1/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 78 of file ProblemOperatorBase.C.

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

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

SolveWithOperator() [2/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 77 of file ProblemOperatorBase.h.

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

Member Data Documentation

_block_true_offsets_test

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

inherited

Definition at line 63 of file ProblemOperatorBase.h.

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

_block_true_offsets_trial

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

inherited

Definition at line 64 of file ProblemOperatorBase.h.

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

_equation_system

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

private

Definition at line 56 of file EquationSystemProblemOperator.h.

Referenced by GetEquationSystem().

_problem

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

protectedinherited

Reference to the current problem.

Definition at line 83 of file ProblemOperatorBase.h.

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

_problem_data

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

protectedinherited

Definition at line 84 of file ProblemOperatorBase.h.

Referenced by Moose::MFEM::ComplexEquationSystemProblemOperator::ComplexEquationSystemProblemOperator(), Moose::MFEM::EigenproblemESProblemOperator::EigenproblemESProblemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::Init(), Moose::MFEM::EigenproblemESProblemOperator::RecoverEigenproblemSolution(), Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::ProblemOperatorBase::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 89 of file ProblemOperatorBase.h.

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

_test_variables

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

protectedinherited

Definition at line 91 of file ProblemOperatorBase.h.

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

_trial_true_vector

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

protectedinherited

Definition at line 92 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 88 of file ProblemOperatorBase.h.

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

_trial_variables

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

protectedinherited

Definition at line 90 of file ProblemOperatorBase.h.

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

_true_rhs

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

inherited

Definition at line 66 of file ProblemOperatorBase.h.

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

_true_x

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

inherited

Definition at line 66 of file ProblemOperatorBase.h.

Referenced by Moose::MFEM::EigenproblemESProblemOperator::FormEquationSystemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::FormEquationSystemOperator(), FormEquationSystemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::ComplexEquationSystemProblemOperator::SetGridFunctions(), Moose::MFEM::ProblemOperatorBase::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