ComputeIndicatorThread Class Reference

#include <ComputeIndicatorThread.h>

Inheritance diagram for ComputeIndicatorThread:

Public Member Functions
	ComputeIndicatorThread (FEProblemBase &fe_problem, bool finalize=false)
	ComputeIndicatorThread (ComputeIndicatorThread &x, Threads::split split)
virtual	~ComputeIndicatorThread ()
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 ComputeIndicatorThread &)
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) 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	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< Indicator > &	_indicator_whs
	Indicator Storage. More...
const MooseObjectWarehouse< InternalSideIndicator > &	_internal_side_indicators
	InternalSideIndicator Storage. More...
bool	_finalize
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 20 of file ComputeIndicatorThread.h.

Constructor & Destructor Documentation

ComputeIndicatorThread() [1/2]

ComputeIndicatorThread::ComputeIndicatorThread	(	FEProblemBase &	fe_problem,
		bool	finalize = false
	)

Parameters

fe_problem	reference to the FEProblemBase we are computing on
sys	reference to the AuxSystem we are computing on
indicator_whs	Warehouse of Indicator objects.
finalize	Whether or not we are just in the "finalize" stage or not.

Definition at line 23 of file ComputeIndicatorThread.C.

  : ThreadedElementLoop<ConstElemRange>(fe_problem),
    _fe_problem(fe_problem),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _indicator_whs(_fe_problem.getIndicatorWarehouse()),
    _internal_side_indicators(_fe_problem.getInternalSideIndicatorWarehouse()),
    _finalize(finalize)
{
}

ComputeIndicatorThread() [2/2]

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

Definition at line 34 of file ComputeIndicatorThread.C.

  : ThreadedElementLoop<ConstElemRange>(x, split),
    _fe_problem(x._fe_problem),
    _aux_sys(x._aux_sys),
    _indicator_whs(x._indicator_whs),
    _internal_side_indicators(x._internal_side_indicators),
    _finalize(x._finalize)
{
}

~ComputeIndicatorThread()

ComputeIndicatorThread::~ComputeIndicatorThread ( )

virtual

Definition at line 44 of file ComputeIndicatorThread.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 77 of file ThreadedElementLoop.h.

{
  Threads::spin_mutex::scoped_lock lock(threaded_element_mutex);
 
  std::string what(e.what());
  _fe_problem.setException(what);
}

join()

void ComputeIndicatorThread::join

(

const ComputeIndicatorThread &

)

Definition at line 182 of file ComputeIndicatorThread.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 43 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 110 of file ThreadedElementLoop.h.

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

onBoundary()

void ComputeIndicatorThread::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 123 of file ComputeIndicatorThread.C.

{
}

onElement()

void ComputeIndicatorThread::onElement ( const Elem *  elem )

overridevirtual

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 68 of file ComputeIndicatorThread.C.

{
  for (auto * var : _aux_sys._elem_vars[_tid])
    var->prepareAux();
 
  _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, &FEProblemBase::swapBackMaterials, _tid);
 
  _fe_problem.reinitMaterials(_subdomain, _tid);
 
  // Compute
  if (!_finalize)
  {
    if (_indicator_whs.hasActiveBlockObjects(_subdomain, _tid))
    {
      const std::vector<std::shared_ptr<Indicator>> & indicators =
          _indicator_whs.getActiveBlockObjects(_subdomain, _tid);
      for (const auto & indicator : indicators)
        indicator->computeIndicator();
    }
  }
 
  // Finalize
  else
  {
    if (_indicator_whs.hasActiveBlockObjects(_subdomain, _tid))
    {
      const std::vector<std::shared_ptr<Indicator>> & indicators =
          _indicator_whs.getActiveBlockObjects(_subdomain, _tid);
      for (const auto & indicator : indicators)
        indicator->finalize();
    }
 
    if (_internal_side_indicators.hasActiveBlockObjects(_subdomain, _tid))
    {
      const std::vector<std::shared_ptr<InternalSideIndicator>> & internal_indicators =
          _internal_side_indicators.getActiveBlockObjects(_subdomain, _tid);
      for (const auto & internal_indicator : internal_indicators)
        internal_indicator->finalize();
    }
  }
 
  if (!_finalize) // During finalize the Indicators should be setting values in the vectors manually
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    for (auto * var : _aux_sys._elem_vars[_tid])
      var->add(_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, ComputeMaterialsObjectThread, ComputeResidualThread, and ComputeJacobianThread.

Definition at line 328 of file ThreadedElementLoopBase.h.

{
}

onInternalSide()

void ComputeIndicatorThread::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 130 of file ComputeIndicatorThread.C.

{
  if (_finalize) // If finalizing we only do something on the elements
    return;
 
  // Pointer to the neighbor we are currently working on.
  const Elem * neighbor = elem->neighbor_ptr(side);
 
  // Get the global id of the element and the neighbor
  const dof_id_type elem_id = elem->id(), neighbor_id = neighbor->id();
 
  if ((neighbor->active() && (neighbor->level() == elem->level()) && (elem_id < neighbor_id)) ||
      (neighbor->level() < elem->level()))
  {
    for (auto * var : _aux_sys._elem_vars[_tid])
      var->prepareAux();
 
    SubdomainID block_id = elem->subdomain_id();
    if (_internal_side_indicators.hasActiveBlockObjects(block_id, _tid))
    {
      _fe_problem.reinitNeighbor(elem, side, _tid);
 
      // Set up Sentinels so that, even if one of the reinitMaterialsXXX() calls throws, we
      // still remember to swap back during stack unwinding.
      SwapBackSentinel face_sentinel(_fe_problem, &FEProblemBase::swapBackMaterialsFace, _tid);
      _fe_problem.reinitMaterialsFace(block_id, _tid);
 
      SwapBackSentinel neighbor_sentinel(
          _fe_problem, &FEProblemBase::swapBackMaterialsNeighbor, _tid);
      _fe_problem.reinitMaterialsNeighbor(neighbor->subdomain_id(), _tid);
 
      const std::vector<std::shared_ptr<InternalSideIndicator>> & indicators =
          _internal_side_indicators.getActiveBlockObjects(block_id, _tid);
      for (const auto & indicator : indicators)
        indicator->computeIndicator();
    }
  }
}

operator()()

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

virtualinherited

Definition at line 181 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)
            {
              preBoundary(elem, side, *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 in ThreadedElementLoopBase");
    }
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

post()

void ComputeIndicatorThread::post ( )

overridevirtual

Called after the element range loop.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 175 of file ComputeIndicatorThread.C.

{
  _fe_problem.clearActiveElementalMooseVariables(_tid);
  _fe_problem.clearActiveMaterialProperties(_tid);
}

postElement()

void ComputeIndicatorThread::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 170 of file ComputeIndicatorThread.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'

Reimplemented in ComputeJacobianBlocksThread.

Definition at line 316 of file ThreadedElementLoopBase.h.

{
}

pre()

void ThreadedElementLoopBase< ConstElemRange >::pre ( )

virtualinherited

Called before the element range loop.

Definition at line 264 of file ThreadedElementLoopBase.h.

{
}

preBoundary()

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

overridevirtualinherited

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

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 101 of file ThreadedElementLoop.h.

{
  _fe_problem.setCurrentBoundaryID(bnd_id, ThreadedElementLoopBase<RangeType>::_tid);
}

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

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

subdomainChanged()

void ComputeIndicatorThread::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 47 of file ComputeIndicatorThread.C.

{
  _fe_problem.subdomainSetup(_subdomain, _tid);
 
  _indicator_whs.subdomainSetup(_tid);
  _internal_side_indicators.subdomainSetup(_tid);
 
  std::set<MooseVariableFEBase *> needed_moose_vars;
  _indicator_whs.updateVariableDependency(needed_moose_vars, _tid);
  _internal_side_indicators.updateVariableDependency(needed_moose_vars, _tid);
  _fe_problem.setActiveElementalMooseVariables(needed_moose_vars, _tid);
 
  std::set<unsigned int> needed_mat_props;
  _indicator_whs.updateMatPropDependency(needed_mat_props, _tid);
  _internal_side_indicators.updateMatPropDependency(needed_mat_props, _tid);
  _fe_problem.setActiveMaterialProperties(needed_mat_props, _tid);
 
  _fe_problem.prepareMaterials(_subdomain, _tid);
}

Member Data Documentation

_aux_sys

AuxiliarySystem& ComputeIndicatorThread::_aux_sys

protected

Definition at line 47 of file ComputeIndicatorThread.h.

Referenced by onElement(), and onInternalSide().

_fe_problem

FEProblemBase& ComputeIndicatorThread::_fe_problem

protected

Definition at line 46 of file ComputeIndicatorThread.h.

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

_finalize

bool ComputeIndicatorThread::_finalize

protected

Definition at line 55 of file ComputeIndicatorThread.h.

Referenced by onElement(), and onInternalSide().

_indicator_whs

const MooseObjectWarehouse<Indicator>& ComputeIndicatorThread::_indicator_whs

protected

Indicator Storage.

Definition at line 50 of file ComputeIndicatorThread.h.

Referenced by onElement(), and subdomainChanged().

_internal_side_indicators

const MooseObjectWarehouse<InternalSideIndicator>& ComputeIndicatorThread::_internal_side_indicators

protected

InternalSideIndicator Storage.

Definition at line 53 of file ComputeIndicatorThread.h.

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

_mesh

MooseMesh& ThreadedElementLoopBase< ConstElemRange >::_mesh

protectedinherited

Definition at line 146 of file ThreadedElementLoopBase.h.

_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 156 of file ThreadedElementLoopBase.h.

_old_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_neighbor_subdomain

protectedinherited

The subdomain for the last neighbor.

Definition at line 159 of file ThreadedElementLoopBase.h.

_old_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_subdomain

protectedinherited

The subdomain for the last element.

Definition at line 153 of file ThreadedElementLoopBase.h.

_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_subdomain

protectedinherited

The subdomain for the current element.

Definition at line 150 of file ThreadedElementLoopBase.h.

_tid

THREAD_ID ThreadedElementLoopBase< ConstElemRange >::_tid

protectedinherited

Definition at line 147 of file ThreadedElementLoopBase.h.

---

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

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