Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
ExecuteMooseObjectWarehouse< T > Class Template Reference

A class for storing MooseObjects based on execution flag. More...

#include <BoundaryElemIntegrityCheckThread.h>

Inheritance diagram for ExecuteMooseObjectWarehouse< T >:
[legend]

Public Member Functions

 ExecuteMooseObjectWarehouse (const ExecFlagEnum &flags, bool threaded=true)
 Constructor. More...
 
virtual ~ExecuteMooseObjectWarehouse ()
 
void addObject (std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true) override
 Adds an object to the storage structure. More...
 
void updateActive (THREAD_ID tid=0) override
 Updates the active objects storage. More...
 
void sort (THREAD_ID tid=0)
 Performs a sort using the DependencyResolver. More...
 
bool hasExecType (const ExecFlagType &exec_flag)
 
bool hasVariableObjects (unsigned int variable_id, THREAD_ID tid=0) const
 Checks for whether this warehouse has objects for a given variable. More...
 
unsigned int size (THREAD_ID tid=0) const
 Return how many kernels we store in the current warehouse. More...
 
std::set< SubdomainIDgetActiveBlocks (THREAD_ID tid=0) const
 Return a set of active SubdomainsIDs. More...
 
void subdomainsCovered (std::set< SubdomainID > &subdomains_covered, std::set< std::string > &unique_variables, THREAD_ID tid=0) const
 Populates a set of covered subdomains and the associated variable names. More...
 
THREAD_ID numThreads () const
 Return the number of threads. More...
 
std::string activeObjectsToFormattedString (THREAD_ID tid=0, const std::string &prefix="[DBG]") const
 Output the active content of the warehouse to a string, meant to be output to the console. More...
 
const MooseObjectWarehouse< T > & operator[] (ExecFlagType exec_flag) const
 Retrieve shared pointers for the given thread and execution type for all/active objects. More...
 
MooseObjectWarehouse< T > & operator[] (ExecFlagType exec_flag)
 
std::map< ExecFlagType, MooseObjectWarehouse< T > >::const_iterator begin () const
 Provide access to begin/end iterators of the underlying map of execution flags. More...
 
std::map< ExecFlagType, MooseObjectWarehouse< T > >::const_iterator end () const
 
void jacobianSetup (THREAD_ID tid=0) const override
 Convenience methods for calling object setup methods. More...
 
void residualSetup (THREAD_ID tid=0) const override
 
void setup (const ExecFlagType &exec_flag, THREAD_ID tid=0) const
 
virtual void initialSetup (THREAD_ID tid=0) const
 Convenience methods for calling object setup methods. More...
 
virtual void timestepSetup (THREAD_ID tid=0) const
 
virtual void customSetup (const ExecFlagType &exec_type, THREAD_ID tid=0) const
 
virtual void subdomainSetup (THREAD_ID tid=0) const
 
virtual void subdomainSetup (SubdomainID id, THREAD_ID tid=0) const
 
bool hasActiveVariableBlockObjects (unsigned int variable_id, SubdomainID block_id, THREAD_ID tid=0) const
 Methods for checking/getting variable kernels for a variable and SubdomainID. More...
 
const std::vector< std::shared_ptr< T > > & getActiveVariableBlockObjects (unsigned int variable_id, SubdomainID block_id, THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< T > > & getObjects (THREAD_ID tid=0) const
 Retrieve complete vector to the all/block/boundary restricted objects for a given thread. More...
 
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getBlockObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< T > > & getBlockObjects (SubdomainID id, THREAD_ID tid=0) const
 
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getBoundaryObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< T > > & getBoundaryObjects (BoundaryID id, THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< T > > & getActiveObjects (THREAD_ID tid=0) const
 Retrieve complete vector to the active all/block/boundary restricted objects for a given thread. More...
 
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< T > > & getActiveBlockObjects (SubdomainID id, THREAD_ID tid=0) const
 
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getActiveBoundaryObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< T > > & getActiveBoundaryObjects (BoundaryID id, THREAD_ID tid=0) const
 
bool hasObjects (THREAD_ID tid=0) const
 Convenience functions for determining if objects exist. More...
 
bool hasActiveObjects (THREAD_ID tid=0) const
 
bool hasActiveBlockObjects (THREAD_ID tid=0) const
 
bool hasActiveBlockObjects (SubdomainID id, THREAD_ID tid=0) const
 
bool hasActiveBoundaryObjects (THREAD_ID tid=0) const
 
bool hasActiveBoundaryObjects (BoundaryID id, THREAD_ID tid=0) const
 
bool hasBoundaryObjects (BoundaryID id, THREAD_ID tid=0) const
 
bool hasActiveObject (const std::string &name, THREAD_ID tid=0) const
 Convenience functions for checking/getting specific objects. More...
 
std::shared_ptr< T > getObject (const std::string &name, THREAD_ID tid=0) const
 
std::shared_ptr< T > getActiveObject (const std::string &name, THREAD_ID tid=0) const
 
void updateVariableDependency (std::set< MooseVariableFieldBase *> &needed_moose_vars, THREAD_ID tid=0) const
 Update variable dependency vector. More...
 
void updateBlockVariableDependency (SubdomainID id, std::set< MooseVariableFieldBase *> &needed_moose_vars, THREAD_ID tid=0) const
 
void updateBoundaryVariableDependency (std::set< MooseVariableFieldBase *> &needed_moose_vars, THREAD_ID tid=0) const
 
void updateBoundaryVariableDependency (BoundaryID id, std::set< MooseVariableFieldBase *> &needed_moose_vars, THREAD_ID tid=0) const
 
void updateBlockFEVariableCoupledVectorTagDependency (SubdomainID id, std::set< TagID > &needed_fe_var_vector_tags, THREAD_ID tid=0) const
 Update FE variable coupleable vector tag vector. More...
 
void updateBoundaryFEVariableCoupledVectorTagDependency (BoundaryID id, std::set< TagID > &needed_fe_var_vector_tags, THREAD_ID tid=0) const
 
void updateMatPropDependency (std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
 Update material property dependency vector. More...
 
void updateBlockMatPropDependency (SubdomainID id, std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
 
void updateBoundaryMatPropDependency (std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
 
void updateBoundaryMatPropDependency (BoundaryID id, std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
 

Protected Member Functions

std::map< ExecFlagType, MooseObjectWarehouse< T > >::iterator getStorageHelper (std::map< ExecFlagType, MooseObjectWarehouse< T >> &objects, ExecFlagType exec_flag) const
 A helper method for extracting objects from the various storage containers. More...
 
void checkThreadID (THREAD_ID tid) const
 Calls assert on thread id. More...
 

Static Protected Member Functions

static void updateActiveHelper (std::vector< std::shared_ptr< T >> &active, const std::vector< std::shared_ptr< T >> &all)
 Helper method for updating active vectors. More...
 
static void sortHelper (std::vector< std::shared_ptr< T >> &objects)
 Helper method for sorting vectors of objects. More...
 
static void updateVariableDependencyHelper (std::set< MooseVariableFieldBase *> &needed_moose_vars, const std::vector< std::shared_ptr< T >> &objects)
 Helper method for updating variable dependency vector. More...
 
static void updateFEVariableCoupledVectorTagDependencyHelper (std::set< TagID > &needed_fe_var_vector_tags, const std::vector< std::shared_ptr< T >> &objects)
 Helper method for updating FE variable coupleable vector tag vector. More...
 
static void updateMatPropDependencyHelper (std::unordered_set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< T >> &objects)
 Helper method for updating material property dependency vector. More...
 

Protected Attributes

std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects
 
std::map< unsigned int, MooseObjectWarehouse< T > > _variable_objects
 Variable based storage. More...
 
const THREAD_ID _num_threads
 Convenience member storing the number of threads used for storage (1 or libMesh::n_threads) More...
 
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
 Storage container for the ALL pointers (THREAD_ID on outer vector) More...
 
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
 All active objects (THREAD_ID on outer vector) More...
 
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _all_block_objects
 
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _active_block_objects
 Active block restricted objects (THREAD_ID on outer vector) More...
 
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _all_boundary_objects
 
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _active_boundary_objects
 Active boundary restricted objects (THREAD_ID on outer vector) More...
 

Detailed Description

template<typename T>
class ExecuteMooseObjectWarehouse< T >

A class for storing MooseObjects based on execution flag.

Note: The global list of objects, those accessed via the "get" methods of this class, are not sorted when the sort method is called. This is because cyclic errors occur even when the execution flags differ.

Definition at line 21 of file BoundaryElemIntegrityCheckThread.h.

Constructor & Destructor Documentation

◆ ExecuteMooseObjectWarehouse()

template<typename T >
ExecuteMooseObjectWarehouse< T >::ExecuteMooseObjectWarehouse ( const ExecFlagEnum flags,
bool  threaded = true 
)

Constructor.

Parameters
threadedTrue enables threaded object storage (default).

Definition at line 105 of file ExecuteMooseObjectWarehouse.h.

107  : MooseObjectWarehouse<T>(threaded)
108 {
109  // Initialize the active/all data structures with the correct map entries and empty vectors
110  for (const auto & flag : flags.items())
111  _execute_objects.insert(std::make_pair(flag, MooseObjectWarehouse<T>(threaded)));
112 }
A storage container for MooseObjects that inherit from SetupInterface.
Definition: HDGKernel.h:19
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects
const std::set< ExecFlagType > & items() const
Reference the all the available items.
Definition: ExecFlagEnum.h:71

◆ ~ExecuteMooseObjectWarehouse()

template<typename T >
ExecuteMooseObjectWarehouse< T >::~ExecuteMooseObjectWarehouse ( )
virtual

Definition at line 115 of file ExecuteMooseObjectWarehouse.h.

116 {
117 }

Member Function Documentation

◆ activeObjectsToFormattedString()

template<typename T >
std::string MooseObjectWarehouseBase< T >::activeObjectsToFormattedString ( THREAD_ID  tid = 0,
const std::string &  prefix = "[DBG]" 
) const
inherited

Output the active content of the warehouse to a string, meant to be output to the console.

Parameters
tidthe thread id
prefixa string to prepend to the string

Definition at line 761 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearThread::printBlockExecutionInformation(), NonlinearThread::printBoundaryExecutionInformation(), ComputeNodalKernelBcsThread::printGeneralExecutionInformation(), ComputeNodalKernelsThread::printGeneralExecutionInformation(), ComputeNodalKernelBCJacobiansThread::printGeneralExecutionInformation(), and ComputeNodalKernelJacobiansThread::printGeneralExecutionInformation().

763 {
764  std::vector<std::string> output;
765  for (const auto & object : _active_objects[tid])
766  output.push_back(object->name());
767  return ConsoleUtils::formatString(MooseUtils::join(output, " "), prefix);
768 }
std::string formatString(std::string message, const std::string &prefix)
Add new lines and prefixes to a string for pretty display in output NOTE: This makes a copy of the st...
Definition: ConsoleUtils.C:539
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)
std::string join(const T &strings, const std::string &delimiter)
Python like join function for strings.
Definition: MooseUtils.h:146

◆ addObject()

template<typename T>
void ExecuteMooseObjectWarehouse< T >::addObject ( std::shared_ptr< T >  object,
THREAD_ID  tid = 0,
bool  recurse = true 
)
overridevirtual

Adds an object to the storage structure.

Parameters
objectA shared pointer to the object being added

Reimplemented from MooseObjectWarehouse< T >.

Definition at line 202 of file ExecuteMooseObjectWarehouse.h.

Referenced by FEProblemBase::addMultiApp(), AuxiliarySystem::addScalarKernel(), FEProblemBase::addTransfer(), and FEProblemBase::addUserObject().

205 {
206  // Update list of all objects
208 
209  // Update the execute flag lists of objects
210  if (const auto ptr = std::dynamic_pointer_cast<SetupInterface>(object))
211  for (const auto & flag : ptr->getExecuteOnEnum())
212  _execute_objects[flag].addObject(object, tid);
213  else
214  mooseError("The object being added (",
215  object->name(),
216  ") must inherit from SetupInterface to be added to the ExecuteMooseObjectWarehouse "
217  "container.");
218 }
void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true) override
Adds an object to the storage structure.
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects
virtual void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true) override
Adds an object to the storage structure.

◆ begin()

template<typename T>
std::map<ExecFlagType, MooseObjectWarehouse<T> >::const_iterator ExecuteMooseObjectWarehouse< T >::begin ( ) const
inline

Provide access to begin/end iterators of the underlying map of execution flags.

Definition at line 60 of file ExecuteMooseObjectWarehouse.h.

61  {
62  return _execute_objects.begin();
63  }
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects

◆ checkThreadID()

template<typename T>
void MooseObjectWarehouseBase< T >::checkThreadID ( THREAD_ID  tid) const
inlineprotectedinherited

Calls assert on thread id.

Definition at line 792 of file MooseObjectWarehouseBase.h.

793 {
794  mooseAssert(tid < _num_threads,
795  "Attempting to access a thread id ("
796  << tid << ") greater than the number allowed by the storage item ("
797  << _num_threads << ")");
798 }
const THREAD_ID _num_threads
Convenience member storing the number of threads used for storage (1 or libMesh::n_threads) ...

◆ customSetup()

template<typename T >
void MooseObjectWarehouse< T >::customSetup ( const ExecFlagType exec_type,
THREAD_ID  tid = 0 
) const
virtualinherited

Definition at line 176 of file MooseObjectWarehouse.h.

Referenced by AuxiliarySystem::customSetup(), NonlinearSystemBase::customSetup(), and FEProblemBase::customSetup().

177 {
178  checkThreadID(tid);
179  for (const auto & object : _active_objects[tid])
180  object->customSetup(exec_type);
181 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ end()

template<typename T>
std::map<ExecFlagType, MooseObjectWarehouse<T> >::const_iterator ExecuteMooseObjectWarehouse< T >::end ( ) const
inline

Definition at line 64 of file ExecuteMooseObjectWarehouse.h.

65  {
66  return _execute_objects.end();
67  }
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects

◆ getActiveBlockObjects() [1/2]

template<typename T >
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & MooseObjectWarehouseBase< T >::getActiveBlockObjects ( THREAD_ID  tid = 0) const
inlineinherited

◆ getActiveBlockObjects() [2/2]

template<typename T >
const std::vector< std::shared_ptr< T > > & MooseObjectWarehouseBase< T >::getActiveBlockObjects ( SubdomainID  id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 435 of file MooseObjectWarehouseBase.h.

436 {
437  checkThreadID(tid);
438  const auto iter = _active_block_objects[tid].find(id);
439  mooseAssert(iter != _active_block_objects[tid].end(),
440  "Unable to located active block objects for the given id: " << id << ".");
441  return iter->second;
442 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getActiveBlocks()

template<typename T >
std::set< SubdomainID > MooseObjectWarehouseBase< T >::getActiveBlocks ( THREAD_ID  tid = 0) const
inherited

Return a set of active SubdomainsIDs.

Definition at line 535 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::checkProblemIntegrity().

536 {
537  checkThreadID(tid);
538  std::set<SubdomainID> ids;
539  for (const auto & object_pair : _active_block_objects[tid])
540  ids.insert(object_pair.first);
541  return ids;
542 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getActiveBoundaryObjects() [1/2]

template<typename T >
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & MooseObjectWarehouseBase< T >::getActiveBoundaryObjects ( THREAD_ID  tid = 0) const
inlineinherited

◆ getActiveBoundaryObjects() [2/2]

template<typename T >
const std::vector< std::shared_ptr< T > > & MooseObjectWarehouseBase< T >::getActiveBoundaryObjects ( BoundaryID  id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 416 of file MooseObjectWarehouseBase.h.

417 {
418  checkThreadID(tid);
419  const auto iter = _active_boundary_objects[tid].find(id);
420  mooseAssert(iter != _active_boundary_objects[tid].end(),
421  "Unable to located active boundary objects for the given id: " << id << ".");
422  return iter->second;
423 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ getActiveObject()

template<typename T >
std::shared_ptr< T > MooseObjectWarehouseBase< T >::getActiveObject ( const std::string &  name,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 524 of file MooseObjectWarehouseBase.h.

Referenced by DerivativeParsedMaterialHelperTempl< is_ad >::assembleDerivatives(), FEProblemBase::getConvergence(), FEProblemBase::getFunction(), FEProblemBase::getMaterial(), FEProblemBase::getMeshDivision(), NonlinearSystemBase::getSplit(), LibtorchArtificialNeuralNetParameters::initialSetup(), and LibtorchControlValuePostprocessor::initialSetup().

525 {
526  checkThreadID(tid);
527  for (const auto & object : _active_objects[tid])
528  if (object->name() == name)
529  return object;
530  mooseError("Unable to locate active object: ", name, ".");
531 }
std::string name(const ElemQuality q)
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ getActiveObjects()

template<typename T >
const std::vector< std::shared_ptr< T > > & MooseObjectWarehouseBase< T >::getActiveObjects ( THREAD_ID  tid = 0) const
inlineinherited

Retrieve complete vector to the active all/block/boundary restricted objects for a given thread.

Parameters
tidThe thread id to retrieve objects from

Definition at line 400 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::backupMultiApps(), NonlinearEigenSystem::checkIntegrity(), FEProblemBase::checkProblemIntegrity(), NonlinearSystemBase::computeDamping(), NonlinearSystemBase::computeDiracContributions(), FEProblemBase::computeIndicators(), FEProblemBase::computeMarkers(), FEProblemBase::computeMultiAppsDT(), NonlinearSystemBase::computeResidualInternal(), NonlinearSystemBase::computeScalarKernelsJacobians(), AuxiliarySystem::computeScalarVars(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), FEProblemBase::finalizeMultiApps(), FEProblemBase::finishMultiAppStep(), ConstraintWarehouse::getActiveNodalConstraints(), FEProblemBase::getConvergenceObjects(), FEProblemBase::getTransfers(), FEProblemBase::incrementMultiAppTStep(), FEProblemBase::initialSetup(), ComputeElemDampingThread::onElement(), ComputeDiracThread::onElement(), ComputeNodalDampingThread::onNode(), FEProblemBase::postExecute(), FEProblemBase::projectInitialConditionOnCustomRange(), FEProblemBase::projectSolution(), FEProblemBase::restoreMultiApps(), and AuxiliarySystem::setScalarVariableCoupleableTags().

401 {
402  checkThreadID(tid);
403  return _active_objects[tid];
404 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ getActiveVariableBlockObjects()

template<typename T >
const std::vector< std::shared_ptr< T > > & MooseObjectWarehouse< T >::getActiveVariableBlockObjects ( unsigned int  variable_id,
SubdomainID  block_id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 143 of file MooseObjectWarehouse.h.

Referenced by ComputeFullJacobianThread::computeOnElement().

146 {
147  checkThreadID(tid);
148  const auto iter = _variable_objects.find(variable_id);
149  mooseAssert(iter != _variable_objects.end(),
150  "Unable to locate variable kernels for the given variable id: " << variable_id
151  << ".");
152  return iter->second.getActiveBlockObjects(block_id, tid);
153 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::map< unsigned int, MooseObjectWarehouse< T > > _variable_objects
Variable based storage.

◆ getBlockObjects() [1/2]

template<typename T >
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & MooseObjectWarehouseBase< T >::getBlockObjects ( THREAD_ID  tid = 0) const
inlineinherited

Definition at line 381 of file MooseObjectWarehouseBase.h.

Referenced by MaterialPropertyDebugOutput::printMaterialMap().

382 {
383  checkThreadID(tid);
384  return _all_block_objects[tid];
385 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _all_block_objects
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getBlockObjects() [2/2]

template<typename T >
const std::vector< std::shared_ptr< T > > & MooseObjectWarehouseBase< T >::getBlockObjects ( SubdomainID  id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 389 of file MooseObjectWarehouseBase.h.

390 {
391  checkThreadID(tid);
392  const auto iter = _all_block_objects[tid].find(id);
393  mooseAssert(iter != _all_block_objects[tid].end(),
394  "Unable to located active block objects for the given id: " << id << ".");
395  return iter->second;
396 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _all_block_objects
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getBoundaryObjects() [1/2]

template<typename T >
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & MooseObjectWarehouseBase< T >::getBoundaryObjects ( THREAD_ID  tid = 0) const
inlineinherited

Definition at line 354 of file MooseObjectWarehouseBase.h.

Referenced by ComputeFullJacobianThread::computeOnBoundary(), and MaterialPropertyDebugOutput::printMaterialMap().

355 {
356  checkThreadID(tid);
357  return _all_boundary_objects[tid];
358 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _all_boundary_objects

◆ getBoundaryObjects() [2/2]

template<typename T >
const std::vector< std::shared_ptr< T > > & MooseObjectWarehouseBase< T >::getBoundaryObjects ( BoundaryID  id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 370 of file MooseObjectWarehouseBase.h.

371 {
372  checkThreadID(tid);
373  const auto iter = _all_boundary_objects[tid].find(id);
374  mooseAssert(iter != _all_boundary_objects[tid].end(),
375  "Unable to located active boundary objects for the given id: " << id << ".");
376  return iter->second;
377 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _all_boundary_objects

◆ getObject()

template<typename T >
std::shared_ptr< T > MooseObjectWarehouseBase< T >::getObject ( const std::string &  name,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 513 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::getMultiApp().

514 {
515  checkThreadID(tid);
516  for (const auto & object : _all_objects[tid])
517  if (object->name() == name)
518  return object;
519  mooseError("Unable to locate object: ", name, ".");
520 }
std::string name(const ElemQuality q)
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getObjects()

template<typename T >
const std::vector< std::shared_ptr< T > > & MooseObjectWarehouseBase< T >::getObjects ( THREAD_ID  tid = 0) const
inlineinherited

Retrieve complete vector to the all/block/boundary restricted objects for a given thread.

Parameters
tidThe thread id to retrieve objects from

Definition at line 346 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::checkNonlocalCoupling(), MooseApp::errorCheck(), MooseObjectTagWarehouse< DiracKernelBase >::getMatrixTagObjectWarehouse(), MooseObjectTagWarehouse< DiracKernelBase >::getMatrixTagsObjectWarehouse(), MooseObjectTagWarehouse< DiracKernelBase >::getVectorTagObjectWarehouse(), MooseObjectTagWarehouse< DiracKernelBase >::getVectorTagsObjectWarehouse(), HDGKernel::initialSetup(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), FEProblemBase::setActiveMaterialProperties(), and FEProblemBase::setNonlocalCouplingMatrix().

347 {
348  checkThreadID(tid);
349  return _all_objects[tid];
350 }
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getStorageHelper()

template<typename T>
std::map<ExecFlagType, MooseObjectWarehouse<T> >::iterator ExecuteMooseObjectWarehouse< T >::getStorageHelper ( std::map< ExecFlagType, MooseObjectWarehouse< T >> &  objects,
ExecFlagType  exec_flag 
) const
protected

A helper method for extracting objects from the various storage containers.

◆ hasActiveBlockObjects() [1/2]

template<typename T >
bool MooseObjectWarehouseBase< T >::hasActiveBlockObjects ( THREAD_ID  tid = 0) const
inherited

Definition at line 462 of file MooseObjectWarehouseBase.h.

Referenced by AuxiliarySystem::computeElementalVarsHelper(), NonlinearSystemBase::computeJacobianInternal(), AuxiliarySystem::computeMortarNodalVars(), AuxiliarySystem::computeNodalVarsHelper(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnInternalFace(), NonlinearSystemBase::computeResidualInternal(), BlockRestrictable::hasBlockMaterialPropertyHelper(), ComputeMarkerThread::onElement(), ComputeIndicatorThread::onElement(), ComputeMaterialsObjectThread::onElement(), ProjectMaterialProperties::onElement(), ComputeIndicatorThread::onInternalSide(), NonlinearThread::onInternalSide(), ComputeNodalKernelsThread::onNode(), ComputeNodalKernelJacobiansThread::onNode(), ComputeInitialConditionThread::operator()(), ComputeFVInitialConditionThread::operator()(), ComputeJacobianBlocksThread::postInternalSide(), FEProblemBase::prepareMaterials(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeDiracThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), and FEProblemBase::reinitMaterials().

463 {
464  checkThreadID(tid);
465  bool has_active_block_objects = false;
466  for (const auto & object_pair : _active_block_objects[tid])
467  has_active_block_objects |= !(object_pair.second.empty());
468  return has_active_block_objects;
469 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ hasActiveBlockObjects() [2/2]

template<typename T >
bool MooseObjectWarehouseBase< T >::hasActiveBlockObjects ( SubdomainID  id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 473 of file MooseObjectWarehouseBase.h.

474 {
475  checkThreadID(tid);
476  const auto iter = _active_block_objects[tid].find(id);
477  return iter != _active_block_objects[tid].end();
478 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ hasActiveBoundaryObjects() [1/2]

template<typename T >
bool MooseObjectWarehouseBase< T >::hasActiveBoundaryObjects ( THREAD_ID  tid = 0) const
inherited

Definition at line 482 of file MooseObjectWarehouseBase.h.

Referenced by HDGKernel::assemble(), AuxiliarySystem::computeElementalVarsHelper(), NonlinearSystemBase::computeJacobianBlocks(), NonlinearSystemBase::computeJacobianInternal(), AuxiliarySystem::computeMortarNodalVars(), NonlinearSystemBase::computeNodalBCs(), NonlinearSystemBase::computeNodalBCsResidualAndJacobian(), AuxiliarySystem::computeNodalVarsHelper(), ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnInterface(), NonlinearSystemBase::computeResidualInternal(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), NonlinearSystemBase::needBoundaryMaterialOnSide(), NonlinearSystemBase::needInterfaceMaterialOnSide(), FEProblemBase::needInterfaceMaterialOnSide(), ComputeMaterialsObjectThread::onBoundary(), NonlinearThread::onBoundary(), ComputeMaterialsObjectThread::onInterface(), NonlinearThread::onInterface(), ComputeBoundaryInitialConditionThread::onNode(), ComputeNodalKernelBcsThread::onNode(), ComputeNodalKernelBCJacobiansThread::onNode(), NonlinearThread::printBoundaryExecutionInformation(), ComputeNodalKernelBCJacobiansThread::printGeneralExecutionInformation(), FEProblemBase::reinitMaterialsBoundary(), FEProblemBase::reinitMaterialsInterface(), and NonlinearSystemBase::setInitialSolution().

483 {
484  checkThreadID(tid);
485  bool has_active_boundary_objects = false;
486  for (const auto & object_pair : _active_boundary_objects[tid])
487  has_active_boundary_objects |= !(object_pair.second.empty());
488  return has_active_boundary_objects;
489 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ hasActiveBoundaryObjects() [2/2]

template<typename T >
bool MooseObjectWarehouseBase< T >::hasActiveBoundaryObjects ( BoundaryID  id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 493 of file MooseObjectWarehouseBase.h.

494 {
495  checkThreadID(tid);
496  const auto iter = _active_boundary_objects[tid].find(id);
497  return iter != _active_boundary_objects[tid].end();
498 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ hasActiveObject()

template<typename T >
bool MooseObjectWarehouseBase< T >::hasActiveObject ( const std::string &  name,
THREAD_ID  tid = 0 
) const
inherited

Convenience functions for checking/getting specific objects.

Definition at line 502 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::hasConvergence(), FEProblemBase::hasFunction(), and FEProblemBase::hasMultiApp().

503 {
504  checkThreadID(tid);
505  for (const auto & object : _active_objects[tid])
506  if (object->name() == name)
507  return true;
508  return false;
509 }
std::string name(const ElemQuality q)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ hasActiveObjects()

template<typename T >
bool MooseObjectWarehouseBase< T >::hasActiveObjects ( THREAD_ID  tid = 0) const
inherited

Definition at line 454 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearEigenSystem::checkIntegrity(), NonlinearSystemBase::checkKernelCoverage(), NonlinearSystemBase::computeDamping(), NonlinearSystemBase::computeDiracContributions(), FEProblemBase::computeIndicators(), NonlinearSystemBase::computeJacobianInternal(), FEProblemBase::computeMarkers(), NonlinearSystemBase::computeResidualInternal(), NonlinearSystemBase::computeScalarKernelsJacobians(), AuxiliarySystem::computeScalarVars(), NonlinearSystemBase::containsTimeKernel(), FEProblemBase::execMultiAppTransfers(), ConstraintWarehouse::hasActiveNodalConstraints(), FEProblemBase::hasMultiApps(), HDGPrimalSolutionUpdateThread::HDGPrimalSolutionUpdateThread(), FEProblemBase::initialSetup(), ElementSubdomainModifierBase::modify(), NonlinearSystem::precheck(), ComputeNodalKernelBcsThread::printGeneralExecutionInformation(), ComputeNodalKernelsThread::printGeneralExecutionInformation(), ComputeNodalKernelJacobiansThread::printGeneralExecutionInformation(), FEProblemBase::projectInitialConditionOnCustomRange(), FEProblemBase::projectSolution(), and FEProblemBase::timestepSetup().

455 {
456  checkThreadID(tid);
457  return !_active_objects[tid].empty();
458 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ hasActiveVariableBlockObjects()

template<typename T >
bool MooseObjectWarehouse< T >::hasActiveVariableBlockObjects ( unsigned int  variable_id,
SubdomainID  block_id,
THREAD_ID  tid = 0 
) const
inherited

Methods for checking/getting variable kernels for a variable and SubdomainID.

Definition at line 133 of file MooseObjectWarehouse.h.

Referenced by ComputeFullJacobianThread::computeOnElement().

136 {
137  auto iter = _variable_objects.find(variable_id);
138  return (iter != _variable_objects.end() && iter->second.hasActiveBlockObjects(block_id, tid));
139 }
std::map< unsigned int, MooseObjectWarehouse< T > > _variable_objects
Variable based storage.

◆ hasBoundaryObjects()

template<typename T >
bool MooseObjectWarehouseBase< T >::hasBoundaryObjects ( BoundaryID  id,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 362 of file MooseObjectWarehouseBase.h.

363 {
364  checkThreadID(tid);
365  return _all_boundary_objects[tid].find(id) != _all_boundary_objects[tid].end();
366 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _all_boundary_objects

◆ hasExecType()

template<typename T>
bool ExecuteMooseObjectWarehouse< T >::hasExecType ( const ExecFlagType exec_flag)
inline

Definition at line 92 of file ExecuteMooseObjectWarehouse.h.

92 { return _execute_objects.count(exec_flag) > 0; }
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects

◆ hasObjects()

template<typename T >
bool MooseObjectWarehouseBase< T >::hasObjects ( THREAD_ID  tid = 0) const
inherited

Convenience functions for determining if objects exist.

Definition at line 446 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::initialSetup(), and NonlinearSystem::preInit().

447 {
448  checkThreadID(tid);
449  return !_all_objects[tid].empty();
450 }
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ hasVariableObjects()

template<typename T >
bool MooseObjectWarehouse< T >::hasVariableObjects ( unsigned int  variable_id,
THREAD_ID  tid = 0 
) const
inherited

Checks for whether this warehouse has objects for a given variable.

Definition at line 125 of file MooseObjectWarehouse.h.

Referenced by ExplicitTimeIntegrator::initialSetup().

126 {
127  auto iter = _variable_objects.find(variable_id);
128  return (iter != _variable_objects.end() && iter->second.hasObjects(tid));
129 }
std::map< unsigned int, MooseObjectWarehouse< T > > _variable_objects
Variable based storage.

◆ initialSetup()

template<typename T >
void MooseObjectWarehouse< T >::initialSetup ( THREAD_ID  tid = 0) const
virtualinherited

Convenience methods for calling object setup methods.

Reimplemented in MaterialWarehouse.

Definition at line 157 of file MooseObjectWarehouse.h.

Referenced by MaterialWarehouse::initialSetup(), AuxiliarySystem::initialSetup(), NonlinearSystemBase::initialSetup(), and FEProblemBase::initialSetup().

158 {
159  checkThreadID(tid);
160  // Initial Setup should be called on all objects because they may become active later
161  for (const auto & object : _all_objects[tid])
162  object->initialSetup();
163 }
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ jacobianSetup()

template<typename T >
void ExecuteMooseObjectWarehouse< T >::jacobianSetup ( THREAD_ID  tid = 0) const
overridevirtual

Convenience methods for calling object setup methods.

Limits call to these methods only to objects being executed on linear/nonlinear iterations.

Reimplemented from MooseObjectWarehouse< T >.

Definition at line 165 of file ExecuteMooseObjectWarehouse.h.

Referenced by AuxiliarySystem::jacobianSetup().

166 {
167  checkThreadID(tid);
168  const auto iter = _execute_objects.find(EXEC_NONLINEAR);
169  if (iter != _execute_objects.end())
170  iter->second.jacobianSetup(tid);
171 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects
const ExecFlagType EXEC_NONLINEAR
Definition: Moose.C:31

◆ numThreads()

template<typename T>
THREAD_ID MooseObjectWarehouseBase< T >::numThreads ( ) const
inlineinherited

Return the number of threads.

Definition at line 177 of file MooseObjectWarehouseBase.h.

177 { return _num_threads; }
const THREAD_ID _num_threads
Convenience member storing the number of threads used for storage (1 or libMesh::n_threads) ...

◆ operator[]() [1/2]

template<typename T >
const MooseObjectWarehouse< T > & ExecuteMooseObjectWarehouse< T >::operator[] ( ExecFlagType  exec_flag) const

Retrieve shared pointers for the given thread and execution type for all/active objects.

Parameters
exec_flagThe execution flag to retrieve objects from

Definition at line 121 of file ExecuteMooseObjectWarehouse.h.

122 {
123  // Use find to avoid accidental insertion
124  const auto iter = _execute_objects.find(exec_flag);
125 
126  if (iter == _execute_objects.end())
127  mooseError("Unable to locate the desired execute flag (",
128  exec_flag,
129  "), the supplied execution flag was likely "
130  "not registered.");
131 
132  return iter->second;
133 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects

◆ operator[]() [2/2]

template<typename T >
MooseObjectWarehouse< T > & ExecuteMooseObjectWarehouse< T >::operator[] ( ExecFlagType  exec_flag)

Definition at line 137 of file ExecuteMooseObjectWarehouse.h.

138 {
139  // Use find to avoid accidental insertion
140  const auto iter = _execute_objects.find(exec_flag);
141 
142  if (iter == _execute_objects.end())
143  mooseError("Unable to locate the desired execute flag (",
144  exec_flag,
145  "), the supplied execution flag was likely "
146  "not registered.");
147 
148  return iter->second;
149 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects

◆ residualSetup()

template<typename T >
void ExecuteMooseObjectWarehouse< T >::residualSetup ( THREAD_ID  tid = 0) const
overridevirtual

Reimplemented from MooseObjectWarehouse< T >.

Definition at line 175 of file ExecuteMooseObjectWarehouse.h.

Referenced by AuxiliarySystem::residualSetup().

176 {
177  checkThreadID(tid);
178  const auto iter = _execute_objects.find(EXEC_LINEAR);
179  if (iter != _execute_objects.end())
180  iter->second.residualSetup(tid);
181 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects
const ExecFlagType EXEC_LINEAR
Definition: Moose.C:29

◆ setup()

template<typename T >
void ExecuteMooseObjectWarehouse< T >::setup ( const ExecFlagType exec_flag,
THREAD_ID  tid = 0 
) const

Definition at line 185 of file ExecuteMooseObjectWarehouse.h.

Referenced by FEProblemBase::executeControls().

186 {
187  checkThreadID(tid);
188  if (exec_flag == EXEC_INITIAL)
189  initialSetup(tid);
190  else if (exec_flag == EXEC_TIMESTEP_BEGIN)
191  timestepSetup(tid);
192  else if (exec_flag == EXEC_SUBDOMAIN)
193  subdomainSetup(tid);
194  else if (exec_flag == EXEC_NONLINEAR)
195  jacobianSetup(tid);
196  else if (exec_flag == EXEC_LINEAR)
197  residualSetup(tid);
198 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
const ExecFlagType EXEC_TIMESTEP_BEGIN
Definition: Moose.C:34
virtual void timestepSetup(THREAD_ID tid=0) const
const ExecFlagType EXEC_LINEAR
Definition: Moose.C:29
virtual void initialSetup(THREAD_ID tid=0) const
Convenience methods for calling object setup methods.
void jacobianSetup(THREAD_ID tid=0) const override
Convenience methods for calling object setup methods.
const ExecFlagType EXEC_NONLINEAR
Definition: Moose.C:31
const ExecFlagType EXEC_SUBDOMAIN
Definition: Moose.C:43
void residualSetup(THREAD_ID tid=0) const override
virtual void subdomainSetup(THREAD_ID tid=0) const
const ExecFlagType EXEC_INITIAL
Definition: Moose.C:28

◆ size()

template<typename T >
unsigned int MooseObjectWarehouseBase< T >::size ( THREAD_ID  tid = 0) const
inherited

Return how many kernels we store in the current warehouse.

Definition at line 266 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearSystemBase::computeNodalBCs(), and NonlinearThread::printBlockExecutionInformation().

267 {
268  checkThreadID(tid);
269  return _all_objects[tid].size();
270 }
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ sort()

template<typename T >
void ExecuteMooseObjectWarehouse< T >::sort ( THREAD_ID  tid = 0)

Performs a sort using the DependencyResolver.

Parameters
tidThe thread id to access.

Definition at line 222 of file ExecuteMooseObjectWarehouse.h.

Referenced by AuxiliarySystem::initialSetup().

223 {
224  // Sort execute object storage
225  for (auto & object_pair : _execute_objects)
226  object_pair.second.sort(tid);
227 }
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects

◆ sortHelper()

template<typename T>
void MooseObjectWarehouseBase< T >::sortHelper ( std::vector< std::shared_ptr< T >> &  objects)
staticprotectedinherited

Helper method for sorting vectors of objects.

Definition at line 772 of file MooseObjectWarehouseBase.h.

773 {
774  // Do nothing if the vector is empty
775  if (objects.empty())
776  return;
777 
778  try
779  {
780  // Sort based on dependencies
781  DependencyResolverInterface::sort<std::shared_ptr<T>>(objects);
782  }
783  catch (CyclicDependencyException<std::shared_ptr<T>> & e)
784  {
785  DependencyResolverInterface::cyclicDependencyError<std::shared_ptr<T>>(
786  e, "Cyclic dependency detected in object ordering");
787  }
788 }

◆ subdomainsCovered()

template<typename T >
void MooseObjectWarehouseBase< T >::subdomainsCovered ( std::set< SubdomainID > &  subdomains_covered,
std::set< std::string > &  unique_variables,
THREAD_ID  tid = 0 
) const
inherited

Populates a set of covered subdomains and the associated variable names.

Definition at line 748 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearSystemBase::checkKernelCoverage().

751 {
752  for (const auto & object : _active_objects[tid])
753  unique_variables.insert(object->variable().name());
754 
755  for (const auto & object_pair : _active_block_objects[tid])
756  subdomains_covered.insert(object_pair.first);
757 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< T > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ subdomainSetup() [1/2]

template<typename T >
void MooseObjectWarehouse< T >::subdomainSetup ( THREAD_ID  tid = 0) const
virtualinherited

Reimplemented in MaterialWarehouse.

Definition at line 198 of file MooseObjectWarehouse.h.

Referenced by MaterialWarehouse::neighborSubdomainSetup(), ComputeMarkerThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), MaterialWarehouse::subdomainSetup(), AuxiliarySystem::subdomainSetup(), and NonlinearSystemBase::subdomainSetup().

199 {
200  checkThreadID(tid);
201  for (const auto & object : _active_objects[tid])
202  object->subdomainSetup();
203 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ subdomainSetup() [2/2]

template<typename T >
void MooseObjectWarehouse< T >::subdomainSetup ( SubdomainID  id,
THREAD_ID  tid = 0 
) const
virtualinherited

Reimplemented in MaterialWarehouse.

Definition at line 185 of file MooseObjectWarehouse.h.

186 {
187  checkThreadID(tid);
188  if (hasActiveBlockObjects(id, tid))
189  {
190  const auto & objects = getActiveBlockObjects(id, tid);
191  for (const auto & object : objects)
192  object->subdomainSetup();
193  }
194 }
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ timestepSetup()

template<typename T >
void MooseObjectWarehouse< T >::timestepSetup ( THREAD_ID  tid = 0) const
virtualinherited

Reimplemented in MaterialWarehouse.

Definition at line 167 of file MooseObjectWarehouse.h.

Referenced by MaterialWarehouse::timestepSetup(), AuxiliarySystem::timestepSetup(), NonlinearSystemBase::timestepSetup(), and FEProblemBase::timestepSetup().

168 {
169  checkThreadID(tid);
170  for (const auto & object : _active_objects[tid])
171  object->timestepSetup();
172 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< T > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ updateActive()

template<typename T >
void ExecuteMooseObjectWarehouse< T >::updateActive ( THREAD_ID  tid = 0)
overridevirtual

Updates the active objects storage.

Reimplemented from MooseObjectWarehouse< T >.

Definition at line 153 of file ExecuteMooseObjectWarehouse.h.

Referenced by AuxiliarySystem::updateActive(), and FEProblemBase::updateActiveObjects().

154 {
155  // Update all objects active list
157 
158  // Update the execute flag lists of objects
159  for (auto & object_pair : _execute_objects)
160  object_pair.second.updateActive(tid);
161 }
std::map< ExecFlagType, MooseObjectWarehouse< T > > _execute_objects
virtual void updateActive(THREAD_ID tid=0) override
Update the active status of Kernels.

◆ updateActiveHelper()

template<typename T>
void MooseObjectWarehouseBase< T >::updateActiveHelper ( std::vector< std::shared_ptr< T >> &  active,
const std::vector< std::shared_ptr< T >> &  all 
)
staticprotectedinherited

Helper method for updating active vectors.

Definition at line 561 of file MooseObjectWarehouseBase.h.

563 {
564  // Clear the active list
565  active.clear();
566 
567  std::copy_if(all.begin(),
568  all.end(),
569  std::back_inserter(active),
570  [](const std::shared_ptr<T> & object) { return object->enabled(); });
571 }

◆ updateBlockFEVariableCoupledVectorTagDependency()

template<typename T >
void MooseObjectWarehouseBase< T >::updateBlockFEVariableCoupledVectorTagDependency ( SubdomainID  id,
std::set< TagID > &  needed_fe_var_vector_tags,
THREAD_ID  tid = 0 
) const
inherited

Update FE variable coupleable vector tag vector.

Definition at line 654 of file MooseObjectWarehouseBase.h.

Referenced by ComputeNodalKernelsThread::onNode(), ComputeMaterialsObjectThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), NonlinearThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

656 {
657  if (hasActiveBlockObjects(id, tid))
658  updateFEVariableCoupledVectorTagDependencyHelper(needed_fe_var_vector_tags,
659  getActiveBlockObjects(id, tid));
660 }
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
static void updateFEVariableCoupledVectorTagDependencyHelper(std::set< TagID > &needed_fe_var_vector_tags, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating FE variable coupleable vector tag vector.

◆ updateBlockMatPropDependency()

template<typename T >
void MooseObjectWarehouseBase< T >::updateBlockMatPropDependency ( SubdomainID  id,
std::unordered_set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 699 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::prepareMaterials(), HDGPrimalSolutionUpdateThread::subdomainChanged(), and NonlinearThread::subdomainChanged().

703 {
704  if (hasActiveBlockObjects(id, tid))
705  updateMatPropDependencyHelper(needed_mat_props, getActiveBlockObjects(id, tid));
706 }
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
static void updateMatPropDependencyHelper(std::unordered_set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating material property dependency vector.

◆ updateBlockVariableDependency()

template<typename T >
void MooseObjectWarehouseBase< T >::updateBlockVariableDependency ( SubdomainID  id,
std::set< MooseVariableFieldBase *> &  needed_moose_vars,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 602 of file MooseObjectWarehouseBase.h.

Referenced by HDGPrimalSolutionUpdateThread::subdomainChanged(), and NonlinearThread::subdomainChanged().

606 {
607  if (hasActiveBlockObjects(id, tid))
608  updateVariableDependencyHelper(needed_moose_vars, getActiveBlockObjects(id, tid));
609 }
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
static void updateVariableDependencyHelper(std::set< MooseVariableFieldBase *> &needed_moose_vars, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating variable dependency vector.

◆ updateBoundaryFEVariableCoupledVectorTagDependency()

template<typename T >
void MooseObjectWarehouseBase< T >::updateBoundaryFEVariableCoupledVectorTagDependency ( BoundaryID  id,
std::set< TagID > &  needed_fe_var_vector_tags,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 664 of file MooseObjectWarehouseBase.h.

Referenced by ComputeNodalKernelBcsThread::onNode().

666 {
667  if (hasActiveBoundaryObjects(id, tid))
668  updateFEVariableCoupledVectorTagDependencyHelper(needed_fe_var_vector_tags,
669  getActiveBoundaryObjects(id, tid));
670 }
static void updateFEVariableCoupledVectorTagDependencyHelper(std::set< TagID > &needed_fe_var_vector_tags, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating FE variable coupleable vector tag vector.
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const

◆ updateBoundaryMatPropDependency() [1/2]

template<typename T >
void MooseObjectWarehouseBase< T >::updateBoundaryMatPropDependency ( std::unordered_set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 710 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::prepareMaterials(), and NonlinearThread::subdomainChanged().

712 {
713  if (hasActiveBoundaryObjects(tid))
714  for (auto & active_bnd_object : _active_boundary_objects[tid])
715  updateMatPropDependencyHelper(needed_mat_props, active_bnd_object.second);
716 }
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)
static void updateMatPropDependencyHelper(std::unordered_set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating material property dependency vector.

◆ updateBoundaryMatPropDependency() [2/2]

template<typename T >
void MooseObjectWarehouseBase< T >::updateBoundaryMatPropDependency ( BoundaryID  id,
std::unordered_set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 720 of file MooseObjectWarehouseBase.h.

724 {
725  if (hasActiveBoundaryObjects(id, tid))
726  updateMatPropDependencyHelper(needed_mat_props, getActiveBoundaryObjects(id, tid));
727 }
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
static void updateMatPropDependencyHelper(std::unordered_set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating material property dependency vector.
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const

◆ updateBoundaryVariableDependency() [1/2]

template<typename T >
void MooseObjectWarehouseBase< T >::updateBoundaryVariableDependency ( std::set< MooseVariableFieldBase *> &  needed_moose_vars,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 613 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::prepareMaterials(), and NonlinearThread::subdomainChanged().

615 {
616  if (hasActiveBoundaryObjects(tid))
617  {
618  typename std::map<BoundaryID, std::vector<std::shared_ptr<T>>>::const_iterator it;
619  for (const auto & object_pair : _active_boundary_objects[tid])
620  updateVariableDependencyHelper(needed_moose_vars, object_pair.second);
621  }
622 }
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)
static void updateVariableDependencyHelper(std::set< MooseVariableFieldBase *> &needed_moose_vars, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating variable dependency vector.

◆ updateBoundaryVariableDependency() [2/2]

template<typename T >
void MooseObjectWarehouseBase< T >::updateBoundaryVariableDependency ( BoundaryID  id,
std::set< MooseVariableFieldBase *> &  needed_moose_vars,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 626 of file MooseObjectWarehouseBase.h.

630 {
631  if (hasActiveBoundaryObjects(id, tid))
632  updateVariableDependencyHelper(needed_moose_vars, getActiveBoundaryObjects(id, tid));
633 }
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
static void updateVariableDependencyHelper(std::set< MooseVariableFieldBase *> &needed_moose_vars, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating variable dependency vector.
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const

◆ updateFEVariableCoupledVectorTagDependencyHelper()

template<typename T>
void MooseObjectWarehouseBase< T >::updateFEVariableCoupledVectorTagDependencyHelper ( std::set< TagID > &  needed_fe_var_vector_tags,
const std::vector< std::shared_ptr< T >> &  objects 
)
staticprotectedinherited

Helper method for updating FE variable coupleable vector tag vector.

Definition at line 674 of file MooseObjectWarehouseBase.h.

676 {
677  for (const auto & object : objects)
678  {
679  auto c = dynamic_cast<const Coupleable *>(object.get());
680  if (c)
681  {
682  const auto & tag_deps = c->getFEVariableCoupleableVectorTags();
683  needed_fe_var_vector_tags.insert(tag_deps.begin(), tag_deps.end());
684  }
685  }
686 }
Interface for objects that needs coupling capabilities.
Definition: Coupleable.h:45
std::set< TagID > & getFEVariableCoupleableVectorTags()
Definition: Coupleable.h:106

◆ updateMatPropDependency()

template<typename T >
void MooseObjectWarehouseBase< T >::updateMatPropDependency ( std::unordered_set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Update material property dependency vector.

Definition at line 690 of file MooseObjectWarehouseBase.h.

Referenced by ComputeMarkerThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), and ComputeDiracThread::subdomainChanged().

692 {
693  if (hasActiveObjects(tid))
694  updateMatPropDependencyHelper(needed_mat_props, _all_objects[tid]);
695 }
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
static void updateMatPropDependencyHelper(std::unordered_set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating material property dependency vector.
bool hasActiveObjects(THREAD_ID tid=0) const

◆ updateMatPropDependencyHelper()

template<typename T>
void MooseObjectWarehouseBase< T >::updateMatPropDependencyHelper ( std::unordered_set< unsigned int > &  needed_mat_props,
const std::vector< std::shared_ptr< T >> &  objects 
)
staticprotectedinherited

Helper method for updating material property dependency vector.

Definition at line 731 of file MooseObjectWarehouseBase.h.

734 {
735  for (auto & object : objects)
736  {
737  auto c = dynamic_cast<const MaterialPropertyInterface *>(object.get());
738  if (c)
739  {
740  auto & mp_deps = c->getMatPropDependencies();
741  needed_mat_props.insert(mp_deps.begin(), mp_deps.end());
742  }
743  }
744 }
An interface for accessing Materials.
const std::unordered_set< unsigned int > & getMatPropDependencies() const
Retrieve the set of material properties that this object depends on.

◆ updateVariableDependency()

template<typename T >
void MooseObjectWarehouseBase< T >::updateVariableDependency ( std::set< MooseVariableFieldBase *> &  needed_moose_vars,
THREAD_ID  tid = 0 
) const
inherited

Update variable dependency vector.

Definition at line 593 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::prepareMaterials(), ComputeMarkerThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), and ComputeDiracThread::subdomainChanged().

595 {
596  if (hasActiveObjects(tid))
597  updateVariableDependencyHelper(needed_moose_vars, _all_objects[tid]);
598 }
std::vector< std::vector< std::shared_ptr< T > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
static void updateVariableDependencyHelper(std::set< MooseVariableFieldBase *> &needed_moose_vars, const std::vector< std::shared_ptr< T >> &objects)
Helper method for updating variable dependency vector.
bool hasActiveObjects(THREAD_ID tid=0) const

◆ updateVariableDependencyHelper()

template<typename T>
void MooseObjectWarehouseBase< T >::updateVariableDependencyHelper ( std::set< MooseVariableFieldBase *> &  needed_moose_vars,
const std::vector< std::shared_ptr< T >> &  objects 
)
staticprotectedinherited

Helper method for updating variable dependency vector.

Definition at line 637 of file MooseObjectWarehouseBase.h.

640 {
641  for (const auto & object : objects)
642  {
643  auto c = dynamic_cast<const MooseVariableDependencyInterface *>(object.get());
644  if (c)
645  {
646  const auto & mv_deps = c->getMooseVariableDependencies();
647  needed_moose_vars.insert(mv_deps.begin(), mv_deps.end());
648  }
649  }
650 }
const std::set< MooseVariableFieldBase * > & getMooseVariableDependencies() const
Retrieve the set of MooseVariableFieldBase that this object depends on.

Member Data Documentation

◆ _active_block_objects

template<typename T>
std::vector<std::map<SubdomainID, std::vector<std::shared_ptr<T> > > > MooseObjectWarehouseBase< T >::_active_block_objects
protectedinherited

Active block restricted objects (THREAD_ID on outer vector)

Definition at line 201 of file MooseObjectWarehouseBase.h.

◆ _active_boundary_objects

template<typename T>
std::vector<std::map<BoundaryID, std::vector<std::shared_ptr<T> > > > MooseObjectWarehouseBase< T >::_active_boundary_objects
protectedinherited

Active boundary restricted objects (THREAD_ID on outer vector)

Definition at line 207 of file MooseObjectWarehouseBase.h.

◆ _active_objects

template<typename T>
std::vector<std::vector<std::shared_ptr<T> > > MooseObjectWarehouseBase< T >::_active_objects
protectedinherited

All active objects (THREAD_ID on outer vector)

Definition at line 195 of file MooseObjectWarehouseBase.h.

◆ _all_block_objects

template<typename T>
std::vector<std::map<SubdomainID, std::vector<std::shared_ptr<T> > > > MooseObjectWarehouseBase< T >::_all_block_objects
protectedinherited

Definition at line 198 of file MooseObjectWarehouseBase.h.

Referenced by MaterialWarehouse::sort().

◆ _all_boundary_objects

template<typename T>
std::vector<std::map<BoundaryID, std::vector<std::shared_ptr<T> > > > MooseObjectWarehouseBase< T >::_all_boundary_objects
protectedinherited

Definition at line 204 of file MooseObjectWarehouseBase.h.

Referenced by MaterialWarehouse::sort().

◆ _all_objects

template<typename T>
std::vector<std::vector<std::shared_ptr<T> > > MooseObjectWarehouseBase< T >::_all_objects
protectedinherited

Storage container for the ALL pointers (THREAD_ID on outer vector)

Definition at line 192 of file MooseObjectWarehouseBase.h.

◆ _execute_objects

template<typename T>
std::map<ExecFlagType, MooseObjectWarehouse<T> > ExecuteMooseObjectWarehouse< T >::_execute_objects
protected

◆ _num_threads

template<typename T>
const THREAD_ID MooseObjectWarehouseBase< T >::_num_threads
protectedinherited

Convenience member storing the number of threads used for storage (1 or libMesh::n_threads)

Definition at line 189 of file MooseObjectWarehouseBase.h.

Referenced by MooseObjectWarehouseBase< Indicator >::numThreads().

◆ _variable_objects

template<typename T>
std::map<unsigned int, MooseObjectWarehouse<T> > MooseObjectWarehouse< T >::_variable_objects
protectedinherited

Variable based storage.

Definition at line 88 of file MooseObjectWarehouse.h.


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