Moose::MFEM::EquationSystemProblemOperator Class Reference

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

#include <EquationSystemProblemOperator.h>

Inheritance diagram for Moose::MFEM::EquationSystemProblemOperator:

Public Member Functions
	EquationSystemProblemOperator (MFEMProblemData &problem)
void	SetGridFunctions () override
void	Init (mfem::BlockVector &X) override
virtual void	Solve (mfem::Vector &X) override
Moose::MFEM::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	SetTestVariablesFromTrueVectors ()
virtual void	SetTrialVariablesFromTrueVectors ()

Public Attributes
mfem::Array< int >	_block_true_offsets
mfem::BlockVector	_true_x
mfem::BlockVector	_true_rhs
mfem::OperatorHandle	_equation_system_operator

Protected Attributes
MFEMProblemData &	_problem
	Reference to the current problem. More...
std::vector< std::string >	_test_var_names
	Vector of names of state gridfunctions used in formulation, ordered by appearance in block vector during solve. More...
std::vector< mfem::ParGridFunction * >	_test_variables
const mfem::Vector *	_test_true_vector = nullptr
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< mfem::ParGridFunction * >	_trial_variables

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

Detailed Description

Steady-state problem operator with an equation system.

Definition at line 19 of file EquationSystemProblemOperator.h.

Constructor & Destructor Documentation

EquationSystemProblemOperator()

Moose::MFEM::EquationSystemProblemOperator::EquationSystemProblemOperator ( MFEMProblemData &  problem )

inline

Definition at line 22 of file EquationSystemProblemOperator.h.

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

Member Function Documentation

GetEquationSystem()

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

inlineoverridevirtual

Returns a pointer to the operator's equation system.

Implements Moose::MFEM::EquationSystemInterface.

Definition at line 31 of file EquationSystemProblemOperator.h.

Referenced by Init(), SetGridFunctions(), and Solve().

  {
    if (!_equation_system)
    {
      MFEM_ABORT("No equation system has been added to ProblemOperator.");
    }

    return _equation_system.get();
  }

Init()

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

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperatorInterface.

Definition at line 25 of file EquationSystemProblemOperator.C.

{
  ProblemOperator::Init(X);

  GetEquationSystem()->BuildEquationSystem();
}

Mult()

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

inlineoverrideinherited

Definition at line 27 of file ProblemOperator.h.

{}

SetGridFunctions()

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

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperatorInterface.

Definition at line 17 of file EquationSystemProblemOperator.C.

{
  _test_var_names = GetEquationSystem()->TestVarNames();
  _trial_var_names = GetEquationSystem()->TrialVarNames();
  ProblemOperator::SetGridFunctions();
}

SetTestVariablesFromTrueVectors()

void Moose::MFEM::ProblemOperatorInterface::SetTestVariablesFromTrueVectors ( )

virtualinherited

Definition at line 57 of file ProblemOperatorInterface.C.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve(), and Moose::MFEM::ProblemOperatorInterface::Init().

{
  for (unsigned int ind = 0; ind < _test_variables.size(); ++ind)
  {
    auto * const test_var = _test_variables.at(ind);

    // We must sync the memory flags from the true true vector to the grid function copy of the true
    // vector
    mooseAssert(_test_true_vector, "The true vector should already have been set");
    test_var->GetTrueVector().SyncMemory(*_test_true_vector);
    test_var->SetFromTrueVector();
  }
}

SetTrialVariablesFromTrueVectors()

void Moose::MFEM::ProblemOperatorInterface::SetTrialVariablesFromTrueVectors ( )

virtualinherited

Definition at line 72 of file ProblemOperatorInterface.C.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve().

{
  for (unsigned int ind = 0; ind < _trial_variables.size(); ++ind)
  {
    _trial_variables.at(ind)->SetFromTrueVector();
  }
}

Solve()

void Moose::MFEM::EquationSystemProblemOperator::Solve ( mfem::Vector &  X )

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperator.

Definition at line 33 of file EquationSystemProblemOperator.C.

{
  GetEquationSystem()->BuildJacobian(_true_x, _true_rhs);

  if (_problem.jacobian_solver->isLOR() && _equation_system->_test_var_names.size() > 1)
    mooseError("LOR solve is only supported for single-variable systems");

  _problem.jacobian_solver->updateSolver(
      *_equation_system->_blfs.Get(_equation_system->_test_var_names.at(0)),
      _equation_system->_ess_tdof_lists.at(0));

  _problem.nonlinear_solver->SetSolver(_problem.jacobian_solver->getSolver());
  _problem.nonlinear_solver->SetOperator(*GetEquationSystem());
  _problem.nonlinear_solver->Mult(_true_rhs, _true_x);

  GetEquationSystem()->RecoverFEMSolution(_true_x, _problem.gridfunctions);
}

Member Data Documentation

_block_true_offsets

mfem::Array<int> Moose::MFEM::ProblemOperatorInterface::_block_true_offsets

inherited

Definition at line 29 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::ProblemOperatorInterface::Init(), Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), Moose::MFEM::ProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDomainProblemOperator::SetGridFunctions().

_equation_system

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

private

Definition at line 42 of file EquationSystemProblemOperator.h.

Referenced by GetEquationSystem(), and Solve().

_equation_system_operator

mfem::OperatorHandle Moose::MFEM::ProblemOperatorInterface::_equation_system_operator

inherited

Definition at line 32 of file ProblemOperatorInterface.h.

_problem

MFEMProblemData& Moose::MFEM::ProblemOperatorInterface::_problem

protectedinherited

Reference to the current problem.

Definition at line 36 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), and Solve().

_test_true_vector

const mfem::Vector* Moose::MFEM::ProblemOperatorInterface::_test_true_vector = nullptr

protectedinherited

Definition at line 42 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::ProblemOperatorInterface::Init(), and Moose::MFEM::ProblemOperatorInterface::SetTestVariablesFromTrueVectors().

_test_var_names

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

protectedinherited

Vector of names of state gridfunctions used in formulation, ordered by appearance in block vector during solve.

Definition at line 40 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), SetGridFunctions(), and Moose::MFEM::TimeDomainEquationSystemProblemOperator::SetGridFunctions().

_test_variables

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

protectedinherited

Definition at line 41 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::ProblemOperatorInterface::Init(), Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), and Moose::MFEM::ProblemOperatorInterface::SetTestVariablesFromTrueVectors().

_trial_var_names

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

protectedinherited

Vector of names of state gridfunctions used in formulation, ordered by appearance in block vector during solve.

Definition at line 46 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), SetGridFunctions(), and Moose::MFEM::TimeDomainEquationSystemProblemOperator::SetGridFunctions().

_trial_variables

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

protectedinherited

Definition at line 47 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::ProblemOperator::SetGridFunctions(), Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), Moose::MFEM::TimeDomainProblemOperator::SetGridFunctions(), and Moose::MFEM::ProblemOperatorInterface::SetTrialVariablesFromTrueVectors().

_true_rhs

mfem::BlockVector Moose::MFEM::ProblemOperatorInterface::_true_rhs

inherited

Definition at line 31 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::BuildEquationSystemOperator(), Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve(), Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), and Solve().

_true_x

mfem::BlockVector Moose::MFEM::ProblemOperatorInterface::_true_x

inherited

Definition at line 31 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::BuildEquationSystemOperator(), Moose::MFEM::ProblemOperatorInterface::SetGridFunctions(), 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