DependencyResolverInterface Class Reference

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

#include <DependencyResolverInterface.h>

Inheritance diagram for DependencyResolverInterface:

Public Member Functions
	DependencyResolverInterface ()
	Constructor. More...
virtual const std::set< std::string > &	getRequestedItems ()=0
	Return a set containing the names of items requested by the object. More...
virtual const std::set< std::string > &	getSuppliedItems ()=0
	Return a set containing the names of items owned by the object. More...

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

Detailed Description

Interface for sorting dependent vectors of objects.

Definition at line 25 of file DependencyResolverInterface.h.

Constructor & Destructor Documentation

DependencyResolverInterface()

DependencyResolverInterface::DependencyResolverInterface ( )

inline

Constructor.

Definition at line 31 of file DependencyResolverInterface.h.

{}

Member Function Documentation

cyclicDependencyError()

template<typename T >

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

static

A helper method for cyclic errors.

Definition at line 95 of file DependencyResolverInterface.h.

{
  std::ostringstream oss;

  oss << header << ":\n";
  const typename std::multimap<T, T> & depends = e.getCyclicDependencies();
  for (typename std::multimap<T, T>::const_iterator it = depends.begin(); it != depends.end(); ++it)
    oss << (static_cast<T>(it->first))->name() << " -> " << (static_cast<T>(it->second))->name()
        << "\n";
  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 Material, AuxKernel, InitialConditionBase, Marker, ScalarInitialCondition, AuxScalarKernel, and GeneralUserObject.

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 Material, AuxKernel, InitialConditionBase, Marker, ScalarInitialCondition, AuxScalarKernel, and GeneralUserObject.

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 58 of file DependencyResolverInterface.h.

Referenced by TheWarehouse::prepare().

{
  DependencyResolver<T> resolver;

  typename std::vector<T>::iterator start = vector.begin();
  typename std::vector<T>::iterator end = vector.end();

  for (typename std::vector<T>::iterator iter = start; iter != end; ++iter)
  {
    const std::set<std::string> & requested_items = (*iter)->getRequestedItems();

    for (typename std::vector<T>::iterator iter2 = start; iter2 != end; ++iter2)
    {
      if (iter == iter2)
        continue;

      const std::set<std::string> & supplied_items = (*iter2)->getSuppliedItems();

      std::set<std::string> intersect;
      std::set_intersection(requested_items.begin(),
                            requested_items.end(),
                            supplied_items.begin(),
                            supplied_items.end(),
                            std::inserter(intersect, intersect.end()));

      // If the intersection isn't empty then there is a dependency here
      if (!intersect.empty())
        resolver.insertDependency(*iter, *iter2);
    }
  }

  // Sort based on dependencies
  std::stable_sort(start, end, resolver);
}

---

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

• include/interfaces/DependencyResolverInterface.h