MooseObjectWarehouseBase< T > Class Template Reference

A base storage container for MooseObjects. More...

#include <MooseObjectWarehouseBase.h>

Inheritance diagram for MooseObjectWarehouseBase< T >:

Public Member Functions
	MooseObjectWarehouseBase (bool threaded=true)
	Constructor. More...
virtual	~MooseObjectWarehouseBase ()
	Destructor. More...
virtual void	addObject (std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true)
	Adds an object to the storage structure. More...
unsigned int	size (THREAD_ID tid=0) const
	Return how many kernels we store in the current warehouse. More...
bool	hasObjectsForVariableAndBlocks (const VariableName &var_name, const std::set< SubdomainID > &blocks, std::set< SubdomainID > &blocks_covered, THREAD_ID tid) const
	Whether there are objects for this variable and the set of blocks passed. More...
std::set< SubdomainID >	getActiveBlocks (THREAD_ID tid=0) const
	Return a set of active SubdomainsIDs. More...
const std::vector< std::shared_ptr< T > > &	getObjectsForVariable (const VariableName &var_name, THREAD_ID tid) const
	Getter for objects that have the 'variable' set to a particular variable Note that users should check whether there are objects using 'hasObjectsForVariable' before calling this routine, because it will throw if there are no objects for this variable. More...
virtual void	updateActive (THREAD_ID tid=0)
	Updates the active objects storage. More...
void	sort (THREAD_ID tid=0)
	Sort the objects using the DependencyResolver. 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 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	hasObjectsForVariable (const VariableName &var_name, THREAD_ID tid) 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 (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	updateFEVariableCoupledVectorTagDependency (std::set< TagID > &needed_fe_var_vector_tags, THREAD_ID tid=0) const
	Update FE variable coupleable vector tag vector for all objects, block-restricted objects, and boundary-restricted objects. More...
void	updateBlockFEVariableCoupledVectorTagDependency (SubdomainID id, std::set< TagID > &needed_fe_var_vector_tags, THREAD_ID tid=0) const
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 bool producer_only=false) const
	Update material property dependency vector. More...
void	updateBlockMatPropDependency (SubdomainID id, std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0, const bool producer_only=false) const
void	updateBoundaryMatPropDependency (std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0, const bool producer_only=false) const
void	updateBoundaryMatPropDependency (BoundaryID id, std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0, const bool producer_only=false) const

Protected Member Functions
virtual void	updateMatPropDependencyHelper (std::unordered_set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< T >> &objects, const bool producer_only) const
	Helper method for updating material property dependency vector. More...
void	checkThreadID (THREAD_ID tid) const
	Calls assert on thread id. More...
bool	hasBoundaryObjectsHelper (const std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T >>>> &boundary_objects, const THREAD_ID tid=0) const
	Helper for determining whether we have boundary objects. 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...

Protected Attributes
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...
std::vector< std::map< VariableName, std::vector< std::shared_ptr< T > > > >	_all_variable_objects
	All objects with a certain variable selected, as the 'variable' parameter. More...

Friends
class	MaterialWarehouse

Detailed Description

template<typename T>
class MooseObjectWarehouseBase< T >

A base storage container for MooseObjects.

Definition at line 30 of file MooseObjectWarehouseBase.h.

Constructor & Destructor Documentation

MooseObjectWarehouseBase()

template<typename T >

MooseObjectWarehouseBase< T >::MooseObjectWarehouseBase

(

bool

threaded = true

)

Constructor.

Parameters

threaded

When true (default) threaded storage is enabled.

Definition at line 287 of file MooseObjectWarehouseBase.h.

  : _num_threads(threaded ? libMesh::n_threads() : 1),
    _all_objects(_num_threads),
    _active_objects(_num_threads),
    _all_block_objects(_num_threads),
    _active_block_objects(_num_threads),
    _all_boundary_objects(_num_threads),
    _active_boundary_objects(_num_threads),
    _all_variable_objects(_num_threads)
{
}

~MooseObjectWarehouseBase()

template<typename T >

MooseObjectWarehouseBase< T >::~MooseObjectWarehouseBase ( )

virtual

Destructor.

Definition at line 300 of file MooseObjectWarehouseBase.h.

{
}

Member Function Documentation

activeObjectsToFormattedString()

template<typename T >

std::string MooseObjectWarehouseBase< T >::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.

Parameters

tid	the thread id
prefix	a string to prepend to the string

Definition at line 898 of file MooseObjectWarehouseBase.h.

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

{
  std::vector<std::string> output;
  for (const auto & object : _active_objects[tid])
    output.push_back(object->name());
  return ConsoleUtils::formatString(MooseUtils::join(output, " "), prefix);
}

addObject()

template<typename T>

void MooseObjectWarehouseBase< T >::addObject ( std::shared_ptr< T >  object, THREAD_ID  tid = 0, bool  recurse = true  )

virtual

Adds an object to the storage structure.

Parameters

tid	The thread ID (default is 0)
recurse	Whether or not to build recusive warehouses (typically for Kernels)

Reimplemented in MooseObjectWarehouse< T >, MooseObjectWarehouse< ADDirichletBCBase >, MooseObjectWarehouse< NodalDamper >, MooseObjectWarehouse< TransientMultiApp >, MooseObjectWarehouse< NodalBCBase >, MooseObjectWarehouse< Moose::FunctionBase >, MooseObjectWarehouse< AuxKernelTempl >, MooseObjectWarehouse< MaterialBase >, MooseObjectWarehouse< GeneralDamper >, MooseObjectWarehouse< ResidualObject >, MooseObjectWarehouse< AuxScalarKernel >, MooseObjectWarehouse< DirichletBCBase >, MooseObjectWarehouse< AuxKernelBase >, MooseObjectWarehouse< AuxKernelType >, MooseObjectWarehouse< InternalSideIndicatorBase >, MooseObjectWarehouse< IntegratedBCBase >, MooseObjectWarehouse< NodalKernelBase >, MooseObjectWarehouse< HDGKernel >, MooseObjectWarehouse< KernelBase >, MooseObjectWarehouse< Convergence >, MooseObjectWarehouse< DGKernelBase >, MooseObjectWarehouse< MultiApp >, MooseObjectWarehouse< Function >, MooseObjectWarehouse< ScalarKernelBase >, MooseObjectWarehouse< MeshDivision >, MooseObjectWarehouse< NodalConstraint >, MooseObjectWarehouse< InterfaceKernelBase >, MooseObjectWarehouse< Marker >, MooseObjectWarehouse< ElementDamper >, MooseObjectWarehouse< Constraint >, MooseObjectWarehouse< DiracKernelBase >, MooseObjectWarehouse< Control >, MooseObjectWarehouse< Transfer >, MooseObjectWarehouse< Indicator >, ExecuteMooseObjectWarehouse< T >, ExecuteMooseObjectWarehouse< TransientMultiApp >, ExecuteMooseObjectWarehouse< AuxKernelTempl >, ExecuteMooseObjectWarehouse< AuxScalarKernel >, ExecuteMooseObjectWarehouse< AuxKernelBase >, ExecuteMooseObjectWarehouse< MultiApp >, ExecuteMooseObjectWarehouse< Control >, ExecuteMooseObjectWarehouse< Transfer >, ConstraintWarehouse, FVInitialConditionWarehouse, and InitialConditionWarehouse.

Definition at line 314 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::addInitialCondition(), InitialConditionWarehouse::addObject(), FVInitialConditionWarehouse::addObject(), MooseObjectWarehouse< Indicator >::addObject(), and NonlinearSystemBase::addSplit().

{
  checkThreadID(tid);

  // Stores object in list of all objects
  _all_objects[tid].push_back(object);

  // If enabled, store object in a list of all active
  bool enabled = object->enabled();
  if (enabled)
    _active_objects[tid].push_back(object);

  // Perform casts to the Block/BoundaryRestrictable
  std::shared_ptr<BoundaryRestrictable> bnd =
      std::dynamic_pointer_cast<BoundaryRestrictable>(object);
  std::shared_ptr<BlockRestrictable> blk = std::dynamic_pointer_cast<BlockRestrictable>(object);

  // Boundary Restricted
  if (bnd && bnd->boundaryRestricted())
  {
    const std::set<BoundaryID> & ids = bnd->boundaryIDs();
    for (std::set<BoundaryID>::const_iterator it = ids.begin(); it != ids.end(); ++it)
    {
      _all_boundary_objects[tid][*it].push_back(object);
      if (enabled)
        _active_boundary_objects[tid][*it].push_back(object);
    }
  }

  // Block Restricted
  else if (blk)
  {
    const std::set<SubdomainID> & ids =
        blk->blockRestricted() ? blk->blockIDs() : blk->meshBlockIDs();
    for (std::set<SubdomainID>::const_iterator it = ids.begin(); it != ids.end(); ++it)
    {
      _all_block_objects[tid][*it].push_back(object);
      if (enabled)
        _active_block_objects[tid][*it].push_back(object);
    }

    // Check variables
    std::shared_ptr<Coupleable> c_ptr = std::dynamic_pointer_cast<Coupleable>(object);
    if (c_ptr)
      for (MooseVariableFieldBase * var : c_ptr->getCoupledMooseVars())
        blk->checkVariable(*var);

    const InputParameters & parameters = object->parameters();

    SubProblem & problem = *parameters.get<SubProblem *>("_subproblem");

    THREAD_ID tid = parameters.get<THREAD_ID>("_tid");

    if (parameters.isParamValid("variable"))
    {
      // Try the scalar version first
      std::string variable_name = parameters.getMooseType("variable");
      if (variable_name == "")
        // When using vector variables, we are only going to use the first one in the list at the
        // interface level...
        variable_name = parameters.getVecMooseType("variable")[0];

      blk->checkVariable(problem.getVariable(
          tid, variable_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY));

      _all_variable_objects[tid][variable_name].push_back(object);
    }
  }
}

checkThreadID()

template<typename T>

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

inlineprotected

Calls assert on thread id.

Definition at line 929 of file MooseObjectWarehouseBase.h.

{
  mooseAssert(tid < _num_threads,
              "Attempting to access a thread id ("
                  << tid << ") greater than the number allowed by the storage item ("
                  << _num_threads << ")");
}

getActiveBlockObjects() [1/2]

template<typename T >

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

inline

Definition at line 469 of file MooseObjectWarehouseBase.h.

Referenced by MaterialPropertyInterface::buildRequiredMaterials(), FEProblemBase::checkProblemIntegrity(), NonlinearThread::computeOnElement(), ComputeResidualThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), FEProblemBase::getFVMatsAndDependencies(), BlockRestrictable::hasBlockMaterialPropertyHelper(), NonlinearSystemBase::needInternalNeighborSideMaterial(), ComputeMarkerThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeIndicatorThread::onElement(), ComputeIndicatorThread::onInternalSide(), ComputeNodalKernelsThread::onNode(), ComputeNodalKernelJacobiansThread::onNode(), ComputeFVInitialConditionThread::operator()(), ComputeInitialConditionThread::operator()(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeDiracThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), FEProblemBase::reinitMaterials(), and Moose::Mortar::setupMortarMaterials().

{
  checkThreadID(tid);
  return _active_block_objects[tid];
}

getActiveBlockObjects() [2/2]

template<typename T >

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

Definition at line 477 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  const auto iter = _active_block_objects[tid].find(id);
  mooseAssert(iter != _active_block_objects[tid].end(),
              "Unable to located active block objects for the given id: " << id << ".");
  return iter->second;
}

getActiveBlocks()

template<typename T >

std::set< SubdomainID > MooseObjectWarehouseBase< T >::getActiveBlocks

(

THREAD_ID

tid = 0

)

const

Return a set of active SubdomainsIDs.

Definition at line 649 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::checkProblemIntegrity().

{
  checkThreadID(tid);
  std::set<SubdomainID> ids;
  for (const auto & object_pair : _active_block_objects[tid])
    ids.insert(object_pair.first);
  return ids;
}

getActiveBoundaryObjects() [1/2]

template<typename T >

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

inline

Definition at line 450 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearSystemBase::computeJacobianBlocks(), AuxiliarySystem::computeMortarNodalVars(), NonlinearSystemBase::computeNodalBCsJacobian(), NonlinearSystemBase::computeNodalBCsResidual(), NonlinearSystemBase::computeNodalBCsResidualAndJacobian(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnInterface(), NonlinearThread::computeOnInterface(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), NonlinearSystemBase::needBoundaryMaterialOnSide(), NonlinearSystemBase::needInterfaceMaterialOnSide(), ComputeMaterialsObjectThread::onBoundary(), ComputeMaterialsObjectThread::onInterface(), ComputeBoundaryInitialConditionThread::onNode(), ComputeNodalKernelBcsThread::onNode(), ComputeNodalKernelBCJacobiansThread::onNode(), FEProblemBase::reinitMaterialsBoundary(), FEProblemBase::reinitMaterialsInterface(), and NonlinearSystemBase::setInitialSolution().

{
  checkThreadID(tid);
  return _active_boundary_objects[tid];
}

getActiveBoundaryObjects() [2/2]

template<typename T >

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

Definition at line 458 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  const auto iter = _active_boundary_objects[tid].find(id);
  mooseAssert(iter != _active_boundary_objects[tid].end(),
              "Unable to located active boundary objects for the given id: " << id << ".");
  return iter->second;
}

getActiveObject()

template<typename T >

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

Definition at line 630 of file MooseObjectWarehouseBase.h.

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

{
  checkThreadID(tid);
  for (const auto & object : _active_objects[tid])
    if (object->name() == name)
      return object;
  mooseError("Unable to locate active object: ", name, ".");
}

getActiveObjects()

template<typename T >

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

inline

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

Parameters

tid	The thread id to retrieve objects from

Definition at line 442 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::backupMultiApps(), NonlinearEigenSystem::checkIntegrity(), NonlinearSystemBase::checkKernelCoverage(), 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(), AuxiliarySystem::getDependObjects(), FEProblemBase::getTransfers(), FEProblemBase::incrementMultiAppTStep(), FEProblemBase::initialSetup(), NonlinearSystemBase::needBoundaryMaterialOnSide(), ComputeElemDampingThread::onElement(), ComputeDiracThread::onElement(), ComputeNodalDampingThread::onNode(), FEProblemBase::postExecute(), FEProblemBase::projectInitialConditionOnCustomRange(), FEProblemBase::projectSolution(), FEProblemBase::restoreMultiApps(), and AuxiliarySystem::setScalarVariableCoupleableTags().

{
  checkThreadID(tid);
  return _active_objects[tid];
}

getBlockObjects() [1/2]

template<typename T >

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

inline

Definition at line 423 of file MooseObjectWarehouseBase.h.

Referenced by MaterialPropertyDebugOutput::printMaterialMap().

{
  checkThreadID(tid);
  return _all_block_objects[tid];
}

getBlockObjects() [2/2]

template<typename T >

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

Definition at line 431 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  const auto iter = _all_block_objects[tid].find(id);
  mooseAssert(iter != _all_block_objects[tid].end(),
              "Unable to located active block objects for the given id: " << id << ".");
  return iter->second;
}

getBoundaryObjects() [1/2]

template<typename T >

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

inline

Definition at line 396 of file MooseObjectWarehouseBase.h.

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

{
  checkThreadID(tid);
  return _all_boundary_objects[tid];
}

getBoundaryObjects() [2/2]

template<typename T >

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

Definition at line 412 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  const auto iter = _all_boundary_objects[tid].find(id);
  mooseAssert(iter != _all_boundary_objects[tid].end(),
              "Unable to located active boundary objects for the given id: " << id << ".");
  return iter->second;
}

getObject()

template<typename T >

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

Definition at line 619 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::getMultiApp().

{
  checkThreadID(tid);
  for (const auto & object : _all_objects[tid])
    if (object->name() == name)
      return object;
  mooseError("Unable to locate object: ", name, ".");
}

getObjects()

template<typename T >

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

inline

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

Parameters

tid	The thread id to retrieve objects from

Definition at line 388 of file MooseObjectWarehouseBase.h.

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

{
  checkThreadID(tid);
  return _all_objects[tid];
}

getObjectsForVariable()

template<typename T >

const std::vector< std::shared_ptr< T > > & MooseObjectWarehouseBase< T >::getObjectsForVariable	(	const VariableName &	var_name,
		THREAD_ID	tid
	)		const

Getter for objects that have the 'variable' set to a particular variable Note that users should check whether there are objects using 'hasObjectsForVariable' before calling this routine, because it will throw if there are no objects for this variable.

Definition at line 641 of file MooseObjectWarehouseBase.h.

{
  return libmesh_map_find(_all_variable_objects[tid], var_name);
}

hasActiveBlockObjects() [1/2]

template<typename T >

bool MooseObjectWarehouseBase< T >::hasActiveBlockObjects

(

THREAD_ID

tid = 0

)

const

Definition at line 552 of file MooseObjectWarehouseBase.h.

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

{
  checkThreadID(tid);
  bool has_active_block_objects = false;
  for (const auto & object_pair : _active_block_objects[tid])
    has_active_block_objects |= !(object_pair.second.empty());
  return has_active_block_objects;
}

hasActiveBlockObjects() [2/2]

template<typename T >

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

Definition at line 563 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  const auto iter = _active_block_objects[tid].find(id);
  return iter != _active_block_objects[tid].end();
}

hasActiveBoundaryObjects() [1/2]

template<typename T >

bool MooseObjectWarehouseBase< T >::hasActiveBoundaryObjects

(

THREAD_ID

tid = 0

)

const

Definition at line 592 of file MooseObjectWarehouseBase.h.

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

{
  return hasBoundaryObjectsHelper(_active_boundary_objects, tid);
}

hasActiveBoundaryObjects() [2/2]

template<typename T >

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

Definition at line 599 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  const auto iter = _active_boundary_objects[tid].find(id);
  return iter != _active_boundary_objects[tid].end();
}

hasActiveObject()

template<typename T >

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

Convenience functions for checking/getting specific objects.

Definition at line 608 of file MooseObjectWarehouseBase.h.

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

{
  checkThreadID(tid);
  for (const auto & object : _active_objects[tid])
    if (object->name() == name)
      return true;
  return false;
}

hasActiveObjects()

template<typename T >

bool MooseObjectWarehouseBase< T >::hasActiveObjects

(

THREAD_ID

tid = 0

)

const

Definition at line 496 of file MooseObjectWarehouseBase.h.

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

{
  checkThreadID(tid);
  return !_active_objects[tid].empty();
}

hasBoundaryObjects() [1/2]

template<typename T >

bool MooseObjectWarehouseBase< T >::hasBoundaryObjects

(

THREAD_ID

tid = 0

)

const

Definition at line 585 of file MooseObjectWarehouseBase.h.

{
  return hasBoundaryObjectsHelper(_all_boundary_objects, tid);
}

hasBoundaryObjects() [2/2]

template<typename T >

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

Definition at line 404 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  return _all_boundary_objects[tid].find(id) != _all_boundary_objects[tid].end();
}

hasBoundaryObjectsHelper()

template<typename T>

bool MooseObjectWarehouseBase< T >::hasBoundaryObjectsHelper ( const std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< T >>>> &  boundary_objects, const THREAD_ID  tid = 0  ) const

protected

Helper for determining whether we have boundary objects.

Definition at line 572 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  bool has_boundary_objects = false;
  for (const auto & object_pair : boundary_objects[tid])
    has_boundary_objects |= !(object_pair.second.empty());
  return has_boundary_objects;
}

hasObjects()

template<typename T >

bool MooseObjectWarehouseBase< T >::hasObjects

(

THREAD_ID

tid = 0

)

const

Convenience functions for determining if objects exist.

Definition at line 488 of file MooseObjectWarehouseBase.h.

Referenced by FEProblemBase::initialSetup(), and NonlinearSystemBase::setInitialSolution().

{
  checkThreadID(tid);
  return !_all_objects[tid].empty();
}

hasObjectsForVariable()

template<typename T >

bool MooseObjectWarehouseBase< T >::hasObjectsForVariable	(	const VariableName &	var_name,
		THREAD_ID	tid
	)		const

Definition at line 504 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  return _all_variable_objects[tid].count(var_name);
}

hasObjectsForVariableAndBlocks()

template<typename T >

bool MooseObjectWarehouseBase< T >::hasObjectsForVariableAndBlocks	(	const VariableName &	var_name,
		const std::set< SubdomainID > &	blocks,
		std::set< SubdomainID > &	blocks_covered,
		THREAD_ID	tid
	)		const

Whether there are objects for this variable and the set of blocks passed.

Parameters

var_name	name of the variable
blocks	blocks to consider
blocks_covered	subset of blocks for which there is an object

Definition at line 513 of file MooseObjectWarehouseBase.h.

{
  checkThreadID(tid);
  blocks_covered.clear();
  if (!hasObjectsForVariable(var_name, tid))
    return false;

  // Check block restriction as a whole
  for (const auto & object : libmesh_map_find(_all_variable_objects[tid], var_name))
  {
    std::shared_ptr<BlockRestrictable> blk = std::dynamic_pointer_cast<BlockRestrictable>(object);
    if (blk && blk->hasBlocks(blocks))
    {
      blocks_covered = blocks;
      return true;
    }
  }
  // No object has all the blocks, but one might overlap, which could be troublesome.
  // We'll keep track of which blocks are covered in case several overlap
  for (const auto & object : libmesh_map_find(_all_variable_objects[tid], var_name))
  {
    std::shared_ptr<BlockRestrictable> blk = std::dynamic_pointer_cast<BlockRestrictable>(object);
    if (blk)
      for (const auto & block : blocks)
        if (blk->hasBlocks(block))
          blocks_covered.insert(block);
  }
  // No overlap at all
  if (blocks_covered.empty())
    return false;

  return (blocks == blocks_covered);
}

numThreads()

template<typename T>

THREAD_ID MooseObjectWarehouseBase< T >::numThreads ( ) const

inline

Return the number of threads.

Definition at line 205 of file MooseObjectWarehouseBase.h.

{ return _num_threads; }

size()

template<typename T >

unsigned int MooseObjectWarehouseBase< T >::size

(

THREAD_ID

tid = 0

)

const

Return how many kernels we store in the current warehouse.

Definition at line 306 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearThread::printBlockExecutionInformation().

{
  checkThreadID(tid);
  return _all_objects[tid].size();
}

sort()

template<typename T >

void MooseObjectWarehouseBase< T >::sort

(

THREAD_ID

tid = 0

)

Sort the objects using the DependencyResolver.

Definition at line 689 of file MooseObjectWarehouseBase.h.

Referenced by FVInitialConditionWarehouse::initialSetup(), InitialConditionWarehouse::initialSetup(), ScalarInitialConditionWarehouse::initialSetup(), and FEProblemBase::initialSetup().

{
  checkThreadID(tid);

  for (auto & object_pair : _all_block_objects[tid])
    sortHelper(object_pair.second);

  for (auto & object_pair : _all_boundary_objects[tid])
    sortHelper(object_pair.second);

  sortHelper(_all_objects[tid]);

  // The active lists now must be update to reflect the order changes
  updateActive(tid);
}

sortHelper()

template<typename T>

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

staticprotected

Helper method for sorting vectors of objects.

Definition at line 909 of file MooseObjectWarehouseBase.h.

{
  // Do nothing if the vector is empty
  if (objects.empty())
    return;

  try
  {
    // Sort based on dependencies
    DependencyResolverInterface::sort<std::shared_ptr<T>>(objects);
  }
  catch (CyclicDependencyException<std::shared_ptr<T>> & e)
  {
    DependencyResolverInterface::cyclicDependencyError<std::shared_ptr<T>>(
        e, "Cyclic dependency detected in object ordering");
  }
}

subdomainsCovered()

template<typename T >

void MooseObjectWarehouseBase< T >::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.

Definition at line 880 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearSystemBase::checkKernelCoverage().

{
  for (const auto & object : _active_objects[tid])
  {
    unique_variables.insert(object->variable().name());
    const auto additional_variables_covered = object->additionalROVariables();
    unique_variables.insert(additional_variables_covered.begin(),
                            additional_variables_covered.end());
  }

  for (const auto & object_pair : _active_block_objects[tid])
    subdomains_covered.insert(object_pair.first);
}

updateActive()

template<typename T >

void MooseObjectWarehouseBase< T >::updateActive ( THREAD_ID  tid = 0 )

virtual

Updates the active objects storage.

Reimplemented in MooseObjectWarehouse< T >, MooseObjectWarehouse< ADDirichletBCBase >, MooseObjectWarehouse< NodalDamper >, MooseObjectWarehouse< TransientMultiApp >, MooseObjectWarehouse< NodalBCBase >, MooseObjectWarehouse< Moose::FunctionBase >, MooseObjectWarehouse< AuxKernelTempl >, MooseObjectWarehouse< MaterialBase >, MooseObjectWarehouse< GeneralDamper >, MooseObjectWarehouse< ResidualObject >, MooseObjectWarehouse< AuxScalarKernel >, MooseObjectWarehouse< DirichletBCBase >, MooseObjectWarehouse< AuxKernelBase >, MooseObjectWarehouse< AuxKernelType >, MooseObjectWarehouse< InternalSideIndicatorBase >, MooseObjectWarehouse< IntegratedBCBase >, MooseObjectWarehouse< NodalKernelBase >, MooseObjectWarehouse< HDGKernel >, MooseObjectWarehouse< KernelBase >, MooseObjectWarehouse< Convergence >, MooseObjectWarehouse< DGKernelBase >, MooseObjectWarehouse< MultiApp >, MooseObjectWarehouse< Function >, MooseObjectWarehouse< ScalarKernelBase >, MooseObjectWarehouse< MeshDivision >, MooseObjectWarehouse< NodalConstraint >, MooseObjectWarehouse< InterfaceKernelBase >, MooseObjectWarehouse< Marker >, MooseObjectWarehouse< ElementDamper >, MooseObjectWarehouse< Constraint >, MooseObjectWarehouse< DiracKernelBase >, MooseObjectWarehouse< Control >, MooseObjectWarehouse< Transfer >, MooseObjectWarehouse< Indicator >, ConstraintWarehouse, ExecuteMooseObjectWarehouse< T >, ExecuteMooseObjectWarehouse< TransientMultiApp >, ExecuteMooseObjectWarehouse< AuxKernelTempl >, ExecuteMooseObjectWarehouse< AuxScalarKernel >, ExecuteMooseObjectWarehouse< AuxKernelBase >, ExecuteMooseObjectWarehouse< MultiApp >, ExecuteMooseObjectWarehouse< Control >, ExecuteMooseObjectWarehouse< Transfer >, MaterialWarehouse, MooseObjectTagWarehouse< T >, MooseObjectTagWarehouse< NodalBCBase >, MooseObjectTagWarehouse< ResidualObject >, MooseObjectTagWarehouse< IntegratedBCBase >, MooseObjectTagWarehouse< NodalKernelBase >, MooseObjectTagWarehouse< HDGKernel >, MooseObjectTagWarehouse< KernelBase >, MooseObjectTagWarehouse< DGKernelBase >, MooseObjectTagWarehouse< ScalarKernelBase >, MooseObjectTagWarehouse< InterfaceKernelBase >, and MooseObjectTagWarehouse< DiracKernelBase >.

Definition at line 660 of file MooseObjectWarehouseBase.h.

Referenced by MooseObjectWarehouse< Indicator >::updateActive(), and NonlinearSystemBase::updateActive().

{
  checkThreadID(tid);

  updateActiveHelper(_active_objects[tid], _all_objects[tid]);

  for (const auto & object_pair : _all_block_objects[tid])
    updateActiveHelper(_active_block_objects[tid][object_pair.first], object_pair.second);

  for (const auto & object_pair : _all_boundary_objects[tid])
    updateActiveHelper(_active_boundary_objects[tid][object_pair.first], object_pair.second);
}

updateActiveHelper()

template<typename T>

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

staticprotected

Helper method for updating active vectors.

Definition at line 675 of file MooseObjectWarehouseBase.h.

{
  // Clear the active list
  active.clear();

  std::copy_if(all.begin(),
               all.end(),
               std::back_inserter(active),
               [](const std::shared_ptr<T> & object) { return object->enabled(); });
}

updateBlockFEVariableCoupledVectorTagDependency()

template<typename T >

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

Definition at line 778 of file MooseObjectWarehouseBase.h.

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

{
  if (hasActiveBlockObjects(id, tid))
    updateFEVariableCoupledVectorTagDependencyHelper(needed_fe_var_vector_tags,
                                                     getActiveBlockObjects(id, tid));
}

updateBlockMatPropDependency()

template<typename T >

void MooseObjectWarehouseBase< T >::updateBlockMatPropDependency	(	SubdomainID	id,
		std::unordered_set< unsigned int > &	needed_mat_props,
		THREAD_ID	tid = 0,
		const bool	producer_only = false
	)		const

Definition at line 825 of file MooseObjectWarehouseBase.h.

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

{
  if (hasActiveBlockObjects(id, tid))
    updateMatPropDependencyHelper(needed_mat_props, getActiveBlockObjects(id, tid), producer_only);
}

updateBlockVariableDependency()

template<typename T >

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

Definition at line 716 of file MooseObjectWarehouseBase.h.

Referenced by NonlinearThread::subdomainChanged().

{
  if (hasActiveBlockObjects(id, tid))
    updateVariableDependencyHelper(needed_moose_vars, getActiveBlockObjects(id, tid));
}

updateBoundaryFEVariableCoupledVectorTagDependency()

template<typename T >

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

Definition at line 788 of file MooseObjectWarehouseBase.h.

Referenced by ComputeNodalKernelBcsThread::onNode().

{
  if (hasActiveBoundaryObjects(id, tid))
    updateFEVariableCoupledVectorTagDependencyHelper(needed_fe_var_vector_tags,
                                                     getActiveBoundaryObjects(id, tid));
}

updateBoundaryMatPropDependency() [1/2]

template<typename T >

void MooseObjectWarehouseBase< T >::updateBoundaryMatPropDependency	(	std::unordered_set< unsigned int > &	needed_mat_props,
		THREAD_ID	tid = 0,
		const bool	producer_only = false
	)		const

Definition at line 837 of file MooseObjectWarehouseBase.h.

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

{
  if (hasActiveBoundaryObjects(tid))
    for (auto & active_bnd_object : _active_boundary_objects[tid])
      updateMatPropDependencyHelper(needed_mat_props, active_bnd_object.second, producer_only);
}

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 bool	producer_only = false
	)		const

Definition at line 849 of file MooseObjectWarehouseBase.h.

{
  if (hasActiveBoundaryObjects(id, tid))
    updateMatPropDependencyHelper(
        needed_mat_props, getActiveBoundaryObjects(id, tid), producer_only);
}

updateBoundaryVariableDependency() [1/2]

template<typename T >

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

Definition at line 727 of file MooseObjectWarehouseBase.h.

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

{
  if (hasActiveBoundaryObjects(tid))
  {
    typename std::map<BoundaryID, std::vector<std::shared_ptr<T>>>::const_iterator it;
    for (const auto & object_pair : _active_boundary_objects[tid])
      updateVariableDependencyHelper(needed_moose_vars, object_pair.second);
  }
}

updateBoundaryVariableDependency() [2/2]

template<typename T >

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

Definition at line 740 of file MooseObjectWarehouseBase.h.

{
  if (hasActiveBoundaryObjects(id, tid))
    updateVariableDependencyHelper(needed_moose_vars, getActiveBoundaryObjects(id, tid));
}

updateFEVariableCoupledVectorTagDependency()

template<typename T >

void MooseObjectWarehouseBase< T >::updateFEVariableCoupledVectorTagDependency	(	std::set< TagID > &	needed_fe_var_vector_tags,
		THREAD_ID	tid = 0
	)		const

Update FE variable coupleable vector tag vector for all objects, block-restricted objects, and boundary-restricted objects.

Definition at line 768 of file MooseObjectWarehouseBase.h.

{
  if (hasActiveObjects(tid))
    updateFEVariableCoupledVectorTagDependencyHelper(needed_fe_var_vector_tags,
                                                     _active_objects[tid]);
}

updateFEVariableCoupledVectorTagDependencyHelper()

template<typename T>

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

staticprotected

Helper method for updating FE variable coupleable vector tag vector.

Definition at line 798 of file MooseObjectWarehouseBase.h.

{
  for (const auto & object : objects)
  {
    auto c = dynamic_cast<const Coupleable *>(object.get());
    if (c)
    {
      const auto & tag_deps = c->getFEVariableCoupleableVectorTags();
      needed_fe_var_vector_tags.insert(tag_deps.begin(), tag_deps.end());
    }
  }
}

updateMatPropDependency()

template<typename T >

void MooseObjectWarehouseBase< T >::updateMatPropDependency	(	std::unordered_set< unsigned int > &	needed_mat_props,
		THREAD_ID	tid = 0,
		const bool	producer_only = false
	)		const

Update material property dependency vector.

Parameters

producer_only

Only append dependencies of materials producing the needed_mat_props

Definition at line 814 of file MooseObjectWarehouseBase.h.

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

{
  if (hasActiveObjects(tid))
    updateMatPropDependencyHelper(needed_mat_props, _active_objects[tid], producer_only);
}

updateMatPropDependencyHelper()

template<typename T>

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

protectedvirtual

Helper method for updating material property dependency vector.

Reimplemented in MaterialWarehouse.

Definition at line 862 of file MooseObjectWarehouseBase.h.

Referenced by MaterialWarehouse::updateMatPropDependencyHelper().

{
  for (auto & object : objects)
  {
    auto c = dynamic_cast<const MaterialPropertyInterface *>(object.get());
    if (c)
    {
      auto & mp_deps = c->getMatPropDependencies();
      needed_mat_props.insert(mp_deps.begin(), mp_deps.end());
    }
  }
}

updateVariableDependency()

template<typename T >

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

Update variable dependency vector.

Definition at line 707 of file MooseObjectWarehouseBase.h.

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

{
  if (hasActiveObjects(tid))
    updateVariableDependencyHelper(needed_moose_vars, _active_objects[tid]);
}

updateVariableDependencyHelper()

template<typename T>

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

staticprotected

Helper method for updating variable dependency vector.

Definition at line 751 of file MooseObjectWarehouseBase.h.

{
  for (const auto & object : objects)
  {
    auto c = dynamic_cast<const MooseVariableDependencyInterface *>(object.get());
    if (c)
    {
      const auto & mv_deps = c->getMooseVariableDependencies();
      needed_moose_vars.insert(mv_deps.begin(), mv_deps.end());
    }
  }
}

Friends And Related Function Documentation

MaterialWarehouse

template<typename T>

friend class MaterialWarehouse

friend

Definition at line 283 of file MooseObjectWarehouseBase.h.

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

protected

Active block restricted objects (THREAD_ID on outer vector)

Definition at line 229 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

protected

Active boundary restricted objects (THREAD_ID on outer vector)

Definition at line 235 of file MooseObjectWarehouseBase.h.

_active_objects

template<typename T>

std::vector<std::vector<std::shared_ptr<T> > > MooseObjectWarehouseBase< T >::_active_objects

protected

All active objects (THREAD_ID on outer vector)

Definition at line 223 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

protected

Definition at line 226 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

protected

Definition at line 232 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

protected

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

Definition at line 220 of file MooseObjectWarehouseBase.h.

Referenced by MaterialWarehouse::sort().

_all_variable_objects

template<typename T>

std::vector<std::map<VariableName, std::vector<std::shared_ptr<T> > > > MooseObjectWarehouseBase< T >::_all_variable_objects

protected

All objects with a certain variable selected, as the 'variable' parameter.

Definition at line 238 of file MooseObjectWarehouseBase.h.

_num_threads

template<typename T>

const THREAD_ID MooseObjectWarehouseBase< T >::_num_threads

protected

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

Definition at line 217 of file MooseObjectWarehouseBase.h.

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

---

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

• include/warehouses/MooseObjectWarehouseBase.h