Moose::MFEM::TimeDomainEquationSystemProblemOperator Class Reference

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

#include <TimeDomainEquationSystemProblemOperator.h>

Inheritance diagram for Moose::MFEM::TimeDomainEquationSystemProblemOperator:

Public Member Functions
	TimeDomainEquationSystemProblemOperator (MFEMProblem &problem)
void	SetGridFunctions () override
void	Init (mfem::BlockVector &X) override
void	ImplicitSolve (const double dt, const mfem::Vector &X, mfem::Vector &dX_dt) override
void	Solve () override
Moose::MFEM::TimeDependentEquationSystem *	GetEquationSystem () const override
	Returns a pointer to the operator's equation system. More...
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 Member Functions
void	BuildEquationSystemOperator (double dt)

Protected Attributes
MFEMProblem &	_problem
	Reference to the current problem. More...
MFEMProblemData &	_problem_data
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::TimeDependentEquationSystem >	_equation_system {nullptr}

Detailed Description

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

Definition at line 20 of file TimeDomainEquationSystemProblemOperator.h.

Constructor & Destructor Documentation

TimeDomainEquationSystemProblemOperator()

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

inline

Definition at line 24 of file TimeDomainEquationSystemProblemOperator.h.

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

Member Function Documentation

BuildEquationSystemOperator()

void Moose::MFEM::TimeDomainEquationSystemProblemOperator::BuildEquationSystemOperator ( double  dt )

protected

Definition at line 77 of file TimeDomainEquationSystemProblemOperator.C.

Referenced by ImplicitSolve().

{
  GetEquationSystem()->SetTimeStep(dt);
  GetEquationSystem()->UpdateEquationSystem();
  GetEquationSystem()->BuildJacobian(_true_x, _true_rhs);
}

GetEquationSystem()

Moose::MFEM::TimeDependentEquationSystem* Moose::MFEM::TimeDomainEquationSystemProblemOperator::GetEquationSystem ( ) const

inlineoverridevirtual

Returns a pointer to the operator's equation system.

Implements Moose::MFEM::EquationSystemInterface.

Definition at line 36 of file TimeDomainEquationSystemProblemOperator.h.

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

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

    return _equation_system.get();
  }

ImplicitSolve()

void Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve ( const double  dt, const mfem::Vector &  X, mfem::Vector &  dX_dt  )

override

Definition at line 49 of file TimeDomainEquationSystemProblemOperator.C.

{
  dX_dt = 0.0;
  SetTestVariablesFromTrueVectors();
  for (unsigned int ind = 0; ind < _trial_variables.size(); ++ind)
  {
    _trial_variables.at(ind)->MakeTRef(
        _trial_variables.at(ind)->ParFESpace(), dX_dt, _block_true_offsets[ind]);
  }
  _problem_data.coefficients.setTime(GetTime());
  BuildEquationSystemOperator(dt);

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

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

  _problem_data.nonlinear_solver->SetSolver(_problem_data.jacobian_solver->getSolver());
  _problem_data.nonlinear_solver->SetOperator(*GetEquationSystem());
  _problem_data.nonlinear_solver->Mult(_true_rhs, dX_dt);
  SetTrialVariablesFromTrueVectors();
}

Init()

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

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperatorBase.

Definition at line 26 of file TimeDomainEquationSystemProblemOperator.C.

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

SetGridFunctions()

void Moose::MFEM::TimeDomainEquationSystemProblemOperator::SetGridFunctions ( )

overridevirtual

Reimplemented from Moose::MFEM::ProblemOperatorBase.

Definition at line 17 of file TimeDomainEquationSystemProblemOperator.C.

{
  _test_var_names = GetEquationSystem()->TestVarNames();
  _trial_var_names = GetEquationSystem()->TrialVarNames();

  TimeDomainProblemOperator::SetGridFunctions();
}

SetTestVariablesFromTrueVectors()

void Moose::MFEM::ProblemOperatorBase::SetTestVariablesFromTrueVectors ( )

virtualinherited

Definition at line 65 of file ProblemOperatorBase.C.

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

{
  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::ProblemOperatorBase::SetTrialVariablesFromTrueVectors ( )

virtualinherited

Definition at line 80 of file ProblemOperatorBase.C.

Referenced by ImplicitSolve().

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

Solve()

void Moose::MFEM::TimeDomainEquationSystemProblemOperator::Solve ( )

overridevirtual

Implements Moose::MFEM::ProblemOperatorBase.

Definition at line 38 of file TimeDomainEquationSystemProblemOperator.C.

{
  // 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(_problem_data.f, _problem.time(), _problem.dt());
  // Synchonise time dependent GridFunctions with updated DoF data.
  SetTestVariablesFromTrueVectors();
}

Member Data Documentation

_block_true_offsets

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

inherited

Definition at line 30 of file ProblemOperatorBase.h.

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

_equation_system

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

private

Definition at line 50 of file TimeDomainEquationSystemProblemOperator.h.

Referenced by GetEquationSystem(), and ImplicitSolve().

_equation_system_operator

mfem::OperatorHandle Moose::MFEM::ProblemOperatorBase::_equation_system_operator

inherited

Definition at line 33 of file ProblemOperatorBase.h.

_problem

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

protectedinherited

Reference to the current problem.

Definition at line 37 of file ProblemOperatorBase.h.

Referenced by Init(), and Solve().

_problem_data

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

protectedinherited

Definition at line 38 of file ProblemOperatorBase.h.

Referenced by ImplicitSolve(), Init(), Moose::MFEM::ProblemOperatorBase::SetGridFunctions(), Moose::MFEM::EquationSystemProblemOperator::Solve(), and Solve().

_test_true_vector

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

protectedinherited

Definition at line 44 of file ProblemOperatorBase.h.

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

_test_var_names

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

protectedinherited

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

Definition at line 42 of file ProblemOperatorBase.h.

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

_test_variables

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

protectedinherited

Definition at line 43 of file ProblemOperatorBase.h.

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

_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 48 of file ProblemOperatorBase.h.

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

_trial_variables

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

protectedinherited

Definition at line 49 of file ProblemOperatorBase.h.

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

_true_rhs

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

inherited

Definition at line 32 of file ProblemOperatorBase.h.

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

_true_x

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

inherited

Definition at line 32 of file ProblemOperatorBase.h.

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

---

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

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