LazyCoupleable Class Reference

Interface for objects that need coupling capabilities. More...

#include <LazyCoupleable.h>

Public Member Functions
	LazyCoupleable (const MooseObject *moose_object)
	Constructing the object. More...
virtual	~LazyCoupleable ()=default
void	setFEProblemPtr (FEProblemBase *fe_problem)
	Sets the FEProblem pointer which can (and is expected) to happen long after this interface is constructed. More...

Private Member Functions
void	init ()
unsigned int &	coupled (const std::string &var_name, unsigned int comp=0)
	Returns the index for a coupled variable by name. More...

Private Attributes
const InputParameters &	_l_parameters
const std::string &	_l_name
	The name of the object this interface is part of. More...
FEProblemBase *	_l_fe_problem
	Reference to FEProblemBase. More...
MooseApp &	_l_app
	Reference to the MooseApp. More...
std::map< std::string, std::unique_ptr< unsigned int > >	_coupled_var_numbers
	Coupled vars whose values we provide. More...

Detailed Description

Interface for objects that need coupling capabilities.

Definition at line 24 of file LazyCoupleable.h.

Constructor & Destructor Documentation

LazyCoupleable()

LazyCoupleable::LazyCoupleable

(

const MooseObject *

moose_object

)

Constructing the object.

Parameters

parameters	Parameters that come from constructing the object
nodal	true if we need to couple with nodal values, otherwise false

Definition at line 20 of file LazyCoupleable.C.

  : _l_parameters(moose_object->parameters()),
    _l_name(_l_parameters.get<std::string>("_object_name")),
    _l_fe_problem(nullptr),
    _l_app(moose_object->getMooseApp())
{
  for (const auto & var_name :
       as_range(std::make_pair(_l_parameters.coupledVarsBegin(), _l_parameters.coupledVarsEnd())))
    _coupled_var_numbers[var_name] = std::make_unique<unsigned int>(0);
}

~LazyCoupleable()

virtual LazyCoupleable::~LazyCoupleable ( )

virtualdefault

Member Function Documentation

coupled()

unsigned int & LazyCoupleable::coupled ( const std::string &  var_name, unsigned int  comp = 0  )

private

Returns the index for a coupled variable by name.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Index of coupled variable, if this is an optionally coupled variable that wasn't provided this will return a unique "invalid" index.

Definition at line 56 of file LazyCoupleable.C.

{
  if (!_l_fe_problem)
  {
    auto executioner_ptr = _l_app.getExecutioner();
    if (!executioner_ptr)
      mooseError("Executioner is nullptr in LazyCoupleable. You cannot call the \"coupled\" method "
                 "until the add_algebraic_rm task");
    setFEProblemPtr(&executioner_ptr->feProblem());
  }

  const auto & var_pair = _coupled_var_numbers.find(var_name);
  mooseAssert(var_pair != _coupled_var_numbers.end(), "Internal error in LazyCoupleable");

  return *(var_pair->second);
}

init()

void LazyCoupleable::init ( )

private

Definition at line 39 of file LazyCoupleable.C.

Referenced by setFEProblemPtr().

{
  for (const auto & var_pair : _coupled_var_numbers)
  {
    if (!_l_fe_problem->hasVariable(var_pair.first))
      mooseError("Unable to find variable ", var_pair.first);

    auto & moose_var = _l_fe_problem->getVariable(
        0, var_pair.first, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
    if (moose_var.kind() == Moose::VAR_SOLVER)
      *(var_pair.second) = moose_var.number();
    else
      *(var_pair.second) = std::numeric_limits<unsigned int>::max() - moose_var.number();
  }
}

setFEProblemPtr()

void LazyCoupleable::setFEProblemPtr

(

FEProblemBase *

fe_problem

)

Sets the FEProblem pointer which can (and is expected) to happen long after this interface is constructed.

Once this pointer is set, this interface can retrieve the information it requires from the underlying class and the internal methods can be called. Errors are throw if internal methods are called when this pointer is nullptr.

Definition at line 32 of file LazyCoupleable.C.

Referenced by coupled().

{
  _l_fe_problem = fe_problem;
  init();
}

Member Data Documentation

_coupled_var_numbers

std::map<std::string, std::unique_ptr<unsigned int> > LazyCoupleable::_coupled_var_numbers

private

Coupled vars whose values we provide.

Definition at line 69 of file LazyCoupleable.h.

Referenced by coupled(), init(), and LazyCoupleable().

_l_app

MooseApp& LazyCoupleable::_l_app

private

Reference to the MooseApp.

Definition at line 66 of file LazyCoupleable.h.

Referenced by coupled().

_l_fe_problem

FEProblemBase* LazyCoupleable::_l_fe_problem

private

Reference to FEProblemBase.

Definition at line 63 of file LazyCoupleable.h.

Referenced by coupled(), init(), and setFEProblemPtr().

_l_name

const std::string& LazyCoupleable::_l_name

private

The name of the object this interface is part of.

Definition at line 60 of file LazyCoupleable.h.

_l_parameters

const InputParameters& LazyCoupleable::_l_parameters

private

Definition at line 57 of file LazyCoupleable.h.

Referenced by LazyCoupleable().

---

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

• include/interfaces/LazyCoupleable.h
• src/interfaces/LazyCoupleable.C