ThreadedElementLoopBase< RangeType > Class Template Reference

Base class for assembly-like calculations. More...

#include <ThreadedElementLoopBase.h>

Inheritance diagram for ThreadedElementLoopBase< RangeType >:

Public Member Functions
	ThreadedElementLoopBase (MooseMesh &mesh)
	ThreadedElementLoopBase (ThreadedElementLoopBase &x, Threads::split split)
virtual	~ThreadedElementLoopBase ()
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	preElement (const Elem *elem)
	Called before the element assembly. More...
virtual void	postElement (const Elem *elem)
	Called after the element assembly is done (including surface assembling) More...
virtual void	preBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr)
	Called before the boundary assembly. 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	preInternalSide (const Elem *elem, unsigned int side)
	Called before evaluations on an element internal side. 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...
virtual void	neighborSubdomainChanged ()
	Called every time the neighbor subdomain changes (i.e. More...
virtual void	caughtMooseException (MooseException &)
	Called if a MooseException is caught anywhere during the computation. More...
virtual bool	keepGoing ()
	Whether or not the loop should continue. More...

Protected Member Functions
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
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...

Detailed Description

template<typename RangeType>
class ThreadedElementLoopBase< RangeType >

Base class for assembly-like calculations.

Definition at line 26 of file ThreadedElementLoopBase.h.

Constructor & Destructor Documentation

ThreadedElementLoopBase() [1/2]

template<typename RangeType >

ThreadedElementLoopBase< RangeType >::ThreadedElementLoopBase

(

MooseMesh &

mesh

)

Definition at line 208 of file ThreadedElementLoopBase.h.

                                                                            : _mesh(mesh)
{
}

ThreadedElementLoopBase() [2/2]

template<typename RangeType >

ThreadedElementLoopBase< RangeType >::ThreadedElementLoopBase	(	ThreadedElementLoopBase< RangeType > &	x,
		Threads::split	split
	)

Definition at line 213 of file ThreadedElementLoopBase.h.

  : _mesh(x._mesh)
{
}

~ThreadedElementLoopBase()

template<typename RangeType >

ThreadedElementLoopBase< RangeType >::~ThreadedElementLoopBase ( )

virtual

Definition at line 220 of file ThreadedElementLoopBase.h.

{
}

Member Function Documentation

caughtMooseException()

template<typename RangeType>

virtual void ThreadedElementLoopBase< RangeType >::caughtMooseException ( MooseException &  )

inlinevirtual

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< libMesh::ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 155 of file ThreadedElementLoopBase.h.

{};

keepGoing()

template<typename RangeType>

virtual bool ThreadedElementLoopBase< RangeType >::keepGoing ( )

inlinevirtual

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< libMesh::ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 162 of file ThreadedElementLoopBase.h.

{ return true; }

neighborSubdomainChanged()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::neighborSubdomainChanged ( )

virtual

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 in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< libMesh::ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 423 of file ThreadedElementLoopBase.h.

{
}

onBoundary()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::onBoundary ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id, const Elem *  lower_d_elem = nullptr  )

virtual

Called when doing boundary assembling.

Parameters

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 376 of file ThreadedElementLoopBase.h.

{
}

onElement()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::onElement ( const Elem *  elem )

virtual

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented in ComputeUserObjectsThread, NonlinearThread, ComputeDiracThread, ProjectMaterialProperties, ComputeIndicatorThread, ComputeMaterialsObjectThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeElemDampingThread, FlagElementsThread, ComputeMarkerThread, UpdateErrorVectorsThread, MaxVarNDofsPerElem, and CacheChangedListsThread.

Definition at line 349 of file ThreadedElementLoopBase.h.

{
}

onExternalSide()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::onExternalSide ( const Elem *  elem, unsigned int  side  )

virtual

Called when iterating over external sides (no side neighbor)

Parameters

elem	- Element we are on
side	- local side number of the element 'elem'

Reimplemented in ComputeUserObjectsThread.

Definition at line 403 of file ThreadedElementLoopBase.h.

{
}

onInterface()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::onInterface ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id  )

virtual

Called when doing interface assembling.

Parameters

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 409 of file ThreadedElementLoopBase.h.

{
}

onInternalSide()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::onInternalSide ( const Elem *  elem, unsigned int  side  )

virtual

Called when doing internal edge assembling.

Parameters

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 397 of file ThreadedElementLoopBase.h.

{
}

operator()()

template<typename RangeType>

void ThreadedElementLoopBase< RangeType >::operator() ( const RangeType &  range, bool  bypass_threading = false  )

virtual

Reimplemented in NonlinearThread, and ComputeJacobianForScalingThread.

Definition at line 226 of file ThreadedElementLoopBase.h.

Referenced by NonlinearThread::operator()().

{
  try
  {
    try
    {
      ParallelUniqueId puid;
      _tid = bypass_threading ? 0 : puid.id;

      pre();
      printGeneralExecutionInformation();

      _subdomain = Moose::INVALID_BLOCK_ID;
      _neighbor_subdomain = Moose::INVALID_BLOCK_ID;
      typename RangeType::const_iterator el = range.begin();
      for (el = range.begin(); el != range.end(); ++el)
      {
        if (!keepGoing())
          break;

        const Elem * elem = *el;

        preElement(elem);

        _old_subdomain = _subdomain;
        _subdomain = elem->subdomain_id();
        if (_subdomain != _old_subdomain)
        {
          subdomainChanged();
          printBlockExecutionInformation();
        }

        onElement(elem);

        if (_mesh.interiorLowerDBlocks().count(elem->subdomain_id()) > 0 ||
            _mesh.boundaryLowerDBlocks().count(elem->subdomain_id()) > 0)
        {
          postElement(elem);
          continue;
        }

        for (unsigned int side = 0; side < elem->n_sides(); side++)
        {
          std::vector<BoundaryID> boundary_ids = _mesh.getBoundaryIDs(elem, side);
          const Elem * lower_d_elem = _mesh.getLowerDElem(elem, side);

          if (boundary_ids.size() > 0)
            for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
                 it != boundary_ids.end();
                 ++it)
            {
              preBoundary(elem, side, *it, lower_d_elem);
              printBoundaryExecutionInformation(*it);
              onBoundary(elem, side, *it, lower_d_elem);
            }

          const Elem * neighbor = elem->neighbor_ptr(side);
          if (neighbor)
          {
            preInternalSide(elem, side);

            _old_neighbor_subdomain = _neighbor_subdomain;
            _neighbor_subdomain = neighbor->subdomain_id();
            if (_neighbor_subdomain != _old_neighbor_subdomain)
              neighborSubdomainChanged();

            if (shouldComputeInternalSide(*elem, *neighbor))
              onInternalSide(elem, side);

            if (boundary_ids.size() > 0)
              for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
                   it != boundary_ids.end();
                   ++it)
                onInterface(elem, side, *it);

            postInternalSide(elem, side);
          }
          else
            onExternalSide(elem, side);
        } // sides

        postElement(elem);
      } // range

      post();
      resetExecPrintedSets();
    }
    catch (MetaPhysicL::LogicError & e)
    {
      moose::translateMetaPhysicLError(e);
    }
    catch (std::exception & e)
    {
      // Continue if we find a libMesh degenerate map exception, but
      // just re-throw for any real error
      if (!strstr(e.what(), "Jacobian") && !strstr(e.what(), "singular") &&
          !strstr(e.what(), "det != 0"))
        throw; // not "throw e;" - that destroys type info!

      mooseException("We caught a libMesh degeneracy exception in ThreadedElementLoopBase:\n",
                     e.what());
    }
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

post()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::post ( )

virtual

Called after the element range loop.

Reimplemented in ComputeUserObjectsThread, NonlinearThread, ComputeIndicatorThread, ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeMarkerThread, and ComputeMaterialsObjectThread.

Definition at line 343 of file ThreadedElementLoopBase.h.

{
}

postElement()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::postElement ( const Elem *  elem )

virtual

Called after the element assembly is done (including surface assembling)

Parameters

elem	- active element

Reimplemented in ComputeJacobianBlocksThread, NonlinearThread, ComputeIndicatorThread, ComputeDiracThread, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 361 of file ThreadedElementLoopBase.h.

{
}

postInternalSide()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::postInternalSide ( const Elem *  elem, unsigned int  side  )

virtual

Called after evaluations on an element internal side.

Parameters

elem	- Element we are on
side	- local side number of the element 'elem'

Reimplemented in ComputeJacobianBlocksThread.

Definition at line 391 of file ThreadedElementLoopBase.h.

{
}

pre()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::pre ( )

virtual

Called before the element range loop.

Reimplemented in ComputeDiracThread.

Definition at line 337 of file ThreadedElementLoopBase.h.

{
}

preBoundary()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::preBoundary ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id, const Elem *  lower_d_elem = nullptr  )

virtual

Called before the boundary assembly.

Parameters

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 ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< libMesh::ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 367 of file ThreadedElementLoopBase.h.

{
}

preElement()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::preElement ( const Elem *  elem )

virtual

Called before the element assembly.

Parameters

elem	- active element

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< libMesh::ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 355 of file ThreadedElementLoopBase.h.

{
}

preInternalSide()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::preInternalSide ( const Elem *  elem, unsigned int  side  )

virtual

Called before evaluations on an element internal side.

Parameters

elem	- Element we are on
side	- local side number of the element 'elem'

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< libMesh::ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 385 of file ThreadedElementLoopBase.h.

{
}

printBlockExecutionInformation()

template<typename RangeType>

virtual void ThreadedElementLoopBase< RangeType >::printBlockExecutionInformation ( ) const

inlineprotectedvirtual

Print information about the particular ordering of objects on each block.

Reimplemented in NonlinearThread, ComputeUserObjectsThread, ComputeIndicatorThread, ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, and ComputeMarkerThread.

Definition at line 184 of file ThreadedElementLoopBase.h.

{}

printBoundaryExecutionInformation()

template<typename RangeType>

virtual void ThreadedElementLoopBase< RangeType >::printBoundaryExecutionInformation ( const unsigned  int ) const

inlineprotectedvirtual

Print information about the particular ordering of objects on each boundary.

Reimplemented in NonlinearThread.

Definition at line 187 of file ThreadedElementLoopBase.h.

{}

printGeneralExecutionInformation()

template<typename RangeType>

virtual void ThreadedElementLoopBase< RangeType >::printGeneralExecutionInformation ( ) const

inlineprotectedvirtual

Print information about the loop ordering.

Reimplemented in NonlinearThread, ComputeUserObjectsThread, ComputeIndicatorThread, ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeMarkerThread, and ComputeElemDampingThread.

Definition at line 181 of file ThreadedElementLoopBase.h.

{}

resetExecPrintedSets()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::resetExecPrintedSets ( ) const

protected

Resets the set of blocks and boundaries visited.

Definition at line 454 of file ThreadedElementLoopBase.h.

{
  _blocks_exec_printed.clear();
  _boundaries_exec_printed.clear();
}

shouldComputeInternalSide()

template<typename RangeType >

bool ThreadedElementLoopBase< RangeType >::shouldComputeInternalSide ( const Elem &  elem, const Elem &  neighbor  ) const

protectedvirtual

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 429 of file ThreadedElementLoopBase.h.

Referenced by NonlinearThread::shouldComputeInternalSide().

{
  auto level = [this](const auto & elem_arg)
  {
    if (_mesh.doingPRefinement())
      return elem_arg.p_level();
    else
      return elem_arg.level();
  };
  const auto elem_id = elem.id(), neighbor_id = neighbor.id();
  const auto elem_level = level(elem), neighbor_level = level(neighbor);

  // When looping over elements and then sides, we need to make sure that we do not duplicate
  // effort, e.g. if a face is shared by element 1 and element 2, then we do not want to do compute
  // work both when we are visiting element 1 *and* then later when visiting element 2. Our rule is
  // to only compute when we are visiting the element that has the lower element id when element and
  // neighbor are of the same adaptivity level, and then if they are not of the same level, then
  // we only compute when we are visiting the finer element
  return (neighbor.active() && (neighbor_level == elem_level) && (elem_id < neighbor_id)) ||
         (neighbor_level < elem_level);
}

subdomainChanged()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::subdomainChanged ( )

virtual

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 417 of file ThreadedElementLoopBase.h.

{
}

Member Data Documentation

_blocks_exec_printed

template<typename RangeType>

std::set<SubdomainID> ThreadedElementLoopBase< RangeType >::_blocks_exec_printed

mutableprotected

Keep track of which blocks were visited.

Definition at line 190 of file ThreadedElementLoopBase.h.

_boundaries_exec_printed

template<typename RangeType>

std::set<BoundaryID> ThreadedElementLoopBase< RangeType >::_boundaries_exec_printed

mutableprotected

Keep track of which boundaries were visited.

Definition at line 193 of file ThreadedElementLoopBase.h.

_mesh

template<typename RangeType>

MooseMesh& ThreadedElementLoopBase< RangeType >::_mesh

protected

Definition at line 165 of file ThreadedElementLoopBase.h.

_neighbor_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_neighbor_subdomain

protected

The subdomain for the current neighbor.

Definition at line 175 of file ThreadedElementLoopBase.h.

_old_neighbor_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_old_neighbor_subdomain

protected

The subdomain for the last neighbor.

Definition at line 178 of file ThreadedElementLoopBase.h.

_old_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_old_subdomain

protected

The subdomain for the last element.

Definition at line 172 of file ThreadedElementLoopBase.h.

_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_subdomain

protected

The subdomain for the current element.

Definition at line 169 of file ThreadedElementLoopBase.h.

_tid

template<typename RangeType>

THREAD_ID ThreadedElementLoopBase< RangeType >::_tid

protected

Definition at line 166 of file ThreadedElementLoopBase.h.

---

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

• include/loops/ThreadedElementLoopBase.h