www.mooseframework.org
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
MaterialWarehouse Class Reference

Material objects are special in that they have additional objects created automatically (see FEProblemBase::addMaterial). More...

#include <MaterialWarehouse.h>

Inheritance diagram for MaterialWarehouse:
[legend]

Public Member Functions

const MooseObjectWarehouse< Material > & operator[] (Moose::MaterialDataType data_type) const
 
void addObjects (std::shared_ptr< Material > block, std::shared_ptr< Material > neighbor, std::shared_ptr< Material > face, THREAD_ID tid=0)
 A special method unique to this class for adding Block, Neighbor, and Face material objects. More...
 
virtual void addObject (std::shared_ptr< Material > object, THREAD_ID tid=0, bool recurse=true) override
 Adds an object to the storage structure. More...
 
unsigned int size (THREAD_ID tid=0)
 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 ()
 Return the number of threads. More...
 
virtual void initialSetup (THREAD_ID tid=0) const
 Convenience methods for calling object setup methods that handle the extra neighbor and face objects. More...
 
virtual void timestepSetup (THREAD_ID tid=0) const
 
virtual void subdomainSetup (THREAD_ID tid=0) const
 
virtual void subdomainSetup (SubdomainID id, THREAD_ID tid=0) const
 
virtual void neighborSubdomainSetup (THREAD_ID tid=0) const
 
virtual void neighborSubdomainSetup (SubdomainID id, THREAD_ID tid=0) const
 
virtual void jacobianSetup (THREAD_ID tid=0) const
 
virtual void residualSetup (THREAD_ID tid=0) const
 
virtual void updateActive (THREAD_ID tid=0)
 Update the active status of Kernels. More...
 
void sort (THREAD_ID tid=0)
 
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< Material > > & getActiveVariableBlockObjects (unsigned int variable_id, SubdomainID block_id, THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< Material > > & 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< Material > > > & getBlockObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< Material > > & getBlockObjects (SubdomainID id, THREAD_ID tid=0) const
 
const std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > & getBoundaryObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< Material > > & getBoundaryObjects (BoundaryID id, THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< Material > > & 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< Material > > > & getActiveBlockObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< Material > > & getActiveBlockObjects (SubdomainID id, THREAD_ID tid=0) const
 
const std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > & getActiveBoundaryObjects (THREAD_ID tid=0) const
 
const std::vector< std::shared_ptr< Material > > & 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 hasActiveObject (const std::string &name, THREAD_ID tid=0) const
 Convenience functions for checking/getting specific objects. More...
 
std::shared_ptr< MaterialgetObject (const std::string &name, THREAD_ID tid=0) const
 
std::shared_ptr< MaterialgetActiveObject (const std::string &name, THREAD_ID tid=0) const
 
void updateVariableDependency (std::set< MooseVariableFEBase * > &needed_moose_vars, THREAD_ID tid=0) const
 Update variable dependency vector. More...
 
void updateBlockVariableDependency (SubdomainID id, std::set< MooseVariableFEBase * > &needed_moose_vars, THREAD_ID tid=0) const
 
void updateBoundaryVariableDependency (std::set< MooseVariableFEBase * > &needed_moose_vars, THREAD_ID tid=0) const
 
void updateBoundaryVariableDependency (BoundaryID id, std::set< MooseVariableFEBase * > &needed_moose_vars, THREAD_ID tid=0) const
 
void updateMatPropDependency (std::set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
 Update material property dependency vector. More...
 
void updateBlockMatPropDependency (SubdomainID id, std::set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
 
void updateBoundaryMatPropDependency (std::set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
 
void updateBoundaryMatPropDependency (BoundaryID id, std::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< Material >> &active, const std::vector< std::shared_ptr< Material >> &all)
 Helper method for updating active vectors. More...
 
static void sortHelper (std::vector< std::shared_ptr< Material >> &objects)
 Helper method for sorting vectors of objects. More...
 
static void updateVariableDependencyHelper (std::set< MooseVariableFEBase * > &needed_moose_vars, const std::vector< std::shared_ptr< Material >> &objects)
 Helper method for updating variable dependency vector. More...
 
static void updateMatPropDependencyHelper (std::set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< Material >> &objects)
 Helper method for updating material property dependency vector. More...
 

Protected Attributes

MooseObjectWarehouse< Material_neighbor_materials
 Storage for neighbor material objects (Block are stored in the base class) More...
 
MooseObjectWarehouse< Material_face_materials
 Storage for face material objects (Block are stored in the base class) More...
 
std::map< unsigned int, MooseObjectWarehouse< Material > > _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< Material > > > _all_objects
 Storage container for the ALL pointers (THREAD_ID on outer vector) More...
 
std::vector< std::vector< std::shared_ptr< Material > > > _active_objects
 All active objects (THREAD_ID on outer vector) More...
 
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _all_block_objects
 
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _active_block_objects
 Active block restricted objects (THREAD_ID on outer vector) More...
 
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _all_boundary_objects
 
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _active_boundary_objects
 Active boundary restricted objects (THREAD_ID on outer vector) More...
 

Detailed Description

Material objects are special in that they have additional objects created automatically (see FEProblemBase::addMaterial).

This class specializes the base class to acount for the additional Neightbor and face objects that may exist.

Definition at line 27 of file MaterialWarehouse.h.

Member Function Documentation

◆ addObject()

void MooseObjectWarehouse< Material >::addObject ( std::shared_ptr< Material object,
THREAD_ID  tid = 0,
bool  recurse = true 
)
overridevirtualinherited

Adds an object to the storage structure.

Parameters
objectA shared pointer to the object being added
tidThe thread ID (default is 0)
recurseWhether or not to build recusive warehouses (typically for Kernels)

Reimplemented from MooseObjectWarehouseBase< Material >.

Definition at line 93 of file MooseObjectWarehouse.h.

96 {
97  MooseObjectWarehouseBase<T>::addObject(object, tid, recurse);
98 
99  if (recurse)
100  {
101  {
103 
104  if (mvi)
105  _variable_objects[mvi->mooseVariable()->number()].addObject(object, tid, false);
106  }
107 
108  {
110 
111  if (mvi)
112  _variable_objects[mvi->mooseVariable()->number()].addObject(object, tid, false);
113  }
114  }
115 }
std::unique_ptr< T_DEST, T_DELETER > dynamic_pointer_cast(std::unique_ptr< T_SRC, T_DELETER > &src)
std::map< unsigned int, MooseObjectWarehouse< Material > > _variable_objects
Variable based storage.
virtual void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true)
Adds an object to the storage structure.

◆ addObjects()

void MaterialWarehouse::addObjects ( std::shared_ptr< Material block,
std::shared_ptr< Material neighbor,
std::shared_ptr< Material face,
THREAD_ID  tid = 0 
)

A special method unique to this class for adding Block, Neighbor, and Face material objects.

Definition at line 15 of file MaterialWarehouse.C.

Referenced by FEProblemBase::addMaterialHelper().

19 {
21  _neighbor_materials.addObject(neighbor, tid);
22  _face_materials.addObject(face, tid);
23 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)
virtual void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true) override
Adds an object to the storage structure.

◆ checkThreadID()

void MooseObjectWarehouseBase< Material >::checkThreadID ( THREAD_ID  tid) const
inlineprotectedinherited

Calls assert on thread id.

Definition at line 694 of file MooseObjectWarehouseBase.h.

695 {
696  mooseAssert(tid < _num_threads,
697  "Attempting to access a thread id ("
698  << tid << ") greater than the number allowed by the storage item ("
699  << _num_threads << ")");
700 }
const THREAD_ID _num_threads
Convenience member storing the number of threads used for storage (1 or libMesh::n_threads) ...

◆ getActiveBlockObjects() [1/2]

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

Definition at line 388 of file MooseObjectWarehouseBase.h.

389 {
390  checkThreadID(tid);
391  return _active_block_objects[tid];
392 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getActiveBlockObjects() [2/2]

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

Definition at line 396 of file MooseObjectWarehouseBase.h.

397 {
398  checkThreadID(tid);
399  const auto iter = _active_block_objects[tid].find(id);
400  mooseAssert(iter != _active_block_objects[tid].end(),
401  "Unable to located active block objects for the given id: " << id << ".");
402  return iter->second;
403 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getActiveBlocks()

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

Return a set of active SubdomainsIDs.

Definition at line 496 of file MooseObjectWarehouseBase.h.

497 {
498  checkThreadID(tid);
499  std::set<SubdomainID> ids;
500  for (const auto & object_pair : _active_block_objects[tid])
501  ids.insert(object_pair.first);
502  return ids;
503 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _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]

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

Definition at line 369 of file MooseObjectWarehouseBase.h.

370 {
371  checkThreadID(tid);
372  return _active_boundary_objects[tid];
373 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ getActiveBoundaryObjects() [2/2]

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

Definition at line 377 of file MooseObjectWarehouseBase.h.

378 {
379  checkThreadID(tid);
380  const auto iter = _active_boundary_objects[tid].find(id);
381  mooseAssert(iter != _active_boundary_objects[tid].end(),
382  "Unable to located active boundary objects for the given id: " << id << ".");
383  return iter->second;
384 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ getActiveObject()

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

Definition at line 485 of file MooseObjectWarehouseBase.h.

486 {
487  checkThreadID(tid);
488  for (const auto & object : _active_objects[tid])
489  if (object->name() == name)
490  return object;
491  mooseError("Unable to locate active object: ", name, ".");
492 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:208
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< Material > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ getActiveObjects()

const std::vector< std::shared_ptr< Material > > & MooseObjectWarehouseBase< Material >::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 361 of file MooseObjectWarehouseBase.h.

362 {
363  checkThreadID(tid);
364  return _active_objects[tid];
365 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< Material > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ getActiveVariableBlockObjects()

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

Definition at line 129 of file MooseObjectWarehouse.h.

132 {
133  checkThreadID(tid);
134  const auto iter = _variable_objects.find(variable_id);
135  mooseAssert(iter != _variable_objects.end(),
136  "Unable to locate variable kernels for the given variable id: " << variable_id
137  << ".");
138  return iter->second.getActiveBlockObjects(block_id, tid);
139 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::map< unsigned int, MooseObjectWarehouse< Material > > _variable_objects
Variable based storage.

◆ getBlockObjects() [1/2]

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

Definition at line 342 of file MooseObjectWarehouseBase.h.

343 {
344  checkThreadID(tid);
345  return _all_block_objects[tid];
346 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _all_block_objects
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getBlockObjects() [2/2]

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

Definition at line 350 of file MooseObjectWarehouseBase.h.

351 {
352  checkThreadID(tid);
353  const auto iter = _all_block_objects[tid].find(id);
354  mooseAssert(iter != _all_block_objects[tid].end(),
355  "Unable to located active block objects for the given id: " << id << ".");
356  return iter->second;
357 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _all_block_objects
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ getBoundaryObjects() [1/2]

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

Definition at line 323 of file MooseObjectWarehouseBase.h.

324 {
325  checkThreadID(tid);
326  return _all_boundary_objects[tid];
327 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _all_boundary_objects

◆ getBoundaryObjects() [2/2]

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

Definition at line 331 of file MooseObjectWarehouseBase.h.

332 {
333  checkThreadID(tid);
334  const auto iter = _all_boundary_objects[tid].find(id);
335  mooseAssert(iter != _all_boundary_objects[tid].end(),
336  "Unable to located active boundary objects for the given id: " << id << ".");
337  return iter->second;
338 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _all_boundary_objects

◆ getObject()

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

Definition at line 474 of file MooseObjectWarehouseBase.h.

475 {
476  checkThreadID(tid);
477  for (const auto & object : _all_objects[tid])
478  if (object->name() == name)
479  return object;
480  mooseError("Unable to locate object: ", name, ".");
481 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:208
std::vector< std::vector< std::shared_ptr< Material > > > _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()

const std::vector< std::shared_ptr< Material > > & MooseObjectWarehouseBase< Material >::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 315 of file MooseObjectWarehouseBase.h.

316 {
317  checkThreadID(tid);
318  return _all_objects[tid];
319 }
std::vector< std::vector< std::shared_ptr< Material > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ hasActiveBlockObjects() [1/2]

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

Definition at line 423 of file MooseObjectWarehouseBase.h.

424 {
425  checkThreadID(tid);
426  bool has_active_block_objects = false;
427  for (const auto & object_pair : _active_block_objects[tid])
428  has_active_block_objects |= !(object_pair.second.empty());
429  return has_active_block_objects;
430 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _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]

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

Definition at line 434 of file MooseObjectWarehouseBase.h.

435 {
436  checkThreadID(tid);
437  const auto iter = _active_block_objects[tid].find(id);
438  return iter != _active_block_objects[tid].end();
439 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _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]

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

Definition at line 443 of file MooseObjectWarehouseBase.h.

444 {
445  checkThreadID(tid);
446  bool has_active_boundary_objects = false;
447  for (const auto & object_pair : _active_boundary_objects[tid])
448  has_active_boundary_objects |= !(object_pair.second.empty());
449  return has_active_boundary_objects;
450 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ hasActiveBoundaryObjects() [2/2]

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

Definition at line 454 of file MooseObjectWarehouseBase.h.

455 {
456  checkThreadID(tid);
457  const auto iter = _active_boundary_objects[tid].find(id);
458  return iter != _active_boundary_objects[tid].end();
459 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ hasActiveObject()

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

Convenience functions for checking/getting specific objects.

Definition at line 463 of file MooseObjectWarehouseBase.h.

464 {
465  checkThreadID(tid);
466  for (const auto & object : _active_objects[tid])
467  if (object->name() == name)
468  return true;
469  return false;
470 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< Material > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ hasActiveObjects()

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

Definition at line 415 of file MooseObjectWarehouseBase.h.

416 {
417  checkThreadID(tid);
418  return !_active_objects[tid].empty();
419 }
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.
std::vector< std::vector< std::shared_ptr< Material > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ hasActiveVariableBlockObjects()

bool MooseObjectWarehouse< Material >::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 119 of file MooseObjectWarehouse.h.

122 {
123  auto iter = _variable_objects.find(variable_id);
124  return (iter != _variable_objects.end() && iter->second.hasActiveBlockObjects(block_id, tid));
125 }
std::map< unsigned int, MooseObjectWarehouse< Material > > _variable_objects
Variable based storage.

◆ hasObjects()

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

Convenience functions for determining if objects exist.

Definition at line 407 of file MooseObjectWarehouseBase.h.

408 {
409  checkThreadID(tid);
410  return !_all_objects[tid].empty();
411 }
std::vector< std::vector< std::shared_ptr< Material > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
void checkThreadID(THREAD_ID tid) const
Calls assert on thread id.

◆ initialSetup()

void MaterialWarehouse::initialSetup ( THREAD_ID  tid = 0) const
virtual

Convenience methods for calling object setup methods that handle the extra neighbor and face objects.

Reimplemented from MooseObjectWarehouse< Material >.

Definition at line 42 of file MaterialWarehouse.C.

Referenced by FEProblemBase::initialSetup().

43 {
47 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
virtual void initialSetup(THREAD_ID tid=0) const
Convenience methods for calling object setup methods.
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)

◆ jacobianSetup()

void MaterialWarehouse::jacobianSetup ( THREAD_ID  tid = 0) const
virtual

Reimplemented from MooseObjectWarehouse< Material >.

Definition at line 92 of file MaterialWarehouse.C.

Referenced by FEProblemBase::computeJacobianTags().

93 {
97 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
virtual void jacobianSetup(THREAD_ID tid=0) const
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)

◆ neighborSubdomainSetup() [1/2]

void MaterialWarehouse::neighborSubdomainSetup ( THREAD_ID  tid = 0) const
virtual

Definition at line 65 of file MaterialWarehouse.C.

Referenced by FEProblemBase::neighborSubdomainSetup().

66 {
68 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
virtual void subdomainSetup(THREAD_ID tid=0) const

◆ neighborSubdomainSetup() [2/2]

void MaterialWarehouse::neighborSubdomainSetup ( SubdomainID  id,
THREAD_ID  tid = 0 
) const
virtual

Definition at line 78 of file MaterialWarehouse.C.

79 {
81 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
virtual void subdomainSetup(THREAD_ID tid=0) const

◆ numThreads()

THREAD_ID MooseObjectWarehouseBase< Material >::numThreads ( )
inlineinherited

Return the number of threads.

Definition at line 163 of file MooseObjectWarehouseBase.h.

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

◆ operator[]()

const MooseObjectWarehouse< Material > & MaterialWarehouse::operator[] ( Moose::MaterialDataType  data_type) const

Definition at line 26 of file MaterialWarehouse.C.

27 {
28  switch (data_type)
29  {
31  return _neighbor_materials;
32  break;
34  return _face_materials;
35  break;
36  default:
37  return *this;
38  }
39 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)

◆ residualSetup()

void MaterialWarehouse::residualSetup ( THREAD_ID  tid = 0) const
virtual

Reimplemented from MooseObjectWarehouse< Material >.

Definition at line 84 of file MaterialWarehouse.C.

Referenced by FEProblemBase::computeBounds(), and FEProblemBase::computeResidualTags().

85 {
89 }
virtual void residualSetup(THREAD_ID tid=0) const
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)

◆ size()

unsigned int MooseObjectWarehouseBase< Material >::size ( THREAD_ID  tid = 0)
inherited

Return how many kernels we store in the current warehouse.

Definition at line 235 of file MooseObjectWarehouseBase.h.

236 {
237  checkThreadID(tid);
238  return _all_objects[tid].size();
239 }
std::vector< std::vector< std::shared_ptr< Material > > > _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()

void MaterialWarehouse::sort ( THREAD_ID  tid = 0)

Definition at line 108 of file MaterialWarehouse.C.

Referenced by FEProblemBase::initialSetup().

109 {
112  _face_materials.sort(tid);
113 }
void sort(THREAD_ID tid=0)
Sort the objects using the DependencyResolver.
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)

◆ sortHelper()

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

Helper method for sorting vectors of objects.

Definition at line 674 of file MooseObjectWarehouseBase.h.

675 {
676  // Do nothing if the vector is empty
677  if (objects.empty())
678  return;
679 
680  try
681  {
682  // Sort based on dependencies
683  DependencyResolverInterface::sort<std::shared_ptr<T>>(objects);
684  }
685  catch (CyclicDependencyException<std::shared_ptr<T>> & e)
686  {
687  DependencyResolverInterface::cyclicDependencyError<std::shared_ptr<T>>(
688  e, "Cyclic dependency detected in object ordering");
689  }
690 }

◆ subdomainsCovered()

void MooseObjectWarehouseBase< Material >::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 661 of file MooseObjectWarehouseBase.h.

664 {
665  for (const auto & object : _active_objects[tid])
666  unique_variables.insert(object->variable().name());
667 
668  for (const auto & object_pair : _active_block_objects[tid])
669  subdomains_covered.insert(object_pair.first);
670 }
std::vector< std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > > _active_block_objects
Active block restricted objects (THREAD_ID on outer vector)
std::vector< std::vector< std::shared_ptr< Material > > > _active_objects
All active objects (THREAD_ID on outer vector)

◆ subdomainSetup() [1/2]

void MaterialWarehouse::subdomainSetup ( THREAD_ID  tid = 0) const
virtual

Reimplemented from MooseObjectWarehouse< Material >.

Definition at line 58 of file MaterialWarehouse.C.

Referenced by FEProblemBase::subdomainSetup().

59 {
62 }
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)
virtual void subdomainSetup(THREAD_ID tid=0) const

◆ subdomainSetup() [2/2]

void MaterialWarehouse::subdomainSetup ( SubdomainID  id,
THREAD_ID  tid = 0 
) const
virtual

Reimplemented from MooseObjectWarehouse< Material >.

Definition at line 71 of file MaterialWarehouse.C.

72 {
75 }
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)
virtual void subdomainSetup(THREAD_ID tid=0) const

◆ timestepSetup()

void MaterialWarehouse::timestepSetup ( THREAD_ID  tid = 0) const
virtual

Reimplemented from MooseObjectWarehouse< Material >.

Definition at line 50 of file MaterialWarehouse.C.

Referenced by FEProblemBase::timestepSetup().

51 {
55 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
virtual void timestepSetup(THREAD_ID tid=0) const
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)

◆ updateActive()

void MaterialWarehouse::updateActive ( THREAD_ID  tid = 0)
virtual

Update the active status of Kernels.

Reimplemented from MooseObjectWarehouse< Material >.

Definition at line 100 of file MaterialWarehouse.C.

Referenced by FEProblemBase::updateActiveObjects().

101 {
105 }
MooseObjectWarehouse< Material > _neighbor_materials
Storage for neighbor material objects (Block are stored in the base class)
MooseObjectWarehouse< Material > _face_materials
Storage for face material objects (Block are stored in the base class)
virtual void updateActive(THREAD_ID tid=0) override
Update the active status of Kernels.

◆ updateActiveHelper()

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

Helper method for updating active vectors.

Definition at line 522 of file MooseObjectWarehouseBase.h.

524 {
525  // Clear the active list
526  active.clear();
527 
528  std::copy_if(all.begin(),
529  all.end(),
530  std::back_inserter(active),
531  [](const std::shared_ptr<T> & object) { return object->enabled(); });
532 }

◆ updateBlockMatPropDependency()

void MooseObjectWarehouseBase< Material >::updateBlockMatPropDependency ( SubdomainID  id,
std::set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 620 of file MooseObjectWarehouseBase.h.

623 {
624  if (hasActiveBlockObjects(id, tid))
625  updateMatPropDependencyHelper(needed_mat_props, getActiveBlockObjects(id, tid));
626 }
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > & getActiveBlockObjects(THREAD_ID tid=0) const
static void updateMatPropDependencyHelper(std::set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating material property dependency vector.

◆ updateBlockVariableDependency()

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

Definition at line 563 of file MooseObjectWarehouseBase.h.

567 {
568  if (hasActiveBlockObjects(id, tid))
569  updateVariableDependencyHelper(needed_moose_vars, getActiveBlockObjects(id, tid));
570 }
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< Material > > > & getActiveBlockObjects(THREAD_ID tid=0) const
static void updateVariableDependencyHelper(std::set< MooseVariableFEBase * > &needed_moose_vars, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating variable dependency vector.

◆ updateBoundaryMatPropDependency() [1/2]

void MooseObjectWarehouseBase< Material >::updateBoundaryMatPropDependency ( std::set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 630 of file MooseObjectWarehouseBase.h.

632 {
633  if (hasActiveBoundaryObjects(tid))
634  for (auto & active_bnd_object : _active_boundary_objects[tid])
635  updateMatPropDependencyHelper(needed_mat_props, active_bnd_object.second);
636 }
static void updateMatPropDependencyHelper(std::set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating material property dependency vector.
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)

◆ updateBoundaryMatPropDependency() [2/2]

void MooseObjectWarehouseBase< Material >::updateBoundaryMatPropDependency ( BoundaryID  id,
std::set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 640 of file MooseObjectWarehouseBase.h.

642 {
643  if (hasActiveBoundaryObjects(id, tid))
644  updateMatPropDependencyHelper(needed_mat_props, getActiveBoundaryObjects(id, tid));
645 }
static void updateMatPropDependencyHelper(std::set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating material property dependency vector.
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
const std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const

◆ updateBoundaryVariableDependency() [1/2]

void MooseObjectWarehouseBase< Material >::updateBoundaryVariableDependency ( std::set< MooseVariableFEBase *> &  needed_moose_vars,
THREAD_ID  tid = 0 
) const
inherited

Definition at line 574 of file MooseObjectWarehouseBase.h.

576 {
577  if (hasActiveBoundaryObjects(tid))
578  {
579  typename std::map<BoundaryID, std::vector<std::shared_ptr<T>>>::const_iterator it;
580  for (const auto & object_pair : _active_boundary_objects[tid])
581  updateVariableDependencyHelper(needed_moose_vars, object_pair.second);
582  }
583 }
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
std::vector< std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > > _active_boundary_objects
Active boundary restricted objects (THREAD_ID on outer vector)
static void updateVariableDependencyHelper(std::set< MooseVariableFEBase * > &needed_moose_vars, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating variable dependency vector.

◆ updateBoundaryVariableDependency() [2/2]

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

Definition at line 587 of file MooseObjectWarehouseBase.h.

591 {
592  if (hasActiveBoundaryObjects(id, tid))
593  updateVariableDependencyHelper(needed_moose_vars, getActiveBoundaryObjects(id, tid));
594 }
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
const std::map< BoundaryID, std::vector< std::shared_ptr< Material > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const
static void updateVariableDependencyHelper(std::set< MooseVariableFEBase * > &needed_moose_vars, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating variable dependency vector.

◆ updateMatPropDependency()

void MooseObjectWarehouseBase< Material >::updateMatPropDependency ( std::set< unsigned int > &  needed_mat_props,
THREAD_ID  tid = 0 
) const
inherited

Update material property dependency vector.

Definition at line 611 of file MooseObjectWarehouseBase.h.

613 {
614  if (hasActiveObjects(tid))
615  updateMatPropDependencyHelper(needed_mat_props, _all_objects[tid]);
616 }
std::vector< std::vector< std::shared_ptr< Material > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
static void updateMatPropDependencyHelper(std::set< unsigned int > &needed_mat_props, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating material property dependency vector.
bool hasActiveObjects(THREAD_ID tid=0) const

◆ updateMatPropDependencyHelper()

void MooseObjectWarehouseBase< Material >::updateMatPropDependencyHelper ( std::set< unsigned int > &  needed_mat_props,
const std::vector< std::shared_ptr< Material >> &  objects 
)
staticprotectedinherited

Helper method for updating material property dependency vector.

Definition at line 649 of file MooseObjectWarehouseBase.h.

651 {
652  for (auto & object : objects)
653  {
654  auto & mp_deps = object->getMatPropDependencies();
655  needed_mat_props.insert(mp_deps.begin(), mp_deps.end());
656  }
657 }

◆ updateVariableDependency()

void MooseObjectWarehouseBase< Material >::updateVariableDependency ( std::set< MooseVariableFEBase *> &  needed_moose_vars,
THREAD_ID  tid = 0 
) const
inherited

Update variable dependency vector.

Definition at line 554 of file MooseObjectWarehouseBase.h.

556 {
557  if (hasActiveObjects(tid))
558  updateVariableDependencyHelper(needed_moose_vars, _all_objects[tid]);
559 }
std::vector< std::vector< std::shared_ptr< Material > > > _all_objects
Storage container for the ALL pointers (THREAD_ID on outer vector)
bool hasActiveObjects(THREAD_ID tid=0) const
static void updateVariableDependencyHelper(std::set< MooseVariableFEBase * > &needed_moose_vars, const std::vector< std::shared_ptr< Material >> &objects)
Helper method for updating variable dependency vector.

◆ updateVariableDependencyHelper()

void MooseObjectWarehouseBase< Material >::updateVariableDependencyHelper ( std::set< MooseVariableFEBase *> &  needed_moose_vars,
const std::vector< std::shared_ptr< Material >> &  objects 
)
staticprotectedinherited

Helper method for updating variable dependency vector.

Definition at line 598 of file MooseObjectWarehouseBase.h.

601 {
602  for (const auto & object : objects)
603  {
604  const auto & mv_deps = object->getMooseVariableDependencies();
605  needed_moose_vars.insert(mv_deps.begin(), mv_deps.end());
606  }
607 }

Member Data Documentation

◆ _active_block_objects

std::vector<std::map<SubdomainID, std::vector<std::shared_ptr<Material > > > > MooseObjectWarehouseBase< Material >::_active_block_objects
protectedinherited

Active block restricted objects (THREAD_ID on outer vector)

Definition at line 179 of file MooseObjectWarehouseBase.h.

◆ _active_boundary_objects

std::vector<std::map<BoundaryID, std::vector<std::shared_ptr<Material > > > > MooseObjectWarehouseBase< Material >::_active_boundary_objects
protectedinherited

Active boundary restricted objects (THREAD_ID on outer vector)

Definition at line 185 of file MooseObjectWarehouseBase.h.

◆ _active_objects

std::vector<std::vector<std::shared_ptr<Material > > > MooseObjectWarehouseBase< Material >::_active_objects
protectedinherited

All active objects (THREAD_ID on outer vector)

Definition at line 173 of file MooseObjectWarehouseBase.h.

◆ _all_block_objects

std::vector<std::map<SubdomainID, std::vector<std::shared_ptr<Material > > > > MooseObjectWarehouseBase< Material >::_all_block_objects
protectedinherited

Definition at line 176 of file MooseObjectWarehouseBase.h.

◆ _all_boundary_objects

std::vector<std::map<BoundaryID, std::vector<std::shared_ptr<Material > > > > MooseObjectWarehouseBase< Material >::_all_boundary_objects
protectedinherited

Definition at line 182 of file MooseObjectWarehouseBase.h.

◆ _all_objects

std::vector<std::vector<std::shared_ptr<Material > > > MooseObjectWarehouseBase< Material >::_all_objects
protectedinherited

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

Definition at line 170 of file MooseObjectWarehouseBase.h.

◆ _face_materials

MooseObjectWarehouse<Material> MaterialWarehouse::_face_materials
protected

Storage for face material objects (Block are stored in the base class)

Definition at line 62 of file MaterialWarehouse.h.

Referenced by addObjects(), initialSetup(), jacobianSetup(), operator[](), residualSetup(), sort(), subdomainSetup(), timestepSetup(), and updateActive().

◆ _neighbor_materials

MooseObjectWarehouse<Material> MaterialWarehouse::_neighbor_materials
protected

Storage for neighbor material objects (Block are stored in the base class)

Definition at line 59 of file MaterialWarehouse.h.

Referenced by addObjects(), initialSetup(), jacobianSetup(), neighborSubdomainSetup(), operator[](), residualSetup(), sort(), timestepSetup(), and updateActive().

◆ _num_threads

const THREAD_ID MooseObjectWarehouseBase< Material >::_num_threads
protectedinherited

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

Definition at line 167 of file MooseObjectWarehouseBase.h.

◆ _variable_objects

std::map<unsigned int, MooseObjectWarehouse<Material > > MooseObjectWarehouse< Material >::_variable_objects
protectedinherited

Variable based storage.

Definition at line 82 of file MooseObjectWarehouse.h.


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