Base class for assembly-like calculations. More...
#include <ThreadedElementLoop.h>
Public Member Functions | |
ThreadedElementLoop (FEProblemBase &feproblem) | |
ThreadedElementLoop (ThreadedElementLoop &x, Threads::split split) | |
virtual | ~ThreadedElementLoop () |
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 RangeType &range, bool bypass_threading=false) |
virtual void | pre () |
Called before the element range loop. More... | |
virtual void | post () |
Called after the element range loop. More... | |
virtual void | onElement (const Elem *elem) |
Assembly of the element (not including surface assembly) More... | |
virtual void | postElement (const Elem *elem) |
Called after the element assembly is done (including surface assembling) More... | |
virtual void | onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) |
Called when doing boundary assembling. More... | |
virtual void | postInternalSide (const Elem *elem, unsigned int side) |
Called after evaluations on an element internal side. More... | |
virtual void | onInternalSide (const Elem *elem, unsigned int side) |
Called when doing internal edge assembling. More... | |
virtual void | onExternalSide (const Elem *elem, unsigned int side) |
Called when iterating over external sides (no side neighbor) More... | |
virtual void | onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id) |
Called when doing interface assembling. More... | |
virtual void | subdomainChanged () |
Called every time the current subdomain changes (i.e. More... | |
Protected Member Functions | |
void | prepareElement (const Elem *elem) |
void | clearVarsAndMaterials () |
template<typename T > | |
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... | |
template<typename T > | |
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 | printGeneralExecutionInformation () const |
Print information about the loop ordering. More... | |
virtual void | printBlockExecutionInformation () const |
Print information about the particular ordering of objects on each block. More... | |
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... | |
Base class for assembly-like calculations.
Definition at line 34 of file ThreadedElementLoop.h.
ThreadedElementLoop< RangeType >::ThreadedElementLoop | ( | FEProblemBase & | feproblem | ) |
Definition at line 86 of file ThreadedElementLoop.h.
ThreadedElementLoop< RangeType >::ThreadedElementLoop | ( | ThreadedElementLoop< RangeType > & | x, |
Threads::split | split | ||
) |
Definition at line 92 of file ThreadedElementLoop.h.
|
virtual |
Definition at line 99 of file ThreadedElementLoop.h.
|
overridevirtual |
Called if a MooseException is caught anywhere during the computation.
The single input parameter taken is a MooseException object.
Reimplemented from ThreadedElementLoopBase< RangeType >.
Definition at line 105 of file ThreadedElementLoop.h.
|
protected |
Definition at line 195 of file ThreadedElementLoop.h.
|
inlineoverridevirtual |
Whether or not the loop should continue.
Reimplemented from ThreadedElementLoopBase< RangeType >.
Definition at line 45 of file ThreadedElementLoop.h.
|
overridevirtual |
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< RangeType >.
Definition at line 139 of file ThreadedElementLoop.h.
|
virtualinherited |
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 in ComputeUserObjectsThread, NonlinearThread, ProjectMaterialProperties, ComputeIndicatorThread, ComputeMaterialsObjectThread, and ComputeMarkerThread.
Definition at line 366 of file ThreadedElementLoopBase.h.
|
virtualinherited |
Assembly of the element (not including surface assembly)
elem | - active element |
Reimplemented in ComputeUserObjectsThread, NonlinearThread, ComputeDiracThread, ProjectMaterialProperties, ComputeIndicatorThread, ComputeMaterialsObjectThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeElemDampingThread, FlagElementsThread, ComputeMarkerThread, UpdateErrorVectorsThread, MaxVarNDofsPerElem, and CacheChangedListsThread.
Definition at line 339 of file ThreadedElementLoopBase.h.
|
virtualinherited |
Called when iterating over external sides (no side neighbor)
elem | - Element we are on |
side | - local side number of the element 'elem' |
Reimplemented in ComputeUserObjectsThread.
Definition at line 393 of file ThreadedElementLoopBase.h.
|
virtualinherited |
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 in ComputeUserObjectsThread, NonlinearThread, and ComputeMaterialsObjectThread.
Definition at line 399 of file ThreadedElementLoopBase.h.
|
virtualinherited |
Called when doing internal edge assembling.
elem | - Element we are on |
side | - local side number of the element 'elem' |
Reimplemented in ComputeUserObjectsThread, NonlinearThread, ProjectMaterialProperties, ComputeIndicatorThread, ComputeMaterialsObjectThread, and ComputeMarkerThread.
Definition at line 387 of file ThreadedElementLoopBase.h.
|
virtualinherited |
Reimplemented in NonlinearThread, and ComputeJacobianForScalingThread.
Definition at line 223 of file ThreadedElementLoopBase.h.
Referenced by NonlinearThread::operator()().
|
virtualinherited |
Called after the element range loop.
Reimplemented in ComputeUserObjectsThread, NonlinearThread, ComputeIndicatorThread, ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeMarkerThread, and ComputeMaterialsObjectThread.
Definition at line 333 of file ThreadedElementLoopBase.h.
|
virtualinherited |
Called after the element assembly is done (including surface assembling)
elem | - active element |
Reimplemented in ComputeJacobianBlocksThread, NonlinearThread, ComputeIndicatorThread, ComputeDiracThread, 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.
Reimplemented in ComputeDiracThread.
Definition at line 327 of file ThreadedElementLoopBase.h.
|
overridevirtual |
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< RangeType >.
Definition at line 129 of file ThreadedElementLoop.h.
|
overridevirtual |
Called before the element assembly.
elem | - active element |
Reimplemented from ThreadedElementLoopBase< RangeType >.
Definition at line 115 of file ThreadedElementLoop.h.
|
overridevirtual |
Called before evaluations on an element internal side.
elem | - Element we are on |
side | - local side number of the element 'elem' |
Reimplemented from ThreadedElementLoopBase< RangeType >.
Definition at line 122 of file ThreadedElementLoop.h.
|
protected |
Definition at line 186 of file ThreadedElementLoop.h.
|
inlineprotectedvirtualinherited |
Print information about the particular ordering of objects on each block.
Reimplemented in NonlinearThread, ComputeUserObjectsThread, ComputeIndicatorThread, ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, and ComputeMarkerThread.
Definition at line 181 of file ThreadedElementLoopBase.h.
|
inlineprotectedvirtualinherited |
Print information about the particular ordering of objects on each boundary.
Reimplemented in NonlinearThread.
Definition at line 184 of file ThreadedElementLoopBase.h.
|
protected |
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.
|
protected |
Definition at line 173 of file ThreadedElementLoop.h.
|
inlineprotectedvirtualinherited |
Print information about the loop ordering.
Reimplemented in NonlinearThread, ComputeUserObjectsThread, ComputeIndicatorThread, ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeMarkerThread, and ComputeElemDampingThread.
Definition at line 178 of file ThreadedElementLoopBase.h.
|
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 ProjectMaterialProperties, NonlinearThread, and FlagElementsThread.
Definition at line 419 of file ThreadedElementLoopBase.h.
Referenced by NonlinearThread::shouldComputeInternalSide().
|
virtualinherited |
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 in ComputeUserObjectsThread, NonlinearThread, ComputeDiracThread, ProjectMaterialProperties, ComputeIndicatorThread, ComputeMaterialsObjectThread, ComputeElemAuxVarsThread< AuxKernelType >, and ComputeMarkerThread.
Definition at line 407 of file ThreadedElementLoopBase.h.
|
mutableprotectedinherited |
Keep track of which blocks were visited.
Definition at line 187 of file ThreadedElementLoopBase.h.
|
mutableprotectedinherited |
Keep track of which boundaries were visited.
Definition at line 190 of file ThreadedElementLoopBase.h.
|
protected |
Definition at line 62 of file ThreadedElementLoop.h.
Referenced by ThreadedElementLoop< ConstElemPointerRange >::keepGoing().
|
protectedinherited |
Definition at line 162 of file ThreadedElementLoopBase.h.
|
protectedinherited |
The subdomain for the current neighbor.
Definition at line 172 of file ThreadedElementLoopBase.h.
|
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.
|
protectedinherited |
The subdomain for the current element.
Definition at line 166 of file ThreadedElementLoopBase.h.
|
protectedinherited |
Definition at line 163 of file ThreadedElementLoopBase.h.