ThreadedElementLoopBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "ParallelUniqueId.h"
#include "MooseMesh.h"
#include "MooseTypes.h"
#include "MooseException.h"
#include "libmesh/libmesh_exceptions.h"
#include "libmesh/elem.h"

template <typename RangeType>
class ThreadedElementLoopBase
{
public:
  ThreadedElementLoopBase(MooseMesh & mesh);

  ThreadedElementLoopBase(ThreadedElementLoopBase & x, Threads::split split);

  virtual ~ThreadedElementLoopBase();

  virtual void operator()(const RangeType & range, bool bypass_threading = false);

  virtual void pre();

  virtual void post();

  virtual void onElement(const Elem * elem);

  virtual void preElement(const Elem * elem);

  virtual void postElement(const Elem * elem);

  virtual void preBoundary(const Elem * elem,
                           unsigned int side,
                           BoundaryID bnd_id,
                           const Elem * lower_d_elem = nullptr);

  virtual void onBoundary(const Elem * elem,
                          unsigned int side,
                          BoundaryID bnd_id,
                          const Elem * lower_d_elem = nullptr);

  virtual void preInternalSide(const Elem * elem, unsigned int side);

  virtual void postInternalSide(const Elem * elem, unsigned int side);

  virtual void onInternalSide(const Elem * elem, unsigned int side);

  virtual void onExternalSide(const Elem * elem, unsigned int side);

  virtual void onInterface(const Elem * elem, unsigned int side, BoundaryID bnd_id);

  virtual void subdomainChanged();

  virtual void neighborSubdomainChanged();

  virtual void caughtMooseException(MooseException &){};

  virtual bool keepGoing() { return true; }

protected:
  MooseMesh & _mesh;
  THREAD_ID _tid;

  SubdomainID _subdomain;

  SubdomainID _old_subdomain;

  SubdomainID _neighbor_subdomain;

  SubdomainID _old_neighbor_subdomain;

  virtual void printGeneralExecutionInformation() const {}

  virtual void printBlockExecutionInformation() const {}

  virtual void printBoundaryExecutionInformation(const unsigned int /*bid*/) const {}

  mutable std::set<SubdomainID> _blocks_exec_printed;

  mutable std::set<BoundaryID> _boundaries_exec_printed;

  void resetExecPrintedSets() const;

  virtual bool shouldComputeInternalSide(const Elem & elem, const Elem & neighbor) const;
};

template <typename RangeType>
ThreadedElementLoopBase<RangeType>::ThreadedElementLoopBase(MooseMesh & mesh) : _mesh(mesh)
{
}

template <typename RangeType>
ThreadedElementLoopBase<RangeType>::ThreadedElementLoopBase(ThreadedElementLoopBase & x,
                                                            Threads::split /*split*/)
  : _mesh(x._mesh)
{
}

template <typename RangeType>
ThreadedElementLoopBase<RangeType>::~ThreadedElementLoopBase()
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::operator()(const RangeType & range, bool bypass_threading)
{
  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 (libMesh::LogicError & e)
    {
      mooseException("We caught a libMesh error in ThreadedElementLoopBase:", e.what());
    }
    catch (MetaPhysicL::LogicError & e)
    {
      moose::translateMetaPhysicLError(e);
    }
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::pre()
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::post()
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::onElement(const Elem * /*elem*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::preElement(const Elem * /*elem*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::postElement(const Elem * /*elem*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::preBoundary(const Elem * /*elem*/,
                                                unsigned int /*side*/,
                                                BoundaryID /*bnd_id*/,
                                                const Elem * /*lower_d_elem = nullptr*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::onBoundary(const Elem * /*elem*/,
                                               unsigned int /*side*/,
                                               BoundaryID /*bnd_id*/,
                                               const Elem * /*lower_d_elem = nullptr*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::preInternalSide(const Elem * /*elem*/, unsigned int /*side*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::postInternalSide(const Elem * /*elem*/, unsigned int /*side*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::onInternalSide(const Elem * /*elem*/, unsigned int /*side*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::onExternalSide(const Elem * /*elem*/, unsigned int /*side*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::onInterface(const Elem * /*elem*/,
                                                unsigned int /*side*/,
                                                BoundaryID /*bnd_id*/)
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::subdomainChanged()
{
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::neighborSubdomainChanged()
{
}

template <typename RangeType>
bool
ThreadedElementLoopBase<RangeType>::shouldComputeInternalSide(const Elem & elem,
                                                              const Elem & neighbor) const
{
  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);
}

template <typename RangeType>
void
ThreadedElementLoopBase<RangeType>::resetExecPrintedSets() const
{
  _blocks_exec_printed.clear();
  _boundaries_exec_printed.clear();
}