ComputeMarkerThread Class Reference

#include <ComputeMarkerThread.h>

Inheritance diagram for ComputeMarkerThread:

Public Member Functions
	ComputeMarkerThread (FEProblemBase &fe_problem)
	ComputeMarkerThread (ComputeMarkerThread &x, Threads::split split)
virtual	~ComputeMarkerThread ()
virtual void	subdomainChanged () override
	Called every time the current subdomain changes (i.e. More...
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) 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	postElement (const Elem *) override
	Called after the element assembly is done (including surface assembling) More...
virtual void	post () override
	Called after the element range loop. More...
void	join (const ComputeMarkerThread &)
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 ConstElemRange &range, bool bypass_threading=false)
virtual void	pre ()
	Called before the element range loop. More...
virtual void	postInternalSide (const Elem *elem, unsigned int side)
	Called after evaluations on an element internal side. More...
virtual void	onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id)
	Called when doing interface assembling. More...

Protected Attributes
FEProblemBase &	_fe_problem
AuxiliarySystem &	_aux_sys
const MooseObjectWarehouse< Marker > &	_marker_whs
	Reference to the Marker warhouse in FEProblemBase. More...
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

Definition at line 19 of file ComputeMarkerThread.h.

Constructor & Destructor Documentation

ComputeMarkerThread() [1/2]

ComputeMarkerThread::ComputeMarkerThread

(

FEProblemBase &

fe_problem

)

Definition at line 21 of file ComputeMarkerThread.C.

  : ThreadedElementLoop<ConstElemRange>(fe_problem),
    _fe_problem(fe_problem),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _marker_whs(_fe_problem.getMarkerWarehouse())
{
}

ComputeMarkerThread() [2/2]

ComputeMarkerThread::ComputeMarkerThread	(	ComputeMarkerThread &	x,
		Threads::split	split
	)

Definition at line 30 of file ComputeMarkerThread.C.

  : ThreadedElementLoop<ConstElemRange>(x, split),
    _fe_problem(x._fe_problem),
    _aux_sys(x._aux_sys),
    _marker_whs(x._marker_whs)
{
}

~ComputeMarkerThread()

ComputeMarkerThread::~ComputeMarkerThread ( )

virtual

Definition at line 38 of file ComputeMarkerThread.C.

{}

Member Function Documentation

caughtMooseException()

void ThreadedElementLoop< ConstElemRange >::caughtMooseException ( MooseException &  e )

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

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

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

join()

void ComputeMarkerThread::join

(

const ComputeMarkerThread &

)

Definition at line 105 of file ComputeMarkerThread.C.

{
}

keepGoing()

virtual bool ThreadedElementLoop< ConstElemRange >::keepGoing ( )

inlineoverridevirtualinherited

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 44 of file ThreadedElementLoop.h.

{ return !_fe_problem.hasException(); }

neighborSubdomainChanged()

void ThreadedElementLoop< ConstElemRange >::neighborSubdomainChanged ( )

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

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

onBoundary()

void ComputeMarkerThread::onBoundary ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id  )

overridevirtual

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 from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 84 of file ComputeMarkerThread.C.

{
}

onElement()

void ComputeMarkerThread::onElement ( const Elem *  elem )

overridevirtual

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 57 of file ComputeMarkerThread.C.

{
  _fe_problem.prepare(elem, _tid);
  _fe_problem.reinitElem(elem, _tid);

  // Set up Sentinel class so that, even if reinitMaterials() throws, we
  // still remember to swap back during stack unwinding.
  SwapBackSentinel sentinel(_fe_problem, &FEProblem::swapBackMaterials, _tid);

  _fe_problem.reinitMaterials(_subdomain, _tid);

  if (_marker_whs.hasActiveBlockObjects(_subdomain, _tid))
  {
    const std::vector<std::shared_ptr<Marker>> & markers =
        _marker_whs.getActiveBlockObjects(_subdomain, _tid);
    for (const auto & marker : markers)
      marker->computeMarker();
  }

  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    for (auto * var : _aux_sys._elem_vars[_tid])
      var->insert(_aux_sys.solution());
  }
}

onInterface()

void ThreadedElementLoopBase< ConstElemRange >::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()

void ComputeMarkerThread::onInternalSide ( const Elem *  elem, unsigned int  side  )

overridevirtual

Called when doing internal edge assembling.

Parameters

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

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 89 of file ComputeMarkerThread.C.

{
}

operator()()

void ThreadedElementLoopBase< ConstElemRange >::operator() ( const ConstElemRange &  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()

void ComputeMarkerThread::post ( )

overridevirtual

Called after the element range loop.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 99 of file ComputeMarkerThread.C.

{
  _fe_problem.clearActiveElementalMooseVariables(_tid);
}

postElement()

void ComputeMarkerThread::postElement ( const Elem *  elem )

overridevirtual

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

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 94 of file ComputeMarkerThread.C.

{
}

postInternalSide()

void ThreadedElementLoopBase< ConstElemRange >::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()

void ThreadedElementLoopBase< ConstElemRange >::pre ( )

virtualinherited

Called before the element range loop.

Definition at line 253 of file ThreadedElementLoopBase.h.

{
}

preElement()

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

overridevirtualinherited

Called before the element assembly.

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 86 of file ThreadedElementLoop.h.

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

preInternalSide()

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

overridevirtualinherited

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< ConstElemRange >.

Definition at line 93 of file ThreadedElementLoop.h.

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

subdomainChanged()

void ComputeMarkerThread::subdomainChanged ( )

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 41 of file ComputeMarkerThread.C.

{
  _fe_problem.subdomainSetup(_subdomain, _tid);
  _marker_whs.subdomainSetup(_tid);

  std::set<MooseVariableFEBase *> needed_moose_vars;
  _marker_whs.updateVariableDependency(needed_moose_vars, _tid);

  for (auto * var : _aux_sys._elem_vars[_tid])
    var->prepareAux();

  _fe_problem.setActiveElementalMooseVariables(needed_moose_vars, _tid);
  _fe_problem.prepareMaterials(_subdomain, _tid);
}

Member Data Documentation

_aux_sys

AuxiliarySystem& ComputeMarkerThread::_aux_sys

protected

Definition at line 40 of file ComputeMarkerThread.h.

Referenced by onElement(), and subdomainChanged().

_fe_problem

FEProblemBase& ComputeMarkerThread::_fe_problem

protected

Definition at line 39 of file ComputeMarkerThread.h.

Referenced by onElement(), post(), and subdomainChanged().

_marker_whs

const MooseObjectWarehouse<Marker>& ComputeMarkerThread::_marker_whs

protected

Reference to the Marker warhouse in FEProblemBase.

Definition at line 43 of file ComputeMarkerThread.h.

Referenced by onElement(), and subdomainChanged().

_mesh

MooseMesh& ThreadedElementLoopBase< ConstElemRange >::_mesh

protectedinherited

Definition at line 138 of file ThreadedElementLoopBase.h.

_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 148 of file ThreadedElementLoopBase.h.

_old_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_neighbor_subdomain

protectedinherited

The subdomain for the last neighbor.

Definition at line 151 of file ThreadedElementLoopBase.h.

_old_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_subdomain

protectedinherited

The subdomain for the last element.

Definition at line 145 of file ThreadedElementLoopBase.h.

_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_subdomain

protectedinherited

The subdomain for the current element.

Definition at line 142 of file ThreadedElementLoopBase.h.

Referenced by ComputeFullJacobianThread::computeFaceJacobian(), ComputeFullJacobianThread::computeInternalFaceJacobian(), ComputeJacobianThread::computeInternalFaceJacobian(), ComputeFullJacobianThread::computeJacobian(), ComputeJacobianThread::computeJacobian(), ComputeMaterialsObjectThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), onElement(), ComputeJacobianThread::onElement(), ComputeIndicatorThread::onElement(), ComputeResidualThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeJacobianThread::onInternalSide(), ComputeResidualThread::onInternalSide(), ComputeMaterialsObjectThread::onInternalSide(), ComputeUserObjectsThread::querySubdomain(), subdomainChanged(), ComputeJacobianThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeResidualThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

_tid

THREAD_ID ThreadedElementLoopBase< ConstElemRange >::_tid

protectedinherited

Definition at line 139 of file ThreadedElementLoopBase.h.

Referenced by ComputeFullJacobianThread::computeFaceJacobian(), ComputeJacobianThread::computeFaceJacobian(), ComputeFullJacobianThread::computeInternalFaceJacobian(), ComputeJacobianThread::computeInternalFaceJacobian(), ComputeFullJacobianThread::computeInternalInterFaceJacobian(), ComputeJacobianThread::computeInternalInterFaceJacobian(), ComputeFullJacobianThread::computeJacobian(), ComputeJacobianThread::computeJacobian(), ComputeJacobianThread::onBoundary(), ComputeResidualThread::onBoundary(), ComputeMaterialsObjectThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), onElement(), ComputeElemDampingThread::onElement(), ComputeJacobianThread::onElement(), ComputeIndicatorThread::onElement(), ComputeResidualThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeJacobianThread::onInterface(), ComputeResidualThread::onInterface(), ComputeUserObjectsThread::onInterface(), ComputeJacobianThread::onInternalSide(), ComputeIndicatorThread::onInternalSide(), ComputeResidualThread::onInternalSide(), ComputeMaterialsObjectThread::onInternalSide(), ComputeUserObjectsThread::onInternalSide(), post(), ComputeMaterialsObjectThread::post(), ComputeJacobianThread::post(), ComputeIndicatorThread::post(), ComputeResidualThread::post(), ComputeUserObjectsThread::post(), ComputeJacobianThread::postElement(), ComputeResidualThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeUserObjectsThread::queryBoundary(), ComputeUserObjectsThread::querySubdomain(), subdomainChanged(), ComputeJacobianThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeResidualThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

---

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

• include/loops/ComputeMarkerThread.h
• src/loops/ComputeMarkerThread.C