ComputeDiracThread Class Reference

#include <ComputeDiracThread.h>

Inheritance diagram for ComputeDiracThread:

Public Member Functions
	ComputeDiracThread (FEProblemBase &feproblem, const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags, Moose::ComputeType compute_type)
	ComputeDiracThread (ComputeDiracThread &x, Threads::split)
virtual	~ComputeDiracThread ()
virtual void	subdomainChanged () override
	Called every time the current subdomain changes (i.e.
virtual void	pre () override
	Called before the element range loop.
virtual void	onElement (const Elem *elem) override
	Assembly of the element (not including surface assembly)
virtual void	postElement (const Elem *) override
	Called after the element assembly is done (including surface assembling)
virtual void	post () override
	Called after the element range loop.
void	join (const ComputeDiracThread &)
virtual void	caughtMooseException (MooseException &e) override
	Called if a MooseException is caught anywhere during the computation.
virtual bool	keepGoing () override
	Whether or not the loop should continue.
virtual void	preElement (const Elem *elem) override
	Called before the element assembly.
virtual void	preInternalSide (const Elem *elem, unsigned int side) override
	Called before evaluations on an element internal side.
virtual void	preBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override
	Called before the boundary assembly.
virtual void	neighborSubdomainChanged () override
	Called every time the neighbor subdomain changes (i.e.
virtual void	operator() (const RangeType &range, bool bypass_threading=false)
virtual void	onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr)
	Called when doing boundary assembling.
virtual void	postInternalSide (const Elem *elem, unsigned int side)
	Called after evaluations on an element internal side.
virtual void	onInternalSide (const Elem *elem, unsigned int side)
	Called when doing internal edge assembling.
virtual void	onExternalSide (const Elem *elem, unsigned int side)
	Called when iterating over external sides (no side neighbor)
virtual void	onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id)
	Called when doing interface assembling.

Protected Member Functions
void	printGeneralExecutionInformation () const override
	Output a message indicating execution on this execution flag.
void	printBlockExecutionInformation () const override
	Output the order of execution of objects within the current subdomain.
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.
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.
void	resetExecPrintedSets () const
	Resets the set of blocks and boundaries visited.
virtual bool	shouldComputeInternalSide (const Elem &elem, const Elem &neighbor) const
	Whether to compute the internal side for the provided element-neighbor pair.

Protected Attributes
Moose::ComputeType	_compute_type
NonlinearSystemBase &	_nl
const std::set< TagID > &	_vector_tags
const std::set< TagID > &	_matrix_tags
MooseObjectTagWarehouse< DiracKernelBase > &	_dirac_kernels
	Storage for DiracKernel objects.
MooseObjectWarehouse< DiracKernelBase > *	_dirac_warehouse
FEProblemBase &	_fe_problem
MooseMesh &	_mesh
THREAD_ID	_tid
SubdomainID	_subdomain
	The subdomain for the current element.
SubdomainID	_old_subdomain
	The subdomain for the last element.
SubdomainID	_neighbor_subdomain
	The subdomain for the current neighbor.
SubdomainID	_old_neighbor_subdomain
	The subdomain for the last neighbor.
std::set< SubdomainID >	_blocks_exec_printed
	Keep track of which blocks were visited.
std::set< BoundaryID >	_boundaries_exec_printed
	Keep track of which boundaries were visited.

Detailed Description

Definition at line 28 of file ComputeDiracThread.h.

Constructor & Destructor Documentation

ComputeDiracThread() [1/2]

ComputeDiracThread::ComputeDiracThread	(	FEProblemBase &	feproblem,
		const std::set< TagID > &	vector_tags,
		const std::set< TagID > &	matrix_tags,
		Moose::ComputeType	compute_type
	)

Definition at line 23 of file ComputeDiracThread.C.

  : ThreadedElementLoop<DistElemRange>(feproblem),
    _compute_type(compute_type),
    _nl(feproblem.currentNonlinearSystem()),
    _vector_tags(vector_tags),
    _matrix_tags(matrix_tags),
    _dirac_kernels(_nl.getDiracKernelWarehouse())
{
}

ComputeDiracThread() [2/2]

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

Definition at line 37 of file ComputeDiracThread.C.

  : ThreadedElementLoop<DistElemRange>(x, split),
    _compute_type(x._compute_type),
    _nl(x._nl),
    _vector_tags(x._vector_tags),
    _matrix_tags(x._matrix_tags),
    _dirac_kernels(x._dirac_kernels)
{
}

~ComputeDiracThread()

ComputeDiracThread::~ComputeDiracThread ( )

virtual

Definition at line 47 of file ComputeDiracThread.C.

{}

Member Function Documentation

caughtMooseException()

void ThreadedElementLoop< DistElemRange >::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< RangeType >.

Definition at line 43 of file ThreadedElementLoop.h.

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

clearVarsAndMaterials()

void ThreadedElementLoop< DistElemRange >::clearVarsAndMaterials ( )

protectedinherited

Definition at line 60 of file ThreadedElementLoop.h.

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

join()

void ComputeDiracThread::join

(

const ComputeDiracThread &

)

Definition at line 185 of file ComputeDiracThread.C.

{
}

keepGoing()

virtual bool ThreadedElementLoop< DistElemRange >::keepGoing ( )

inlineoverridevirtualinherited

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 45 of file ThreadedElementLoop.h.

{ return !_fe_problem.hasException(); }

neighborSubdomainChanged()

void ThreadedElementLoop< DistElemRange >::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< RangeType >.

Definition at line 56 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, const Elem *  lower_d_elem = nullptr  )

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

Reimplemented in ComputeIndicatorThread, ComputeMarkerThread, ComputeMaterialsObjectThread, ComputeUserObjectsThread, NonlinearThread, and ProjectMaterialProperties.

Definition at line 371 of file ThreadedElementLoopBase.h.

{
}

onElement()

void ComputeDiracThread::onElement ( const Elem *  elem )

overridevirtual

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 99 of file ComputeDiracThread.C.

{
  const bool has_dirac_kernels_on_elem = _fe_problem.reinitDirac(elem, _tid);
  if (!has_dirac_kernels_on_elem)
    return;
 
  std::set<MooseVariableFEBase *> needed_moose_vars;
  const auto & dkernels = _dirac_warehouse->getActiveObjects(_tid);
 
  // Only call reinitMaterials() if one or more DiracKernels has
  // actually called getMaterialProperty().  Loop over all the
  // DiracKernels and check whether this is the case.
  for (const auto & dirac_kernel : dkernels)
  {
    // If any of the DiracKernels have had getMaterialProperty()
    // called, we need to reinit Materials.
    if (dirac_kernel->getMaterialPropertyCalled())
    {
      _fe_problem.reinitMaterials(_subdomain, _tid, /*swap_stateful=*/false);
      break;
    }
  }
 
  for (const auto & dirac_kernel : dkernels)
  {
    if (!dirac_kernel->hasPointsOnElem(elem))
      continue;
 
    if (_compute_type == Moose::ComputeType::Residual)
    {
      dirac_kernel->computeResidual();
      continue;
    }
    else if (_compute_type == Moose::ComputeType::ResidualAndJacobian)
    {
      dirac_kernel->computeResidualAndJacobian();
      continue;
    }
 
    // Get a list of coupled variables from the SubProblem
    const auto & coupling_entries =
        dirac_kernel->subProblem().assembly(_tid, _nl.number()).couplingEntries();
 
    // Loop over the list of coupled variable pairs
    for (const auto & it : coupling_entries)
    {
      const MooseVariableFEBase * const ivariable = it.first;
      const MooseVariableFEBase * const jvariable = it.second;
 
      // A variant of the check that is in
      // ComputeFullJacobianThread::computeJacobian().  We
      // only want to call computeOffDiagJacobian() if both
      // variables are active on this subdomain, and the
      // off-diagonal variable actually has dofs.
      if (dirac_kernel->variable().number() == ivariable->number() &&
          ivariable->activeOnSubdomain(_subdomain) && jvariable->activeOnSubdomain(_subdomain) &&
          (jvariable->numberOfDofs() > 0))
      {
        dirac_kernel->prepareShapes(jvariable->number());
        dirac_kernel->computeOffDiagJacobian(jvariable->number());
      }
    }
  }
 
  // Note that we do not call swapBackMaterials() here as they were
  // never swapped in the first place.  This avoids messing up
  // stored values of stateful material properties.
}

onExternalSide()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::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, and NonlinearThread.

Definition at line 398 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 ComputeMaterialsObjectThread, ComputeUserObjectsThread, and NonlinearThread.

Definition at line 404 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 ComputeIndicatorThread, ComputeMarkerThread, ComputeMaterialsObjectThread, ComputeUserObjectsThread, NonlinearThread, and ProjectMaterialProperties.

Definition at line 392 of file ThreadedElementLoopBase.h.

{
}

operator()()

template<typename RangeType >

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

virtualinherited

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;
        }
 
        const auto elem_boundary_ids = _mesh.getBoundaryIDs(elem);
        for (unsigned int side = 0; side < elem->n_sides(); side++)
        {
          const auto & boundary_ids = elem_boundary_ids[side];
          const Elem * lower_d_elem = _mesh.getLowerDElem(elem, side);
 
          for (const auto bnd_id : boundary_ids)
          {
            preBoundary(elem, side, bnd_id, lower_d_elem);
            printBoundaryExecutionInformation(bnd_id);
            onBoundary(elem, side, bnd_id, 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);
 
            for (const auto bnd_id : boundary_ids)
              onInterface(elem, side, bnd_id);
 
            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);
  }
}

Referenced by NonlinearThread::operator()().

post()

void ComputeDiracThread::post ( )

overridevirtual

Called after the element range loop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 178 of file ComputeDiracThread.C.

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

postElement()

void ComputeDiracThread::postElement ( const Elem *  elem )

overridevirtual

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

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 169 of file ComputeDiracThread.C.

{
  if (_compute_type != Moose::ComputeType::Jacobian)
    _fe_problem.addResidual(_tid);
  if (_compute_type != Moose::ComputeType::Residual)
    _fe_problem.addJacobian(_tid);
}

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'

Reimplemented in ComputeJacobianBlocksThread.

Definition at line 386 of file ThreadedElementLoopBase.h.

{
}

pre()

void ComputeDiracThread::pre ( )

overridevirtual

Called before the element range loop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 50 of file ComputeDiracThread.C.

{
  // Force TID=0 because we run this object _NON THREADED_
  // Take this out if we ever get Dirac's working with threads!
  _tid = 0;
}

preBoundary()

void ThreadedElementLoop< DistElemRange >::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< RangeType >.

Definition at line 51 of file ThreadedElementLoop.h.

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

preElement()

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

overridevirtualinherited

Called before the element assembly.

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 47 of file ThreadedElementLoop.h.

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

preInternalSide()

void ThreadedElementLoop< DistElemRange >::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< RangeType >.

Definition at line 49 of file ThreadedElementLoop.h.

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

prepareElement()

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

protectedinherited

Definition at line 59 of file ThreadedElementLoop.h.

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

printBlockExecutionInformation()

void ComputeDiracThread::printBlockExecutionInformation ( ) const

overrideprotectedvirtual

Output the order of execution of objects within the current subdomain.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 200 of file ComputeDiracThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid) || _blocks_exec_printed.count(_subdomain) ||
      !_dirac_warehouse->hasActiveBlockObjects(_subdomain, _tid))
    return;
 
  const auto & dkernels = _dirac_warehouse->getActiveBlockObjects(_subdomain, _tid);
  const auto & console = _fe_problem.console();
  console << "[DBG] Ordering of DiracKernels on subdomain " << _subdomain << std::endl;
  printExecutionOrdering<DiracKernelBase>(dkernels, false);
  _blocks_exec_printed.insert(_subdomain);
}

printBoundaryExecutionInformation()

template<typename RangeType >

virtual void ThreadedElementLoopBase< RangeType >::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< DistElemRange >::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 80 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);
}

printExecutionOrdering() [2/2]

void ThreadedElementLoop< DistElemRange >::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 76 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;
}

printGeneralExecutionInformation()

void ComputeDiracThread::printGeneralExecutionInformation ( ) const

overrideprotectedvirtual

Output a message indicating execution on this execution flag.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 190 of file ComputeDiracThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid))
    return;
  const auto & console = _fe_problem.console();
  console << "[DBG] Executing Dirac Kernels on " << _fe_problem.getCurrentExecuteOnFlag().name()
          << std::endl;
}

resetExecPrintedSets()

template<typename RangeType >

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

template<typename RangeType >

bool ThreadedElementLoopBase< RangeType >::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 FlagElementsThread, ProjectMaterialProperties, CacheChangedListsThread, and NonlinearThread.

Definition at line 424 of file ThreadedElementLoopBase.h.

{
  // If we're going to compute the internal side with this elem-neighbor pair, then they must both
  // be active. Note that if elem is an active coarse element at an interface with finer elements,
  // then its neighbor will be an equal-level inactive element, hence the following
  // neighbor.active() check. In that case we'll catch current 'elem' when we come around and
  // examine one of the finer elements as 'elem'
  mooseAssert(elem.active(), "This method should never be called with an inactive element");
  if (!neighbor.active())
    return false;
 
  //
  // Define an ordering: first prefer finer by h (higher level()), then prefer finer by p (higher
  // p_level()), then prefer smaller id()"
  //
 
  const auto elem_level = elem.level(), neighbor_level = neighbor.level();
  if (elem_level != neighbor_level)
    return elem_level > neighbor_level;
 
  const auto elem_p_level = elem.p_level(), neighbor_p_level = neighbor.p_level();
  if (elem_p_level != neighbor_p_level)
    return elem_p_level > neighbor_p_level;
 
  return elem.id() < neighbor.id();
}

Referenced by NonlinearThread::shouldComputeInternalSide().

subdomainChanged()

void ComputeDiracThread::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< RangeType >.

Definition at line 58 of file ComputeDiracThread.C.

{
  _fe_problem.subdomainSetup(_subdomain, _tid);
 
  std::set<MooseVariableFEBase *> needed_moose_vars;
  _dirac_kernels.updateVariableDependency(needed_moose_vars, _tid);
 
  // Update material dependencies
  std::unordered_set<unsigned int> needed_mat_props;
  _dirac_kernels.updateMatPropDependency(needed_mat_props, _tid);
 
  _fe_problem.setActiveElementalMooseVariables(needed_moose_vars, _tid);
  _fe_problem.setActiveMaterialProperties(needed_mat_props, _tid);
 
  // The combined path always operates on the full suite of residual and Jacobian tags, so there's
  // no need for (and no single tag set to do) tag-based warehouse selection
  if (_compute_type == Moose::ComputeType::ResidualAndJacobian)
  {
    _dirac_warehouse = &_dirac_kernels;
    return;
  }
 
  const bool is_jacobian = _compute_type == Moose::ComputeType::Jacobian;
  const std::set<TagID> & tags = is_jacobian ? _matrix_tags : _vector_tags;
 
  // If users pass a empty vector or a full size of vector,
  // we take all kernels
  if (!tags.size() || tags.size() == _fe_problem.numMatrixTags())
    _dirac_warehouse = &_dirac_kernels;
  // If we have one tag only,  We call tag based storage
  else if (tags.size() == 1)
    _dirac_warehouse = is_jacobian
                           ? &(_dirac_kernels.getMatrixTagObjectWarehouse(*(tags.begin()), _tid))
                           : &(_dirac_kernels.getVectorTagObjectWarehouse(*(tags.begin()), _tid));
  // This one may be expensive, and hopefully we do not use it so often
  else
    _dirac_warehouse = is_jacobian ? &(_dirac_kernels.getMatrixTagsObjectWarehouse(tags, _tid))
                                   : &(_dirac_kernels.getVectorTagsObjectWarehouse(tags, _tid));
}

Member Data Documentation

_blocks_exec_printed

template<typename RangeType >

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

mutableprotectedinherited

Keep track of which blocks were visited.

Definition at line 190 of file ThreadedElementLoopBase.h.

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

_boundaries_exec_printed

template<typename RangeType >

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

mutableprotectedinherited

Keep track of which boundaries were visited.

Definition at line 193 of file ThreadedElementLoopBase.h.

Referenced by NonlinearThread::printBoundaryExecutionInformation().

_compute_type

Moose::ComputeType ComputeDiracThread::_compute_type

protected

Definition at line 56 of file ComputeDiracThread.h.

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

_dirac_kernels

MooseObjectTagWarehouse<DiracKernelBase>& ComputeDiracThread::_dirac_kernels

protected

Storage for DiracKernel objects.

Definition at line 63 of file ComputeDiracThread.h.

Referenced by subdomainChanged().

_dirac_warehouse

MooseObjectWarehouse<DiracKernelBase>* ComputeDiracThread::_dirac_warehouse

protected

Definition at line 65 of file ComputeDiracThread.h.

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

_fe_problem

FEProblemBase& ThreadedElementLoop< DistElemRange >::_fe_problem

protectedinherited

Definition at line 62 of file ThreadedElementLoop.h.

_matrix_tags

const std::set<TagID>& ComputeDiracThread::_matrix_tags

protected

Definition at line 60 of file ComputeDiracThread.h.

Referenced by subdomainChanged().

_mesh

template<typename RangeType >

MooseMesh& ThreadedElementLoopBase< RangeType >::_mesh

protectedinherited

Definition at line 165 of file ThreadedElementLoopBase.h.

Referenced by ProjectMaterialProperties::onBoundary(), ProjectMaterialProperties::onElement(), NonlinearThread::onExternalSide(), ProjectMaterialProperties::onInternalSide(), NonlinearThread::printBlockExecutionInformation(), and NonlinearThread::printBoundaryExecutionInformation().

_neighbor_subdomain

template<typename RangeType >

SubdomainID ThreadedElementLoopBase< RangeType >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 175 of file ThreadedElementLoopBase.h.

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

_nl

NonlinearSystemBase& ComputeDiracThread::_nl

protected

Definition at line 57 of file ComputeDiracThread.h.

Referenced by onElement().

_old_neighbor_subdomain

template<typename RangeType >

SubdomainID ThreadedElementLoopBase< RangeType >::_old_neighbor_subdomain

protectedinherited

The subdomain for the last neighbor.

Definition at line 178 of file ThreadedElementLoopBase.h.

_old_subdomain

template<typename RangeType >

SubdomainID ThreadedElementLoopBase< RangeType >::_old_subdomain

protectedinherited

The subdomain for the last element.

Definition at line 172 of file ThreadedElementLoopBase.h.

Referenced by ComputeJacobianForScalingThread::operator()().

_subdomain

template<typename RangeType >

SubdomainID ThreadedElementLoopBase< RangeType >::_subdomain

protectedinherited

The subdomain for the current element.

Definition at line 169 of file ThreadedElementLoopBase.h.

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

_tid

template<typename RangeType >

THREAD_ID ThreadedElementLoopBase< RangeType >::_tid

protectedinherited

Definition at line 166 of file ThreadedElementLoopBase.h.

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

_vector_tags

const std::set<TagID>& ComputeDiracThread::_vector_tags

protected

Definition at line 59 of file ComputeDiracThread.h.

Referenced by subdomainChanged().

---

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

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