Moose::MFEM::ProblemOperatorBase Class Reference

Interface inherited by ProblemOperator and TimeDependentProblemOperator. Removes duplicated code in both classes. 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 (mfem::BlockVector &X)
virtual void	Solve ()=0

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	SolveWithOperator (EquationSystem &equation_system, const mfem::Vector &rhs, mfem::Vector &x)
	Solve the current equation system/operator using the configured nonlinear solver or linear solver for a purely linear problem. 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

Detailed Description

Interface inherited by ProblemOperator and TimeDependentProblemOperator. Removes duplicated code in both classes.

Definition at line 22 of file ProblemOperatorBase.h.

Constructor & Destructor Documentation

ProblemOperatorBase()

Moose::MFEM::ProblemOperatorBase::ProblemOperatorBase

(

MFEMProblem &

problem

)

Definition at line 20 of file ProblemOperatorBase.C.

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

~ProblemOperatorBase()

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

virtualdefault

Member Function Documentation

Init()

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

virtual

Reimplemented in Moose::MFEM::TimeDependentEquationSystemProblemOperator.

Definition at line 50 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;
}

SetGridFunctions()

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

virtual

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

Definition at line 26 of file ProblemOperatorBase.C.

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

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

SetTrialVariablesFromTrueVectors()

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

virtual

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

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

pure virtual

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

SolveWithOperator()

void Moose::MFEM::ProblemOperatorBase::SolveWithOperator ( EquationSystem &  equation_system, const mfem::Vector &  rhs, mfem::Vector &  x  )

protected

Solve the current equation system/operator using the configured nonlinear solver or linear solver for a purely linear problem.

Definition at line 79 of file ProblemOperatorBase.C.

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

{
  const bool nonlinear = equation_system.Nonlinear();

  // `nonlinear` describes the assembled MFEM operator, not whether the user configured a
  // nonlinear solver object. A linear problem may still intentionally be solved through the
  // nonlinear solver machinery when one is provided.
  if (nonlinear || _problem_data.nonlinear_solver)
  {
    if (nonlinear && !_problem_data.nonlinear_solver)
      mooseError("A nonlinear MFEM solve requires a nonlinear solver, but none was provided.");

    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;
      equation_system.PrepareLinearSolver(linear_solver);
      nonlinear_solver.SetLinearSolver(linear_solver.GetSolver());
    }

    nonlinear_solver.SetOperator(equation_system);
    nonlinear_solver.Mult(rhs, x);
    return;
  }
  else
  {
    //
    // pure linear path
    //

    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;
    equation_system.PrepareLinearSolver(linear_solver);
    linear_solver.GetSolver().Mult(rhs, x);
  }
}

Member Data Documentation

_block_true_offsets_test

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

Definition at line 33 of file ProblemOperatorBase.h.

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

_block_true_offsets_trial

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

Definition at line 34 of file ProblemOperatorBase.h.

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

_problem

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

protected

Reference to the current problem.

Definition at line 45 of file ProblemOperatorBase.h.

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

_problem_data

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

protected

Definition at line 46 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(), 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 51 of file ProblemOperatorBase.h.

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

_test_variables

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

protected

Definition at line 53 of file ProblemOperatorBase.h.

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

_trial_true_vector

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

protected

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

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

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

_true_rhs

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

Definition at line 36 of file ProblemOperatorBase.h.

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

_true_x

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

Definition at line 36 of file ProblemOperatorBase.h.

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

---

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

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