Warehouse for storing initial conditions. More...

#include <InitialConditionWarehouse.h>

Inheritance diagram for InitialConditionWarehouse:

Public Member Functions
	InitialConditionWarehouse ()

void	initialSetup (THREAD_ID tid)
	Initial setup. More...

void	addObject (std::shared_ptr< InitialConditionBase > object, THREAD_ID tid, bool recurse=true)
	Add object to the warehouse. More...

std::set< std::string >	getDependObjects () const
	Get a list of dependent UserObjects for this exec type. More...

unsigned int	size (THREAD_ID tid=0) const
	Return how many kernels we store in the current warehouse. More...

std::set< SubdomainID >	getActiveBlocks (THREAD_ID tid=0) const
	Return a set of active SubdomainsIDs. 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< InitialConditionBase > > &	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< InitialConditionBase > > > &	getBlockObjects (THREAD_ID tid=0) const

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

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

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


const std::vector< std::shared_ptr< InitialConditionBase > > &	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< InitialConditionBase > > > &	getActiveBlockObjects (THREAD_ID tid=0) const

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

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

const std::vector< std::shared_ptr< InitialConditionBase > > &	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< InitialConditionBase >	getObject (const std::string &name, THREAD_ID tid=0) const

std::shared_ptr< InitialConditionBase >	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
void	checkThreadID (THREAD_ID tid) const
	Calls assert on thread id. More...

Static Protected Member Functions
static void	updateActiveHelper (std::vector< std::shared_ptr< InitialConditionBase >> &active, const std::vector< std::shared_ptr< InitialConditionBase >> &all)
	Helper method for updating active vectors. More...

static void	sortHelper (std::vector< std::shared_ptr< InitialConditionBase >> &objects)
	Helper method for sorting vectors of objects. More...

static void	updateVariableDependencyHelper (std::set< MooseVariableFieldBase * > &needed_moose_vars, const std::vector< std::shared_ptr< InitialConditionBase >> &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< InitialConditionBase >> &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< InitialConditionBase >> &objects)
	Helper method for updating material property dependency 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< InitialConditionBase > > >	_all_objects
	Storage container for the ALL pointers (THREAD_ID on outer vector) More...

std::vector< std::vector< std::shared_ptr< InitialConditionBase > > >	_active_objects
	All active objects (THREAD_ID on outer vector) More...

std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< InitialConditionBase > > > >	_all_block_objects

std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< InitialConditionBase > > > >	_active_block_objects
	Active block restricted objects (THREAD_ID on outer vector) More...

std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< InitialConditionBase > > > >	_all_boundary_objects

std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< InitialConditionBase > > > >	_active_boundary_objects
	Active boundary restricted objects (THREAD_ID on outer vector) More...


std::vector< std::map< std::string, std::set< BoundaryID > > >	_boundary_ics

std::vector< std::map< std::string, std::set< SubdomainID > > >	_block_ics

Detailed Description

Warehouse for storing initial conditions.

Definition at line 20 of file InitialConditionWarehouse.h.

Constructor & Destructor Documentation

◆ InitialConditionWarehouse()

InitialConditionWarehouse::InitialConditionWarehouse ( )

Definition at line 16 of file InitialConditionWarehouse.C.

   : MooseObjectWarehouseBase<InitialConditionBase>(),
     _boundary_ics(libMesh::n_threads()),
     _block_ics(libMesh::n_threads())
 {
 }

Member Function Documentation

◆ activeObjectsToFormattedString()

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

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

Definition at line 761 of file MooseObjectWarehouseBase.h.

 {
   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()

void InitialConditionWarehouse::addObject	(	std::shared_ptr< InitialConditionBase >	object,
		THREAD_ID	tid,
		bool	recurse = `true`
	)

virtual

Add object to the warehouse.

Reimplemented from MooseObjectWarehouseBase< InitialConditionBase >.

Definition at line 32 of file InitialConditionWarehouse.C.

Referenced by FEProblemBase::addInitialCondition().

 {
   // Check that when object is boundary restricted that the variable is nodal
   const MooseVariableFEBase & var = object->variable();
 
   // Boundary Restricted
   if (object->boundaryRestricted())
   {
     if (!var.isNodal())
       mooseError("You are trying to set a boundary restricted variable on non-nodal variable. That "
                  "is not allowed.");
 
     std::map<std::string, std::set<BoundaryID>>::const_iterator iter =
         _boundary_ics[tid].find(var.name());
     if (iter != _boundary_ics[tid].end() && object->hasBoundary(iter->second))
       mooseError("The initial condition '",
                  object->name(),
                  "' is being defined on a boundary that already has an initial condition defined.");
     else
       _boundary_ics[tid][var.name()].insert(object->boundaryIDs().begin(),
                                             object->boundaryIDs().end());
   }
 
   // Block Restricted
   else if (object->blockRestricted())
   {
     std::map<std::string, std::set<SubdomainID>>::const_iterator iter =
         _block_ics[tid].find(var.name());
     if (iter != _block_ics[tid].end() &&
         (object->hasBlocks(iter->second) ||
          (iter->second.find(Moose::ANY_BLOCK_ID) != iter->second.end())))
       mooseError("The initial condition '",
                  object->name(),
                  "' is being defined on a block that already has an initial condition defined.");
     else
       _block_ics[tid][var.name()].insert(object->blockIDs().begin(), object->blockIDs().end());
   }
 
   // Non-restricted
   else
   {
     std::map<std::string, std::set<SubdomainID>>::const_iterator iter =
         _block_ics[tid].find(var.name());
     if (iter != _block_ics[tid].end())
       mooseError("The initial condition '",
                  object->name(),
                  "' is being defined on a block that already has an initial condition defined.");
     else
       _block_ics[tid][var.name()].insert(Moose::ANY_BLOCK_ID);
   }
 
   // Add the IC to the storage
   MooseObjectWarehouseBase<InitialConditionBase>::addObject(object, tid, recurse);
 }

◆ checkThreadID()

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

inlineprotectedinherited

Calls assert on thread id.

Definition at line 792 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]

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

inlineinherited

Definition at line 427 of file MooseObjectWarehouseBase.h.

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

◆ getActiveBlockObjects() [2/2]

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

inherited

Definition at line 435 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()

std::set< SubdomainID > MooseObjectWarehouseBase< InitialConditionBase >::getActiveBlocks ( THREAD_ID tid = 0 ) const

inherited

Return a set of active SubdomainsIDs.

Definition at line 535 of file MooseObjectWarehouseBase.h.

 {
   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]

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

inlineinherited

Definition at line 408 of file MooseObjectWarehouseBase.h.

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

◆ getActiveBoundaryObjects() [2/2]

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

inherited

Definition at line 416 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()

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

inherited

Definition at line 524 of file MooseObjectWarehouseBase.h.

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

◆ getActiveObjects()

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

inlineinherited

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 400 of file MooseObjectWarehouseBase.h.

Referenced by getDependObjects().

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

◆ getBlockObjects() [1/2]

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

inlineinherited

Definition at line 381 of file MooseObjectWarehouseBase.h.

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

◆ getBlockObjects() [2/2]

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

inherited

Definition at line 389 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]

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

inlineinherited

Definition at line 354 of file MooseObjectWarehouseBase.h.

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

◆ getBoundaryObjects() [2/2]

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

inherited

Definition at line 370 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;
 }

◆ getDependObjects()

std::set< std::string > InitialConditionWarehouse::getDependObjects ( ) const

Get a list of dependent UserObjects for this exec type.

Returns: a set of dependent user objects

Definition at line 90 of file InitialConditionWarehouse.C.

Referenced by FEProblemBase::initialSetup().

 {
   std::set<std::string> depend_objects;
 
   const auto & ics = getActiveObjects();
   for (const auto & ic : ics)
   {
     const auto & uo = ic->getDependObjects();
     depend_objects.insert(uo.begin(), uo.end());
   }
 
   return depend_objects;
 }

◆ getObject()

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

inherited

Definition at line 513 of file MooseObjectWarehouseBase.h.

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

◆ getObjects()

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

inlineinherited

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 346 of file MooseObjectWarehouseBase.h.

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

◆ hasActiveBlockObjects() [1/2]

bool MooseObjectWarehouseBase< InitialConditionBase >::hasActiveBlockObjects ( THREAD_ID tid = 0 ) const

inherited

Definition at line 462 of file MooseObjectWarehouseBase.h.

 {
   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]

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

inherited

Definition at line 473 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]

bool MooseObjectWarehouseBase< InitialConditionBase >::hasActiveBoundaryObjects ( THREAD_ID tid = 0 ) const

inherited

Definition at line 482 of file MooseObjectWarehouseBase.h.

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

◆ hasActiveBoundaryObjects() [2/2]

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

inherited

Definition at line 493 of file MooseObjectWarehouseBase.h.

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

◆ hasActiveObject()

bool MooseObjectWarehouseBase< InitialConditionBase >::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.

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

◆ hasActiveObjects()

bool MooseObjectWarehouseBase< InitialConditionBase >::hasActiveObjects ( THREAD_ID tid = 0 ) const

inherited

Definition at line 454 of file MooseObjectWarehouseBase.h.

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

◆ hasBoundaryObjects()

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

inherited

Definition at line 362 of file MooseObjectWarehouseBase.h.

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

◆ hasObjects()

bool MooseObjectWarehouseBase< InitialConditionBase >::hasObjects ( THREAD_ID tid = 0 ) const

inherited

Convenience functions for determining if objects exist.

Definition at line 446 of file MooseObjectWarehouseBase.h.

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

◆ initialSetup()

void InitialConditionWarehouse::initialSetup ( THREAD_ID tid )

Initial setup.

Definition at line 24 of file InitialConditionWarehouse.C.

Referenced by FEProblemBase::initialSetup().

 {
   MooseObjectWarehouseBase<InitialConditionBase>::sort(tid);
   for (const auto & ic : _active_objects[tid])
     ic->initialSetup();
 }

◆ numThreads()

THREAD_ID MooseObjectWarehouseBase< InitialConditionBase >::numThreads ( ) const

inlineinherited

Return the number of threads.

Definition at line 177 of file MooseObjectWarehouseBase.h.

177 { return _num_threads; }

MooseObjectWarehouseBase< InitialConditionBase >::_num_threads

const THREAD_ID _num_threads

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

Definition: MooseObjectWarehouseBase.h:189

◆ size()

unsigned int MooseObjectWarehouseBase< InitialConditionBase >::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.

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

◆ sort()

void MooseObjectWarehouseBase< InitialConditionBase >::sort ( THREAD_ID tid = 0 )

inherited

Sort the objects using the DependencyResolver.

Definition at line 575 of file MooseObjectWarehouseBase.h.

 {
   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()

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

staticprotectedinherited

Helper method for sorting vectors of objects.

Definition at line 772 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()

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

 {
   for (const auto & object : _active_objects[tid])
     unique_variables.insert(object->variable().name());
 
   for (const auto & object_pair : _active_block_objects[tid])
     subdomains_covered.insert(object_pair.first);
 }

◆ updateActive()

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

virtualinherited

Updates the active objects storage.

Definition at line 546 of file MooseObjectWarehouseBase.h.

 {
   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()

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

staticprotectedinherited

Helper method for updating active vectors.

Definition at line 561 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()

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

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

◆ updateBlockMatPropDependency()

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

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

◆ updateBlockVariableDependency()

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

inherited

Definition at line 602 of file MooseObjectWarehouseBase.h.

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

◆ updateBoundaryFEVariableCoupledVectorTagDependency()

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

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

◆ updateBoundaryMatPropDependency() [1/2]

void MooseObjectWarehouseBase< InitialConditionBase >::updateBoundaryMatPropDependency	(	std::unordered_set< unsigned int > &	needed_mat_props,
		THREAD_ID	tid = `0`
	)		const

inherited

Definition at line 710 of file MooseObjectWarehouseBase.h.

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

◆ updateBoundaryMatPropDependency() [2/2]

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

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

◆ updateBoundaryVariableDependency() [1/2]

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

inherited

Definition at line 613 of file MooseObjectWarehouseBase.h.

 {
   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]

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

inherited

Definition at line 626 of file MooseObjectWarehouseBase.h.

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

◆ updateFEVariableCoupledVectorTagDependencyHelper()

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

staticprotectedinherited

Helper method for updating FE variable coupleable vector tag vector.

Definition at line 674 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()

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

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

◆ updateMatPropDependencyHelper()

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

staticprotectedinherited

Helper method for updating material property dependency vector.

Definition at line 731 of file MooseObjectWarehouseBase.h.

 {
   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()

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

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

◆ updateVariableDependencyHelper()

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

staticprotectedinherited

Helper method for updating variable dependency vector.

Definition at line 637 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());
     }
   }
 }

Member Data Documentation

◆ _active_block_objects

std::vector<std::map<SubdomainID, std::vector<std::shared_ptr<InitialConditionBase > > > > MooseObjectWarehouseBase< InitialConditionBase >::_active_block_objects

protectedinherited

Active block restricted objects (THREAD_ID on outer vector)

Definition at line 201 of file MooseObjectWarehouseBase.h.

◆ _active_boundary_objects

std::vector<std::map<BoundaryID, std::vector<std::shared_ptr<InitialConditionBase > > > > MooseObjectWarehouseBase< InitialConditionBase >::_active_boundary_objects

protectedinherited

Active boundary restricted objects (THREAD_ID on outer vector)

Definition at line 207 of file MooseObjectWarehouseBase.h.

◆ _active_objects

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

protectedinherited

All active objects (THREAD_ID on outer vector)

Definition at line 195 of file MooseObjectWarehouseBase.h.

Referenced by initialSetup().

◆ _all_block_objects

std::vector<std::map<SubdomainID, std::vector<std::shared_ptr<InitialConditionBase > > > > MooseObjectWarehouseBase< InitialConditionBase >::_all_block_objects

protectedinherited

Definition at line 198 of file MooseObjectWarehouseBase.h.

◆ _all_boundary_objects

std::vector<std::map<BoundaryID, std::vector<std::shared_ptr<InitialConditionBase > > > > MooseObjectWarehouseBase< InitialConditionBase >::_all_boundary_objects

protectedinherited

Definition at line 204 of file MooseObjectWarehouseBase.h.

◆ _all_objects

std::vector<std::vector<std::shared_ptr<InitialConditionBase > > > MooseObjectWarehouseBase< InitialConditionBase >::_all_objects

protectedinherited

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

Definition at line 192 of file MooseObjectWarehouseBase.h.

◆ _block_ics

std::vector<std::map<std::string, std::set<SubdomainID> > > InitialConditionWarehouse::_block_ics

protected

Definition at line 45 of file InitialConditionWarehouse.h.

Referenced by addObject().

◆ _boundary_ics

std::vector<std::map<std::string, std::set<BoundaryID> > > InitialConditionWarehouse::_boundary_ics

protected

Variable name to block/boundary IDs for error checking

Definition at line 44 of file InitialConditionWarehouse.h.

Referenced by addObject().

◆ _num_threads

const THREAD_ID MooseObjectWarehouseBase< InitialConditionBase >::_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.

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

include/ics/InitialConditionWarehouse.h
src/ics/InitialConditionWarehouse.C

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InitialConditionWarehouse()

Member Function Documentation

◆ activeObjectsToFormattedString()

◆ addObject()

◆ checkThreadID()

◆ getActiveBlockObjects() [1/2]

◆ getActiveBlockObjects() [2/2]

◆ getActiveBlocks()

◆ getActiveBoundaryObjects() [1/2]

◆ getActiveBoundaryObjects() [2/2]

◆ getActiveObject()

◆ getActiveObjects()

◆ getBlockObjects() [1/2]

◆ getBlockObjects() [2/2]

◆ getBoundaryObjects() [1/2]

◆ getBoundaryObjects() [2/2]

◆ getDependObjects()

◆ getObject()

◆ getObjects()

◆ hasActiveBlockObjects() [1/2]

◆ hasActiveBlockObjects() [2/2]

◆ hasActiveBoundaryObjects() [1/2]

◆ hasActiveBoundaryObjects() [2/2]

◆ hasActiveObject()

◆ hasActiveObjects()

◆ hasBoundaryObjects()

◆ hasObjects()

◆ initialSetup()

◆ numThreads()

◆ size()

◆ sort()

◆ sortHelper()

◆ subdomainsCovered()

◆ updateActive()

◆ updateActiveHelper()

◆ updateBlockFEVariableCoupledVectorTagDependency()

◆ updateBlockMatPropDependency()

◆ updateBlockVariableDependency()

◆ updateBoundaryFEVariableCoupledVectorTagDependency()

◆ updateBoundaryMatPropDependency() [1/2]

◆ updateBoundaryMatPropDependency() [2/2]

◆ updateBoundaryVariableDependency() [1/2]

◆ updateBoundaryVariableDependency() [2/2]

◆ updateFEVariableCoupledVectorTagDependencyHelper()

◆ updateMatPropDependency()

◆ updateMatPropDependencyHelper()

◆ updateVariableDependency()

◆ updateVariableDependencyHelper()

Member Data Documentation

◆ _active_block_objects

◆ _active_boundary_objects

◆ _active_objects

◆ _all_block_objects

◆ _all_boundary_objects

◆ _all_objects

◆ _block_ics

◆ _boundary_ics

◆ _num_threads