Moose::MFEM::EigenproblemESProblemOperator Class Reference

Steady-state eigenproblem operator with an equation system. More...

#include <EigenproblemESProblemOperator.h>

Inheritance diagram for Moose::MFEM::EigenproblemESProblemOperator:

Public Member Functions
	EigenproblemESProblemOperator (MFEMProblem &problem)
virtual void	Solve () override
EigenproblemEquationSystem *	GetEquationSystem () const override
	Returns a pointer to the operator's equation system. More...
virtual void	SetGridFunctions () override
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	BuildEquationSystemOperator ()
	Add kernels/bcs and assemble the linear part of the equation system. More...
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

Private Member Functions
void	RecoverEigenproblemSolution (GridFunctions &gridfunctions, EigensolverBase *eigensolver)

Detailed Description

Steady-state eigenproblem operator with an equation system.

Definition at line 22 of file EigenproblemESProblemOperator.h.

Constructor & Destructor Documentation

EigenproblemESProblemOperator()

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

inline

Definition at line 25 of file EigenproblemESProblemOperator.h.

                                                       : EquationSystemProblemOperator(problem)
  {
    mooseAssert(std::dynamic_pointer_cast<EigenproblemEquationSystem>(_problem_data.eqn_system),
                "MFEMProblemData::eqn_system is not an EigenproblemEquationSystem.");
  }

Member Function Documentation

BuildEquationSystemOperator()

void Moose::MFEM::EigenproblemESProblemOperator::BuildEquationSystemOperator ( )

protected

Add kernels/bcs and assemble the linear part of the equation system.

Definition at line 35 of file EigenproblemESProblemOperator.C.

Referenced by Solve().

{
  GetEquationSystem()->BuildEquationSystem();
  GetEquationSystem()->BuildEigenproblemJacobian(_true_x);
}

GetEquationSystem()

EigenproblemEquationSystem* Moose::MFEM::EigenproblemESProblemOperator::GetEquationSystem ( ) const

inlineoverridevirtual

Returns a pointer to the operator's equation system.

Reimplemented from Moose::MFEM::EquationSystemProblemOperator.

Definition at line 33 of file EigenproblemESProblemOperator.h.

Referenced by BuildEquationSystemOperator(), and Solve().

  {
    return static_cast<EigenproblemEquationSystem *>(
        EquationSystemProblemOperator::GetEquationSystem());
  }

Init()

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

virtualinherited

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

Mult()

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

inlineoverrideinherited

Definition at line 28 of file ProblemOperator.h.

{}

RecoverEigenproblemSolution()

void Moose::MFEM::EigenproblemESProblemOperator::RecoverEigenproblemSolution ( GridFunctions &  gridfunctions, EigensolverBase *  eigensolver  )

private

Definition at line 42 of file EigenproblemESProblemOperator.C.

Referenced by Solve().

{
  mfem::Array<mfem::real_t> eigenvalues;
  eigensolver->GetEigenvalues(eigenvalues);

  const auto & trial_var_name = _trial_var_names.at(0);
  const auto & sep = _problem_data.mode_separator;

  // Distribute the zeroth mode onto the base variable
  gridfunctions.Get(trial_var_name)->Distribute(eigensolver->GetEigenvector(0));

  for (int i = 0; i < eigenvalues.Size(); ++i)
    gridfunctions.Get(trial_var_name + sep + std::to_string(i))
        ->Distribute(eigensolver->GetEigenvector(i));
}

SetGridFunctions()

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

overridevirtualinherited

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

void Moose::MFEM::EigenproblemESProblemOperator::Solve ( )

overridevirtual

Reimplemented from Moose::MFEM::EquationSystemProblemOperator.

Definition at line 19 of file EigenproblemESProblemOperator.C.

{
  BuildEquationSystemOperator();

  auto * const es = GetEquationSystem();
  if (es->GetTestVarNames().size() > 1)
    mooseError("Eigenproblems are only supported in single-variable systems");

  auto eigensolver =
      std::dynamic_pointer_cast<Moose::MFEM::EigensolverBase>(_problem_data.jacobian_solver);
  es->PrepareEigensolver(*eigensolver);
  eigensolver->Solve();
  RecoverEigenproblemSolution(_problem_data.gridfunctions, eigensolver.get());
}

SolveWithOperator()

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

protectedinherited

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

inherited

Definition at line 33 of file ProblemOperatorBase.h.

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

_block_true_offsets_trial

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

inherited

Definition at line 34 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::ComplexEquationSystemProblemOperator::SetGridFunctions().

_problem

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

protectedinherited

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

protectedinherited

Definition at line 46 of file ProblemOperatorBase.h.

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

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

_test_variables

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

protectedinherited

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

Referenced by RecoverEigenproblemSolution(), Moose::MFEM::ProblemOperatorBase::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

protectedinherited

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

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

_true_x

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

inherited

Definition at line 36 of file ProblemOperatorBase.h.

Referenced by Moose::MFEM::EquationSystemProblemOperator::BuildEquationSystemOperator(), BuildEquationSystemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::BuildEquationSystemOperator(), Moose::MFEM::TimeDependentEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::ProblemOperatorBase::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/EigenproblemESProblemOperator.h
• src/mfem/problem_operators/EigenproblemESProblemOperator.C