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.

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	FormEquationSystemOperator ()
	Form the equation-system operator used by the eigensolver.

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.

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

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

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

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

◆ FormEquationSystemOperator()

void Moose::MFEM::EigenproblemESProblemOperator::FormEquationSystemOperator ( )

protected

Form the equation-system operator used by the eigensolver.

Definition at line 35 of file EigenproblemESProblemOperator.C.

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

Referenced by Solve().

◆ 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.

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

Referenced by FormEquationSystemOperator(), and Solve().

◆ Init()

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

virtualinherited

Reimplemented in Moose::MFEM::TimeDependentEquationSystemProblemOperator.

Definition at line 49 of file ProblemOperatorBase.C.

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

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.

28{}

◆ RecoverEigenproblemSolution()

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

private

Definition at line 42 of file EigenproblemESProblemOperator.C.

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

Referenced by Solve().

◆ 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 66 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::EigenproblemESProblemOperator::Solve ( )

overridevirtual

Reimplemented from Moose::MFEM::EquationSystemProblemOperator.

Definition at line 19 of file EigenproblemESProblemOperator.C.

{
  FormEquationSystemOperator();
 
  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() [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 77 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 78 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);
  }
}