Moose::MFEM::TimeDependentEquationSystemProblemOperator Class Reference

Problem operator for time-dependent problems with an equation system. More...

#include <TimeDependentEquationSystemProblemOperator.h>

Inheritance diagram for Moose::MFEM::TimeDependentEquationSystemProblemOperator:

Public Member Functions
	TimeDependentEquationSystemProblemOperator (MFEMProblem &problem)
virtual void	SetGridFunctions () override
virtual void	Init (mfem::BlockVector &X) override
virtual void	ImplicitSolve (const mfem::real_t, const mfem::Vector &, mfem::Vector &) override
virtual void	Solve () override
virtual Moose::MFEM::TimeDependentEquationSystem *	GetEquationSystem () const override
	Returns a pointer to the operator's equation system. More...
virtual void	SetTrialVariablesFromTrueVectors ()

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 (mfem::real_t dt)
	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 Attributes
std::shared_ptr< Moose::MFEM::TimeDependentEquationSystem >	_equation_system {nullptr}

Detailed Description

Problem operator for time-dependent problems with an equation system.

Definition at line 22 of file TimeDependentEquationSystemProblemOperator.h.

Constructor & Destructor Documentation

TimeDependentEquationSystemProblemOperator()

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

inline

Definition at line 26 of file TimeDependentEquationSystemProblemOperator.h.

    : TimeDependentProblemOperator(problem),
      _equation_system(
          std::dynamic_pointer_cast<TimeDependentEquationSystem>(_problem_data.eqn_system))
  {
  }

Member Function Documentation

BuildEquationSystemOperator()

void Moose::MFEM::TimeDependentEquationSystemProblemOperator::BuildEquationSystemOperator ( mfem::real_t  dt )

protected

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

Definition at line 74 of file TimeDependentEquationSystemProblemOperator.C.

Referenced by ImplicitSolve().

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

GetEquationSystem()

virtual Moose::MFEM::TimeDependentEquationSystem* Moose::MFEM::TimeDependentEquationSystemProblemOperator::GetEquationSystem ( ) const

inlineoverridevirtual

Returns a pointer to the operator's equation system.

Implements Moose::MFEM::EquationSystemInterface.

Definition at line 39 of file TimeDependentEquationSystemProblemOperator.h.

Referenced by BuildEquationSystemOperator(), ImplicitSolve(), and SetGridFunctions().

  {
    mooseAssert(_equation_system,
                "No TimeDependentEquationSystem in TimeDependentEquationSystemProblemOperator.");
    return _equation_system.get();
  }

ImplicitSolve()

void Moose::MFEM::TimeDependentEquationSystemProblemOperator::ImplicitSolve ( const mfem::real_t  dt, const mfem::Vector &  , mfem::Vector &  X_new  )

overridevirtual

Reimplemented from Moose::MFEM::TimeDependentProblemOperator.

Definition at line 60 of file TimeDependentEquationSystemProblemOperator.C.

{
  _problem_data.coefficients.setTime(GetTime());
  BuildEquationSystemOperator(dt);

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

  X_new.MakeRef(_true_x, 0);
}

Init()

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

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperatorBase.

Definition at line 25 of file TimeDependentEquationSystemProblemOperator.C.

{
  TimeDependentProblemOperator::Init(X);
  // Set timestepper
  auto & ode_solver = _problem_data.ode_solver;
  ode_solver = std::make_unique<mfem::BackwardEulerSolver>();
  ode_solver->Init(*(this));
  SetTime(_problem.time());
  SetImplicitVariableType(STATE);
}

SetGridFunctions()

void Moose::MFEM::TimeDependentEquationSystemProblemOperator::SetGridFunctions ( )

overridevirtual

Reimplemented from Moose::MFEM::TimeDependentProblemOperator.

Definition at line 17 of file TimeDependentEquationSystemProblemOperator.C.

{
  _trial_var_names = GetEquationSystem()->GetTrialVarNames();
  _test_var_names = GetEquationSystem()->GetTestVarNames();
  TimeDependentProblemOperator::SetGridFunctions();
}

SetTrialVariablesFromTrueVectors()

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

virtualinherited

Definition at line 67 of file ProblemOperatorBase.C.

Referenced by 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::TimeDependentEquationSystemProblemOperator::Solve ( )

overridevirtual

Reimplemented from Moose::MFEM::TimeDependentProblemOperator.

Definition at line 37 of file TimeDependentEquationSystemProblemOperator.C.

{
  auto & dt = _problem.dt();
  auto & gfs = _problem_data.gridfunctions;
  auto & tdm = _problem_data.time_derivative_map;

  // Initialise time derivative
  for (const auto & trial_var_name : _trial_var_names)
    gfs.GetRef(tdm.getTimeDerivativeName(trial_var_name)) = gfs.GetRef(trial_var_name);

  // Advance time step of the MFEM problem. Time is also updated here, and
  // _problem_operator->SetTime is called inside the ode_solver->Step method to
  // update the time used by time dependent (function) coefficients.
  _problem_data.ode_solver->Step(*_trial_true_vector, _problem.time(), dt);
  // Synchonise time dependent GridFunctions with updated DoF data.
  SetTrialVariablesFromTrueVectors();

  // Set time derivatives
  for (const auto & trial_var_name : _trial_var_names)
    (gfs.GetRef(tdm.getTimeDerivativeName(trial_var_name)) -= gfs.GetRef(trial_var_name)) /= -dt;
}

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

_equation_system

std::shared_ptr<Moose::MFEM::TimeDependentEquationSystem> Moose::MFEM::TimeDependentEquationSystemProblemOperator::_equation_system {nullptr}

private

Definition at line 51 of file TimeDependentEquationSystemProblemOperator.h.

Referenced by GetEquationSystem().

_problem

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

protectedinherited

Reference to the current problem.

Definition at line 45 of file ProblemOperatorBase.h.

Referenced by Init(), and Solve().

_problem_data

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

protectedinherited

Definition at line 46 of file ProblemOperatorBase.h.

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