Moose::MFEM::ProblemOperatorBase Class Reference

Interface inherited by ProblemOperator and TimeDomainProblemOperator. Removes duplicated code in both classes. More...

#include <ProblemOperatorBase.h>

Inheritance diagram for Moose::MFEM::ProblemOperatorBase:

Public Member Functions
	ProblemOperatorBase (MFEMProblem &problem)
virtual	~ProblemOperatorBase ()=default
virtual void	SetGridFunctions ()
virtual void	SetTestVariablesFromTrueVectors ()
virtual void	SetTrialVariablesFromTrueVectors ()
virtual void	Init (mfem::BlockVector &X)
virtual void	Solve ()=0

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

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

Detailed Description

Interface inherited by ProblemOperator and TimeDomainProblemOperator. Removes duplicated code in both classes.

Definition at line 18 of file ProblemOperatorBase.h.

Constructor & Destructor Documentation

ProblemOperatorBase()

Moose::MFEM::ProblemOperatorBase::ProblemOperatorBase

(

MFEMProblem &

problem

)

Definition at line 19 of file ProblemOperatorBase.C.

  : _problem(problem), _problem_data(problem.getProblemData())
{
}

~ProblemOperatorBase()

virtual Moose::MFEM::ProblemOperatorBase::~ProblemOperatorBase ( )

virtualdefault

Member Function Documentation

Init()

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

virtual

Reimplemented in Moose::MFEM::TimeDomainEquationSystemProblemOperator, and Moose::MFEM::EquationSystemProblemOperator.

Definition at line 44 of file ProblemOperatorBase.C.

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

{
  X.Update(_block_true_offsets);
  for (const auto i : index_range(_test_variables))
    X.GetBlock(i) = _test_variables[i]->GetTrueVector();
  // Sync the flags from sub-block vectors to global vector
  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(_test_variables))
    _test_variables[i]->MakeTRef(_test_variables[i]->ParFESpace(), X, _block_true_offsets[i]);
  _test_true_vector = &X;

  // This might seem silly but after making the tref the memory flags of the grid function and its
  // true vector are in an empty state other than the aliasing. This operation syncs the flags and
  // should be a no-op in terms of actual data transfer
  SetTestVariablesFromTrueVectors();
}

SetGridFunctions()

void Moose::MFEM::ProblemOperatorBase::SetGridFunctions ( )

virtual

Reimplemented in Moose::MFEM::TimeDomainEquationSystemProblemOperator, Moose::MFEM::EquationSystemProblemOperator, Moose::MFEM::TimeDomainProblemOperator, and Moose::MFEM::ProblemOperator.

Definition at line 25 of file ProblemOperatorBase.C.

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

{
  _test_variables = _problem_data.gridfunctions.Get(_test_var_names);
  _trial_variables = _problem_data.gridfunctions.Get(_trial_var_names);

  // Set operator size and block structure
  _block_true_offsets.SetSize(_trial_variables.size() + 1);
  _block_true_offsets[0] = 0;
  for (unsigned int ind = 0; ind < _trial_variables.size(); ++ind)
  {
    _block_true_offsets[ind + 1] = _trial_variables.at(ind)->ParFESpace()->TrueVSize();
  }
  _block_true_offsets.PartialSum();

  _true_x.Update(_block_true_offsets);
  _true_rhs.Update(_block_true_offsets);
}

SetTestVariablesFromTrueVectors()

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

virtual

Definition at line 65 of file ProblemOperatorBase.C.

Referenced by Moose::MFEM::TimeDomainEquationSystemProblemOperator::ImplicitSolve(), Init(), and Moose::MFEM::TimeDomainEquationSystemProblemOperator::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 ( )

virtual

Definition at line 80 of file ProblemOperatorBase.C.

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

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

Solve()

virtual void Moose::MFEM::ProblemOperatorBase::Solve ( )

pure virtual

Implemented in Moose::MFEM::TimeDomainEquationSystemProblemOperator, Moose::MFEM::EquationSystemProblemOperator, Moose::MFEM::TimeDomainProblemOperator, and Moose::MFEM::ProblemOperator.

Member Data Documentation

_block_true_offsets

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

Definition at line 30 of file ProblemOperatorBase.h.

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

_equation_system_operator

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

Definition at line 33 of file ProblemOperatorBase.h.

_problem

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

protected

Reference to the current problem.

Definition at line 37 of file ProblemOperatorBase.h.

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

_problem_data

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

protected

Definition at line 38 of file ProblemOperatorBase.h.

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

_test_true_vector

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

protected

Definition at line 44 of file ProblemOperatorBase.h.

Referenced by Init(), and SetTestVariablesFromTrueVectors().

_test_var_names

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

protected

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 SetGridFunctions(), Moose::MFEM::EquationSystemProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDomainEquationSystemProblemOperator::SetGridFunctions().

_test_variables

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

protected

Definition at line 43 of file ProblemOperatorBase.h.

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

_trial_var_names

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

protected

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 SetGridFunctions(), Moose::MFEM::EquationSystemProblemOperator::SetGridFunctions(), and Moose::MFEM::TimeDomainEquationSystemProblemOperator::SetGridFunctions().

_trial_variables

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

protected

Definition at line 49 of file ProblemOperatorBase.h.

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

_true_rhs

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

Definition at line 32 of file ProblemOperatorBase.h.

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

_true_x

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

Definition at line 32 of file ProblemOperatorBase.h.

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

---

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

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