DependencyResolverInterface Class Reference

Interface for sorting dependent vectors of objects. More...

#include <DependencyResolverInterface.h>

Inheritance diagram for DependencyResolverInterface:

Public Member Functions
	DependencyResolverInterface ()
	Constructor.
	DependencyResolverInterface (const DependencyResolverInterface &, const Moose::Kokkos::FunctorCopy &)
	Special constructor used for Kokkos functor copy during parallel dispatch.
virtual const std::set< std::string > &	getRequestedItems ()=0
	Return a set containing the names of items requested by the object.
virtual const std::set< std::string > &	getSuppliedItems ()=0
	Return a set containing the names of items owned by the object.

Static Public Member Functions
template<typename T >
static void	sort (typename std::vector< T > &vector)
	Given a vector, sort using the getRequested/SuppliedItems sets.
template<typename T >
static void	sortDFS (typename std::vector< T > &vector)
	Given a vector, sort using the depth-first search.
template<typename T , typename T2 , typename NameFunc >
static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func)
	A helper method for cyclic errors.
template<typename T , typename T2 >
static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Detailed Description

Interface for sorting dependent vectors of objects.

Definition at line 25 of file DependencyResolverInterface.h.

Constructor & Destructor Documentation

DependencyResolverInterface() [1/2]

DependencyResolverInterface::DependencyResolverInterface ( )

inline

Constructor.

Definition at line 31 of file DependencyResolverInterface.h.

{}

DependencyResolverInterface() [2/2]

DependencyResolverInterface::DependencyResolverInterface ( const DependencyResolverInterface &  , const Moose::Kokkos::FunctorCopy &    )

inline

Special constructor used for Kokkos functor copy during parallel dispatch.

Definition at line 37 of file DependencyResolverInterface.h.

  {
  }

Member Function Documentation

cyclicDependencyError() [1/2]

template<typename T , typename T2 >

void DependencyResolverInterface::cyclicDependencyError ( CyclicDependencyException< T2 > &  e, const std::string &  header  )

static

Definition at line 151 of file DependencyResolverInterface.h.

{
  cyclicDependencyError<T>(e, header, [](const auto & obj) { return static_cast<T>(obj)->name(); });
}

cyclicDependencyError() [2/2]

template<typename T , typename T2 , typename NameFunc >

void DependencyResolverInterface::cyclicDependencyError ( CyclicDependencyException< T2 > &  e, const std::string &  header, NameFunc &&  name_func  )

static

A helper method for cyclic errors.

Definition at line 134 of file DependencyResolverInterface.h.

{
  std::ostringstream oss;
 
  oss << header << ":\n";
  const auto cycle = e.getCyclicDependencies();
  std::vector<std::string> names(cycle.size());
  for (const auto i : index_range(cycle))
    names[i] = name_func(cycle[i]);
  oss << MooseUtils::join(names, " <- ");
  mooseError(oss.str());
}

getRequestedItems()

virtual const std::set< std::string > & DependencyResolverInterface::getRequestedItems ( )

pure virtual

Return a set containing the names of items requested by the object.

Implemented in ScalarInitialCondition, AuxKernelBase, AuxScalarKernel, FVInitialConditionBase, InitialConditionBase, Marker, MaterialBase, MFEMExecutedObject, and UserObjectBase.

getSuppliedItems()

virtual const std::set< std::string > & DependencyResolverInterface::getSuppliedItems ( )

pure virtual

Return a set containing the names of items owned by the object.

Implemented in ScalarInitialCondition, AuxKernelBase, AuxScalarKernel, FVInitialConditionBase, InitialConditionBase, Marker, MaterialBase, MFEMExecutedObject, and UserObjectBase.

sort()

template<typename T >

void DependencyResolverInterface::sort ( typename std::vector< T > &  vector )

static

Given a vector, sort using the getRequested/SuppliedItems sets.

Definition at line 79 of file DependencyResolverInterface.h.

{
  sortDFS(vector);
}

Referenced by TheWarehouse::prepare().

sortDFS()

template<typename T >

void DependencyResolverInterface::sortDFS ( typename std::vector< T > &  vector )

static

Given a vector, sort using the depth-first search.

Class that represents the dependency as a graph

Definition at line 86 of file DependencyResolverInterface.h.

{
  if (vector.size() <= 1)
    return;
 
  DependencyResolver<T> graph;
 
  // Map of suppliers: what is supplied -> by what object
  std::multimap<std::string, T> suppliers_map;
  for (auto & v : vector)
  {
    // Whether or not this object supplies something, we will always
    // add it as a node because we want to make sure that it gets returned
    graph.addNode(v);
 
    for (const auto & supplied_item : v->getSuppliedItems())
      suppliers_map.emplace(supplied_item, v);
  }
 
  // build the dependency graph
  for (auto & v : vector)
    for (const auto & requested_item : v->getRequestedItems())
    {
      const auto & [begin_it, end_it] = suppliers_map.equal_range(requested_item);
      for (const auto & [supplier_name, supplier_object] : as_range(begin_it, end_it))
      {
        libmesh_ignore(supplier_name);
 
        // We allow an object to have a circular dependency within itself; e.g. we choose to
        // trust a developer knows what they are doing within a single object
        if (supplier_object != v)
          graph.addEdge(supplier_object, v);
      }
    }
 
  const auto & sorted = graph.dfs();
 
  // The set here gets unique objects, as it's valid to pass in duplicates
  mooseAssert(sorted.size() == std::set<T>(vector.begin(), vector.end()).size(), "Size mismatch");
 
  vector = sorted;
}

Referenced by sort().

---

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

• include/interfaces/DependencyResolverInterface.h