ThreadedElementLoop< RangeType > Class Template Reference

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

#include <ThreadedElementLoop.h>

Inheritance diagram for ThreadedElementLoop< RangeType >:

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	neighborSubdomainChanged () override
	Called every time the neighbor subdomain changes (i.e. More...
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)
	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	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 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...

Detailed Description

template<typename RangeType>
class ThreadedElementLoop< RangeType >

Base class for assembly-like calculations.

Definition at line 33 of file ThreadedElementLoop.h.

Constructor & Destructor Documentation

ThreadedElementLoop() [1/2]

template<typename RangeType >

ThreadedElementLoop< RangeType >::ThreadedElementLoop

(

FEProblemBase &

feproblem

)

Definition at line 57 of file ThreadedElementLoop.h.

  : ThreadedElementLoopBase<RangeType>(fe_problem.mesh()), _fe_problem(fe_problem)
{
}

ThreadedElementLoop() [2/2]

template<typename RangeType >

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

Definition at line 63 of file ThreadedElementLoop.h.

  : ThreadedElementLoopBase<RangeType>(x), _fe_problem(x._fe_problem)
{
}

~ThreadedElementLoop()

template<typename RangeType >

ThreadedElementLoop< RangeType >::~ThreadedElementLoop ( )

virtual

Definition at line 70 of file ThreadedElementLoop.h.

{
}

Member Function Documentation

caughtMooseException()

template<typename RangeType >

void ThreadedElementLoop< RangeType >::caughtMooseException ( MooseException &  )

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 76 of file ThreadedElementLoop.h.

{
  Threads::spin_mutex::scoped_lock lock(threaded_element_mutex);

  std::string what(e.what());
  _fe_problem.setException(what);
}

keepGoing()

template<typename RangeType>

virtual bool ThreadedElementLoop< RangeType >::keepGoing ( )

inlineoverridevirtual

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 44 of file ThreadedElementLoop.h.

{ return !_fe_problem.hasException(); }

neighborSubdomainChanged()

template<typename RangeType >

void ThreadedElementLoop< RangeType >::neighborSubdomainChanged ( )

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 100 of file ThreadedElementLoop.h.

{
  _fe_problem.neighborSubdomainSetup(ThreadedElementLoopBase<RangeType>::_neighbor_subdomain,
                                     ThreadedElementLoopBase<RangeType>::_tid);
}

onBoundary()

template<typename RangeType >

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

virtualinherited

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

Reimplemented in ComputeUserObjectsThread, ProjectMaterialProperties, ComputeMaterialsObjectThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 283 of file ThreadedElementLoopBase.h.

{
}

onElement()

template<typename RangeType >

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

virtualinherited

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

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

Definition at line 265 of file ThreadedElementLoopBase.h.

{
}

onInterface()

template<typename RangeType >

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

virtualinherited

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, ComputeResidualThread, and ComputeJacobianThread.

Definition at line 309 of file ThreadedElementLoopBase.h.

{
}

onInternalSide()

template<typename RangeType >

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

virtualinherited

Called when doing internal edge assembling.

Parameters

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

Reimplemented in ComputeUserObjectsThread, ProjectMaterialProperties, ComputeMaterialsObjectThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 303 of file ThreadedElementLoopBase.h.

{
}

operator()()

template<typename RangeType>

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

inherited

Definition at line 173 of file ThreadedElementLoopBase.h.

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

      pre();

      _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();

        onElement(elem);

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

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

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

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

            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);
          }
        } // sides
        postElement(elem);

      } // range

      post();
    }
    catch (libMesh::LogicError & e)
    {
      throw MooseException("We caught a libMesh error");
    }
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

post()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::post ( )

virtualinherited

Called after the element range loop.

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

Definition at line 259 of file ThreadedElementLoopBase.h.

{
}

postElement()

template<typename RangeType >

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

virtualinherited

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

Parameters

elem	- active element

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

Definition at line 277 of file ThreadedElementLoopBase.h.

{
}

postInternalSide()

template<typename RangeType >

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

virtualinherited

Called after evaluations on an element internal side.

Parameters

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

Definition at line 297 of file ThreadedElementLoopBase.h.

{
}

pre()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::pre ( )

virtualinherited

Called before the element range loop.

Reimplemented in ComputeDiracThread.

Definition at line 253 of file ThreadedElementLoopBase.h.

{
}

preElement()

template<typename RangeType >

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

overridevirtual

Called before the element assembly.

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 86 of file ThreadedElementLoop.h.

{
  _fe_problem.setCurrentSubdomainID(el, ThreadedElementLoopBase<RangeType>::_tid);
}

preInternalSide()

template<typename RangeType >

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

overridevirtual

Called before evaluations on an element internal side.

Parameters

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

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 93 of file ThreadedElementLoop.h.

{
  _fe_problem.setNeighborSubdomainID(el, side, ThreadedElementLoopBase<RangeType>::_tid);
}

subdomainChanged()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::subdomainChanged ( )

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, ProjectMaterialProperties, ComputeMaterialsObjectThread, ComputeDiracThread, ComputeResidualThread, ComputeIndicatorThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 317 of file ThreadedElementLoopBase.h.

{
}

Member Data Documentation

_fe_problem

template<typename RangeType>

FEProblemBase& ThreadedElementLoop< RangeType >::_fe_problem

protected

Definition at line 53 of file ThreadedElementLoop.h.

Referenced by ThreadedElementLoop< ConstElemPointerRange >::keepGoing().

_mesh

template<typename RangeType>

MooseMesh& ThreadedElementLoopBase< RangeType >::_mesh

protectedinherited

Definition at line 138 of file ThreadedElementLoopBase.h.

_neighbor_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 148 of file ThreadedElementLoopBase.h.

_old_neighbor_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_old_neighbor_subdomain

protectedinherited

The subdomain for the last neighbor.

Definition at line 151 of file ThreadedElementLoopBase.h.

_old_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_old_subdomain

protectedinherited

The subdomain for the last element.

Definition at line 145 of file ThreadedElementLoopBase.h.

_subdomain

template<typename RangeType>

SubdomainID ThreadedElementLoopBase< RangeType >::_subdomain

protectedinherited

The subdomain for the current element.

Definition at line 142 of file ThreadedElementLoopBase.h.

_tid

template<typename RangeType>

THREAD_ID ThreadedElementLoopBase< RangeType >::_tid

protectedinherited

Definition at line 139 of file ThreadedElementLoopBase.h.

---

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

• include/loops/ThreadedElementLoop.h