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, const Elem *lower_d_elem=nullptr) 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, 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 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	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...

Protected Member Functions
void	printGeneralExecutionInformation () const override
	Print general information about the loop when it executes. More...
void	printBlockExecutionInformation () const override
	Print list of specific objects executed and in which order. More...
void	prepareElement (const Elem *elem)
void	clearVarsAndMaterials ()
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...
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	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
AuxiliarySystem &	_aux_sys
const MooseObjectWarehouse< Indicator > &	_indicator_whs
	Indicator Storage. More...
const MooseObjectWarehouse< InternalSideIndicatorBase > &	_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...
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

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 26 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 37 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 47 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 105 of file ThreadedElementLoop.h.

Referenced by ComputeJacobianForScalingThread::operator()().

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

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

clearVarsAndMaterials()

void ThreadedElementLoop< ConstElemRange >::clearVarsAndMaterials ( )

protectedinherited

Definition at line 195 of file ThreadedElementLoop.h.

Referenced by NonlinearThread::post().

{
  _fe_problem.clearActiveElementalMooseVariables(this->_tid);
  _fe_problem.clearActiveMaterialProperties(this->_tid);
}

join()

void ComputeIndicatorThread::join

(

const ComputeIndicatorThread &

)

Definition at line 185 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 45 of file ThreadedElementLoop.h.

Referenced by ComputeJacobianForScalingThread::operator()().

{ 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 139 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, const Elem *  lower_d_elem = nullptr  )

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
lower_d_elem	- Lower dimensional element (e.g. Mortar)

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 132 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 80 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<InternalSideIndicatorBase>> & 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
    for (auto * var : _aux_sys._elem_vars[_tid])
      var->add(_aux_sys.solution());
}

onExternalSide()

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

virtualinherited

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

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, NonlinearThread, and ComputeMaterialsObjectThread.

Definition at line 409 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 140 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);

  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<InternalSideIndicatorBase>> & 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

Reimplemented in NonlinearThread, and ComputeJacobianForScalingThread.

Definition at line 226 of file ThreadedElementLoopBase.h.

{
  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()

void ComputeIndicatorThread::post ( )

overridevirtual

Called after the element range loop.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 178 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 173 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 391 of file ThreadedElementLoopBase.h.

{
}

pre()

void ThreadedElementLoopBase< ConstElemRange >::pre ( )

virtualinherited

Called before the element range loop.

Definition at line 337 of file ThreadedElementLoopBase.h.

Referenced by ComputeJacobianForScalingThread::operator()().

{
}

preBoundary()

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

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
lower_d_elem	- Lower dimensional element (e.g. Mortar)

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 129 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 115 of file ThreadedElementLoop.h.

Referenced by ComputeJacobianForScalingThread::operator()().

{
  _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 122 of file ThreadedElementLoop.h.

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

prepareElement()

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

protectedinherited

Definition at line 186 of file ThreadedElementLoop.h.

Referenced by NonlinearThread::onElement().

{
  _fe_problem.prepare(elem, this->_tid);
  _fe_problem.reinitElem(elem, this->_tid);
  _fe_problem.reinitMaterials(this->_subdomain, this->_tid);
}

printBlockExecutionInformation()

void ComputeIndicatorThread::printBlockExecutionInformation ( ) const

overrideprotectedvirtual

Print list of specific objects executed and in which order.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 205 of file ComputeIndicatorThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid) || _blocks_exec_printed.count(_subdomain))
    return;

  const auto & console = _fe_problem.console();
  if (_indicator_whs.hasActiveBlockObjects(_subdomain, _tid))
  {
    const auto & indicators = _indicator_whs.getActiveBlockObjects(_subdomain, _tid);
    console << "[DBG] Ordering of element indicators on block " << _subdomain << std::endl;
    printExecutionOrdering<Indicator>(indicators, false);
  }
  if (_internal_side_indicators.hasActiveBlockObjects(_subdomain, _tid))
  {
    const auto & indicators = _internal_side_indicators.getActiveBlockObjects(_subdomain, _tid);
    console << "[DBG] Ordering of element internal sides indicators on block " << _subdomain
            << std::endl;
    printExecutionOrdering<InternalSideIndicatorBase>(indicators, false);
  }
  _blocks_exec_printed.insert(_subdomain);
}

printBoundaryExecutionInformation()

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

inlineprotectedvirtualinherited

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

Reimplemented in NonlinearThread.

Definition at line 187 of file ThreadedElementLoopBase.h.

{}

printExecutionOrdering() [1/2]

void ThreadedElementLoop< ConstElemRange >::printExecutionOrdering ( const std::vector< T *> &  objs, const bool  print_header = true, const std::string &  line_prefix = "[DBG]"  ) const

protectedinherited

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.

Template Parameters

T	the object type

Parameters

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.

{
  if (!objs.size())
    return;

  auto & console = _fe_problem.console();
  const auto objects_type = MooseUtils::prettyCppType(objs[0]);
  std::vector<MooseObject *> moose_objs;
  for (auto obj_ptr : objs)
    moose_objs.push_back(dynamic_cast<MooseObject *>(obj_ptr));
  const auto names = ConsoleUtils::mooseObjectVectorToString(moose_objs);

  // Print string with a DBG prefix and with sufficient line breaks
  std::string message = print_header ? "Executing " + objects_type + " on " +
                                           _fe_problem.getCurrentExecuteOnFlag().name() + "\n"
                                     : "";
  message += (print_header ? "Order of execution:\n" : "") + names;
  console << ConsoleUtils::formatString(message, line_prefix) << std::endl;
}

printExecutionOrdering() [2/2]

void ThreadedElementLoop< ConstElemRange >::printExecutionOrdering ( const std::vector< std::shared_ptr< T >> &  objs_ptrs, const bool  print_header = true, const std::string &  line_prefix = "[DBG]"  ) const

protectedinherited

Definition at line 173 of file ThreadedElementLoop.h.

{
  std::vector<T *> regular_ptrs;
  for (auto shared_ptr : objs_ptrs)
    regular_ptrs.push_back(shared_ptr.get());
  printExecutionOrdering<T>(regular_ptrs, print_header, line_prefix);
}

printGeneralExecutionInformation()

void ComputeIndicatorThread::printGeneralExecutionInformation ( ) const

overrideprotectedvirtual

Print general information about the loop when it executes.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 190 of file ComputeIndicatorThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid))
    return;

  const auto & console = _fe_problem.console();
  const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
  if (!_finalize)
    console << "[DBG] Executing indicators on elements then on internal sides on " << execute_on
            << std::endl;
  else
    console << "[DBG] Finalizing indicator loop" << std::endl;
}

resetExecPrintedSets()

void ThreadedElementLoopBase< ConstElemRange >::resetExecPrintedSets ( ) const

protectedinherited

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

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

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 NonlinearThread, and FlagElementsThread.

Definition at line 429 of file ThreadedElementLoopBase.h.

{
  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()

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 50 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);

  // Update variable coupleable vector tags
  std::set<TagID> needed_var_vector_tags;
  _indicator_whs.updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_var_vector_tags, _tid);
  _internal_side_indicators.updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_var_vector_tags, _tid);
  _fe_problem.getMaterialWarehouse().updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_var_vector_tags, _tid);
  _fe_problem.setActiveFEVariableCoupleableVectorTags(needed_var_vector_tags, _tid);

  std::unordered_set<unsigned int> needed_mat_props;
  _indicator_whs.updateMatPropDependency(needed_mat_props, _tid);
  _internal_side_indicators.updateMatPropDependency(needed_mat_props, _tid);

  _fe_problem.prepareMaterials(needed_mat_props, _subdomain, _tid);
}

Member Data Documentation

_aux_sys

AuxiliarySystem& ComputeIndicatorThread::_aux_sys

protected

Definition at line 56 of file ComputeIndicatorThread.h.

Referenced by onElement(), and onInternalSide().

_blocks_exec_printed

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

mutableprotectedinherited

Keep track of which blocks were visited.

Definition at line 190 of file ThreadedElementLoopBase.h.

Referenced by ComputeMarkerThread::printBlockExecutionInformation(), printBlockExecutionInformation(), ComputeUserObjectsThread::printBlockExecutionInformation(), and NonlinearThread::printBlockExecutionInformation().

_boundaries_exec_printed

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

mutableprotectedinherited

Keep track of which boundaries were visited.

Definition at line 193 of file ThreadedElementLoopBase.h.

Referenced by NonlinearThread::printBoundaryExecutionInformation().

_fe_problem

FEProblemBase& ComputeIndicatorThread::_fe_problem

protected

Definition at line 55 of file ComputeIndicatorThread.h.

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

_finalize

bool ComputeIndicatorThread::_finalize

protected

Definition at line 64 of file ComputeIndicatorThread.h.

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

_indicator_whs

const MooseObjectWarehouse<Indicator>& ComputeIndicatorThread::_indicator_whs

protected

Indicator Storage.

Definition at line 59 of file ComputeIndicatorThread.h.

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

_internal_side_indicators

const MooseObjectWarehouse<InternalSideIndicatorBase>& ComputeIndicatorThread::_internal_side_indicators

protected

InternalSideIndicator Storage.

Definition at line 62 of file ComputeIndicatorThread.h.

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

_mesh

MooseMesh& ThreadedElementLoopBase< ConstElemRange >::_mesh

protectedinherited

Definition at line 165 of file ThreadedElementLoopBase.h.

Referenced by CacheChangedListsThread::onElement(), NonlinearThread::printBlockExecutionInformation(), and NonlinearThread::printBoundaryExecutionInformation().

_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 175 of file ThreadedElementLoopBase.h.

Referenced by ComputeResidualThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), and ComputeJacobianForScalingThread::operator()().

_old_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_neighbor_subdomain

protectedinherited

The subdomain for the last neighbor.

Definition at line 178 of file ThreadedElementLoopBase.h.

_old_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_subdomain

protectedinherited

The subdomain for the last element.

Definition at line 172 of file ThreadedElementLoopBase.h.

Referenced by ComputeJacobianForScalingThread::operator()().

_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_subdomain

protectedinherited

The subdomain for the current element.

Definition at line 169 of file ThreadedElementLoopBase.h.

Referenced by ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnElement(), ComputeResidualThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeResidualThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeMaterialsObjectThread::onBoundary(), ComputeMarkerThread::onElement(), onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeMaterialsObjectThread::onInterface(), ComputeMaterialsObjectThread::onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeJacobianBlocksThread::postInternalSide(), ComputeMarkerThread::printBlockExecutionInformation(), printBlockExecutionInformation(), ComputeUserObjectsThread::printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), ComputeUserObjectsThread::querySubdomain(), ComputeMarkerThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), subdomainChanged(), NonlinearThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

_tid

THREAD_ID ThreadedElementLoopBase< ConstElemRange >::_tid

protectedinherited

Definition at line 166 of file ThreadedElementLoopBase.h.

Referenced by ComputeResidualThread::accumulate(), ComputeResidualAndJacobianThread::accumulate(), ComputeResidualThread::accumulateLower(), ComputeResidualAndJacobianThread::accumulateLower(), ComputeJacobianThread::accumulateLower(), ComputeResidualThread::accumulateNeighbor(), ComputeResidualAndJacobianThread::accumulateNeighbor(), ComputeJacobianThread::accumulateNeighbor(), ComputeResidualThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::accumulateNeighborLower(), ComputeJacobianThread::accumulateNeighborLower(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), NonlinearThread::computeOnInterface(), ComputeResidualThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeResidualThread::determineObjectWarehouses(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeMaterialsObjectThread::onBoundary(), NonlinearThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), ComputeMarkerThread::onElement(), ComputeElemDampingThread::onElement(), ComputeMaterialsObjectThread::onElement(), onElement(), NonlinearThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeMaterialsObjectThread::onInterface(), NonlinearThread::onInterface(), ComputeUserObjectsThread::onInterface(), ComputeMaterialsObjectThread::onInternalSide(), onInternalSide(), NonlinearThread::onInternalSide(), ComputeUserObjectsThread::onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeMaterialsObjectThread::post(), ComputeMarkerThread::post(), post(), ComputeUserObjectsThread::post(), ComputeJacobianThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeJacobianBlocksThread::postInternalSide(), NonlinearThread::prepareFace(), ComputeMarkerThread::printBlockExecutionInformation(), printBlockExecutionInformation(), ComputeUserObjectsThread::printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), NonlinearThread::printBoundaryExecutionInformation(), ComputeElemDampingThread::printGeneralExecutionInformation(), ComputeMarkerThread::printGeneralExecutionInformation(), printGeneralExecutionInformation(), ComputeUserObjectsThread::printGeneralExecutionInformation(), NonlinearThread::printGeneralExecutionInformation(), ComputeUserObjectsThread::queryBoundary(), ComputeUserObjectsThread::querySubdomain(), ComputeMarkerThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), subdomainChanged(), NonlinearThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

---

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

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