Class for threaded computation of UserObjects. More...
#include <ComputeUserObjectsThread.h>
Public Member Functions | |
ComputeUserObjectsThread (FEProblemBase &problem, const TheWarehouse::Query &query) | |
ComputeUserObjectsThread (ComputeUserObjectsThread &x, Threads::split) | |
virtual | ~ComputeUserObjectsThread () |
virtual void | onElement (const Elem *elem) override |
Assembly of the element (not including surface assembly) More... | |
virtual void | onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override |
Called when doing boundary assembling. More... | |
virtual void | onInternalSide (const Elem *elem, unsigned int side) override |
Called when doing internal edge assembling. More... | |
virtual void | onExternalSide (const Elem *elem, unsigned int side) override |
Called when iterating over external sides (no side neighbor) More... | |
virtual void | onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id) override |
Called when doing interface assembling. More... | |
virtual void | post () override |
Called after the element range loop. More... | |
virtual void | subdomainChanged () override |
Called every time the current subdomain changes (i.e. More... | |
void | join (const ComputeUserObjectsThread &) |
virtual void | caughtMooseException (MooseException &e) override |
Called if a MooseException is caught anywhere during the computation. More... | |
virtual bool | keepGoing () override |
Whether or not the loop should continue. More... | |
virtual void | preElement (const Elem *elem) override |
Called before the element assembly. More... | |
virtual void | preInternalSide (const Elem *elem, unsigned int side) override |
Called before evaluations on an element internal side. More... | |
virtual void | preBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override |
Called before the boundary assembly. More... | |
virtual void | neighborSubdomainChanged () override |
Called every time the neighbor subdomain changes (i.e. More... | |
virtual void | operator() (const ConstElemRange &range, bool bypass_threading=false) |
virtual void | pre () |
Called before the element range loop. More... | |
virtual void | postElement (const Elem *elem) |
Called after the element assembly is done (including surface assembling) More... | |
virtual void | postInternalSide (const Elem *elem, unsigned int side) |
Called after evaluations on an element internal side. More... | |
Protected Member Functions | |
void | printGeneralExecutionInformation () const override |
Print general information about the loop, like the ordering of class of objects. More... | |
void | printBlockExecutionInformation () const override |
Print information about the loop, mostly order of execution of particular objects. More... | |
template<typename T > | |
void | printVectorOrdering (std::vector< T *> uos, const std::string &name) const |
Format output of vector of UOs. More... | |
void | prepareElement (const Elem *elem) |
void | clearVarsAndMaterials () |
void | printExecutionOrdering (const std::vector< T * > &objs, const bool print_header=true, const std::string &line_prefix="[DBG]") const |
Routine to output the ordering of objects within a vector of pointers to these objects. More... | |
void | printExecutionOrdering (const std::vector< std::shared_ptr< T >> &objs_ptrs, const bool print_header=true, const std::string &line_prefix="[DBG]") const |
virtual void | printBoundaryExecutionInformation (const unsigned int) const |
Print information about the particular ordering of objects on each boundary. More... | |
void | resetExecPrintedSets () const |
Resets the set of blocks and boundaries visited. More... | |
virtual bool | shouldComputeInternalSide (const Elem &elem, const Elem &neighbor) const |
Whether to compute the internal side for the provided element-neighbor pair. More... | |
Protected Attributes | |
FEProblemBase & | _fe_problem |
MooseMesh & | _mesh |
THREAD_ID | _tid |
SubdomainID | _subdomain |
The subdomain for the current element. More... | |
SubdomainID | _old_subdomain |
The subdomain for the last element. More... | |
SubdomainID | _neighbor_subdomain |
The subdomain for the current neighbor. More... | |
SubdomainID | _old_neighbor_subdomain |
The subdomain for the last neighbor. More... | |
std::set< SubdomainID > | _blocks_exec_printed |
Keep track of which blocks were visited. More... | |
std::set< BoundaryID > | _boundaries_exec_printed |
Keep track of which boundaries were visited. More... | |
Private Member Functions | |
template<typename T > | |
void | querySubdomain (Interfaces iface, std::vector< T > &results) |
template<typename T > | |
void | queryBoundary (Interfaces iface, BoundaryID bnd, std::vector< T > &results) |
Private Attributes | |
const TheWarehouse::Query | _query |
TheWarehouse::QueryCache< AttribThread, AttribSubdomains, AttribInterfaces > | _query_subdomain |
TheWarehouse::QueryCache< AttribThread, AttribBoundaries, AttribInterfaces > | _query_boundary |
std::vector< InternalSideUserObject * > | _internal_side_objs |
std::vector< InterfaceUserObject * > | _interface_user_objects |
std::vector< ElementUserObject * > | _element_objs |
std::vector< ShapeElementUserObject * > | _shape_element_objs |
std::vector< DomainUserObject * > | _domain_objs |
std::vector< DomainUserObject * > | _all_domain_objs |
AuxiliarySystem & | _aux_sys |
Class for threaded computation of UserObjects.
Definition at line 37 of file ComputeUserObjectsThread.h.
ComputeUserObjectsThread::ComputeUserObjectsThread | ( | FEProblemBase & | problem, |
const TheWarehouse::Query & | query | ||
) |
Definition at line 29 of file ComputeUserObjectsThread.C.
ComputeUserObjectsThread::ComputeUserObjectsThread | ( | ComputeUserObjectsThread & | x, |
Threads::split | |||
) |
Definition at line 40 of file ComputeUserObjectsThread.C.
|
virtual |
Definition at line 49 of file ComputeUserObjectsThread.C.
|
overridevirtualinherited |
Called if a MooseException is caught anywhere during the computation.
The single input parameter taken is a MooseException object.
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 105 of file ThreadedElementLoop.h.
Referenced by ComputeJacobianForScalingThread::operator()().
|
protectedinherited |
Definition at line 195 of file ThreadedElementLoop.h.
Referenced by NonlinearThread::post().
void ComputeUserObjectsThread::join | ( | const ComputeUserObjectsThread & | ) |
Definition at line 328 of file ComputeUserObjectsThread.C.
|
inlineoverridevirtualinherited |
Whether or not the loop should continue.
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 45 of file ThreadedElementLoop.h.
Referenced by ComputeJacobianForScalingThread::operator()().
|
overridevirtualinherited |
Called every time the neighbor subdomain changes (i.e.
the subdomain of this neighbor is not the same as the subdomain of the last neighbor). Beware of over-using this! You might think that you can do some expensive stuff in here and get away with it... but there are applications that have TONS of subdomains....
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 139 of file ThreadedElementLoop.h.
|
overridevirtual |
Called when doing boundary assembling.
elem | - The element we are checking is on the boundary. |
side | - The side of the element in question. |
bnd_id | - ID of the boundary we are at |
lower_d_elem | - Lower dimensional element (e.g. Mortar) |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 165 of file ComputeUserObjectsThread.C.
|
overridevirtual |
Assembly of the element (not including surface assembly)
elem | - active element |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 118 of file ComputeUserObjectsThread.C.
|
overridevirtual |
Called when iterating over external sides (no side neighbor)
elem | - Element we are on |
side | - local side number of the element 'elem' |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 255 of file ComputeUserObjectsThread.C.
|
overridevirtual |
Called when doing interface assembling.
elem | - Element we are on |
side | - local side number of the element 'elem' |
bnd_id | - ID of the interface we are at |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 265 of file ComputeUserObjectsThread.C.
|
overridevirtual |
Called when doing internal edge assembling.
elem | - Element we are on |
side | - local side number of the element 'elem' |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 217 of file ComputeUserObjectsThread.C.
|
virtualinherited |
Reimplemented in NonlinearThread, and ComputeJacobianForScalingThread.
Definition at line 223 of file ThreadedElementLoopBase.h.
|
overridevirtual |
Called after the element range loop.
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 321 of file ComputeUserObjectsThread.C.
|
virtualinherited |
Called after the element assembly is done (including surface assembling)
elem | - active element |
Reimplemented in ComputeJacobianBlocksThread, NonlinearThread, ComputeIndicatorThread, ComputeJacobianThread, and ComputeMarkerThread.
Definition at line 351 of file ThreadedElementLoopBase.h.
|
virtualinherited |
Called after evaluations on an element internal side.
elem | - Element we are on |
side | - local side number of the element 'elem' |
Reimplemented in ComputeJacobianBlocksThread.
Definition at line 381 of file ThreadedElementLoopBase.h.
|
virtualinherited |
Called before the element range loop.
Definition at line 327 of file ThreadedElementLoopBase.h.
Referenced by ComputeJacobianForScalingThread::operator()().
|
overridevirtualinherited |
Called before the boundary assembly.
elem | - The element we are checking is on the boundary. |
side | - The side of the element in question. |
bnd_id | - ID of the boundary we are at |
lower_d_elem | - Lower dimensional element (e.g. Mortar) |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 129 of file ThreadedElementLoop.h.
|
overridevirtualinherited |
Called before the element assembly.
elem | - active element |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 115 of file ThreadedElementLoop.h.
Referenced by ComputeJacobianForScalingThread::operator()().
|
overridevirtualinherited |
Called before evaluations on an element internal side.
elem | - Element we are on |
side | - local side number of the element 'elem' |
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 122 of file ThreadedElementLoop.h.
|
protectedinherited |
Definition at line 186 of file ThreadedElementLoop.h.
Referenced by NonlinearThread::onElement().
|
overrideprotectedvirtual |
Print information about the loop, mostly order of execution of particular objects.
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 363 of file ComputeUserObjectsThread.C.
|
inlineprotectedvirtualinherited |
Print information about the particular ordering of objects on each boundary.
Reimplemented in NonlinearThread.
Definition at line 184 of file ThreadedElementLoopBase.h.
|
protectedinherited |
Routine to output the ordering of objects within a vector of pointers to these objects.
These objects must implement the name() routine, and it must return a string or compatible type.
T | the object type |
objs | the vector with all the objects (should be pointers) |
objects_type | the name of the type of objects. Defaults to the CPP object name |
print_header | whether to print a header about the timing of execution and the type of objects |
Definition at line 148 of file ThreadedElementLoop.h.
|
protectedinherited |
Definition at line 173 of file ThreadedElementLoop.h.
|
overrideprotectedvirtual |
Print general information about the loop, like the ordering of class of objects.
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 333 of file ComputeUserObjectsThread.C.
|
protected |
Format output of vector of UOs.
|
inlineprivate |
Definition at line 77 of file ComputeUserObjectsThread.h.
Referenced by onBoundary(), onInterface(), and printBlockExecutionInformation().
|
inlineprivate |
Definition at line 72 of file ComputeUserObjectsThread.h.
Referenced by subdomainChanged().
|
protectedinherited |
Resets the set of blocks and boundaries visited.
Definition at line 444 of file ThreadedElementLoopBase.h.
|
protectedvirtualinherited |
Whether to compute the internal side for the provided element-neighbor pair.
Typically this will return true if the element id is less than the neighbor id when the elements are equal level, or when the element is more refined than the neighbor, and then false otherwise. One type of loop where the logic will be different is when projecting stateful material properties
Reimplemented in NonlinearThread, and FlagElementsThread.
Definition at line 419 of file ThreadedElementLoopBase.h.
|
overridevirtual |
Called every time the current subdomain changes (i.e.
the subdomain of this element is not the same as the subdomain of the last element). Beware of over-using this! You might think that you can do some expensive stuff in here and get away with it... but there are applications that have TONS of subdomains....
Reimplemented from ThreadedElementLoopBase< ConstElemRange >.
Definition at line 52 of file ComputeUserObjectsThread.C.
|
private |
Definition at line 90 of file ComputeUserObjectsThread.h.
Referenced by onInterface(), and subdomainChanged().
|
private |
Definition at line 92 of file ComputeUserObjectsThread.h.
Referenced by onElement().
|
mutableprotectedinherited |
Keep track of which blocks were visited.
Definition at line 187 of file ThreadedElementLoopBase.h.
Referenced by ComputeMarkerThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), printBlockExecutionInformation(), and NonlinearThread::printBlockExecutionInformation().
|
mutableprotectedinherited |
Keep track of which boundaries were visited.
Definition at line 190 of file ThreadedElementLoopBase.h.
Referenced by NonlinearThread::printBoundaryExecutionInformation().
|
private |
Definition at line 89 of file ComputeUserObjectsThread.h.
Referenced by onBoundary(), onElement(), onExternalSide(), onInternalSide(), printBlockExecutionInformation(), and subdomainChanged().
|
private |
Definition at line 87 of file ComputeUserObjectsThread.h.
Referenced by onElement(), printBlockExecutionInformation(), and subdomainChanged().
|
protectedinherited |
Definition at line 62 of file ThreadedElementLoop.h.
Referenced by ComputeResidualThread::accumulate(), ComputeResidualAndJacobianThread::accumulate(), ComputeResidualThread::accumulateLower(), ComputeResidualAndJacobianThread::accumulateLower(), ComputeJacobianThread::accumulateLower(), ComputeResidualThread::accumulateNeighbor(), ComputeResidualAndJacobianThread::accumulateNeighbor(), ComputeJacobianThread::accumulateNeighbor(), ComputeResidualThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::accumulateNeighborLower(), ComputeJacobianThread::accumulateNeighborLower(), ComputeJacobianThread::compute(), ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualThread::determineObjectWarehouses(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), NonlinearThread::onBoundary(), onBoundary(), ComputeElemDampingThread::onElement(), NonlinearThread::onElement(), onElement(), NonlinearThread::onInterface(), onInterface(), NonlinearThread::onInternalSide(), onInternalSide(), post(), ComputeJacobianThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeJacobianBlocksThread::postInternalSide(), NonlinearThread::prepareFace(), printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), NonlinearThread::printBoundaryExecutionInformation(), ComputeElemDampingThread::printGeneralExecutionInformation(), printGeneralExecutionInformation(), NonlinearThread::printGeneralExecutionInformation(), NonlinearThread::subdomainChanged(), and subdomainChanged().
|
private |
Definition at line 86 of file ComputeUserObjectsThread.h.
|
private |
Definition at line 85 of file ComputeUserObjectsThread.h.
Referenced by onInternalSide(), printBlockExecutionInformation(), and subdomainChanged().
|
protectedinherited |
Definition at line 162 of file ThreadedElementLoopBase.h.
Referenced by CacheChangedListsThread::onElement(), NonlinearThread::printBlockExecutionInformation(), and NonlinearThread::printBoundaryExecutionInformation().
|
protectedinherited |
The subdomain for the current neighbor.
Definition at line 172 of file ThreadedElementLoopBase.h.
Referenced by ComputeResidualThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), and ComputeJacobianForScalingThread::operator()().
|
protectedinherited |
The subdomain for the last neighbor.
Definition at line 175 of file ThreadedElementLoopBase.h.
|
protectedinherited |
The subdomain for the last element.
Definition at line 169 of file ThreadedElementLoopBase.h.
Referenced by ComputeJacobianForScalingThread::operator()().
|
private |
Definition at line 82 of file ComputeUserObjectsThread.h.
Referenced by subdomainChanged().
|
private |
Definition at line 84 of file ComputeUserObjectsThread.h.
Referenced by queryBoundary().
|
private |
Definition at line 83 of file ComputeUserObjectsThread.h.
Referenced by querySubdomain().
|
private |
Definition at line 88 of file ComputeUserObjectsThread.h.
Referenced by onElement(), printBlockExecutionInformation(), and subdomainChanged().
|
protectedinherited |
The subdomain for the current element.
Definition at line 166 of file ThreadedElementLoopBase.h.
Referenced by ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnElement(), ComputeResidualThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeResidualThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeMaterialsObjectThread::onBoundary(), onBoundary(), ComputeMarkerThread::onElement(), ComputeIndicatorThread::onElement(), ComputeMaterialsObjectThread::onElement(), onElement(), ComputeMaterialsObjectThread::onInterface(), ComputeMaterialsObjectThread::onInternalSide(), NonlinearThread::onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeJacobianBlocksThread::postInternalSide(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), querySubdomain(), NonlinearThread::shouldComputeInternalSide(), ComputeMarkerThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), NonlinearThread::subdomainChanged(), and subdomainChanged().
|
protectedinherited |
Definition at line 163 of file ThreadedElementLoopBase.h.
Referenced by ComputeResidualThread::accumulate(), ComputeResidualAndJacobianThread::accumulate(), ComputeResidualThread::accumulateLower(), ComputeResidualAndJacobianThread::accumulateLower(), ComputeJacobianThread::accumulateLower(), ComputeResidualThread::accumulateNeighbor(), ComputeResidualAndJacobianThread::accumulateNeighbor(), ComputeJacobianThread::accumulateNeighbor(), ComputeResidualThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::accumulateNeighborLower(), ComputeJacobianThread::accumulateNeighborLower(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), NonlinearThread::computeOnInterface(), ComputeResidualThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeResidualThread::determineObjectWarehouses(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeMaterialsObjectThread::onBoundary(), NonlinearThread::onBoundary(), onBoundary(), ComputeMarkerThread::onElement(), ComputeElemDampingThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeIndicatorThread::onElement(), NonlinearThread::onElement(), onElement(), ComputeMaterialsObjectThread::onInterface(), NonlinearThread::onInterface(), onInterface(), ComputeMaterialsObjectThread::onInternalSide(), ComputeIndicatorThread::onInternalSide(), NonlinearThread::onInternalSide(), onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeMaterialsObjectThread::post(), ComputeMarkerThread::post(), ComputeIndicatorThread::post(), post(), ComputeJacobianThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeJacobianBlocksThread::postInternalSide(), NonlinearThread::prepareFace(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), NonlinearThread::printBoundaryExecutionInformation(), ComputeElemDampingThread::printGeneralExecutionInformation(), ComputeMarkerThread::printGeneralExecutionInformation(), ComputeIndicatorThread::printGeneralExecutionInformation(), printGeneralExecutionInformation(), NonlinearThread::printGeneralExecutionInformation(), queryBoundary(), querySubdomain(), NonlinearThread::shouldComputeInternalSide(), ComputeMarkerThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), NonlinearThread::subdomainChanged(), and subdomainChanged().