ThreadedNodeLoop.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 "FEProblemBase.h"
#include "ParallelUniqueId.h"

static Threads::spin_mutex threaded_node_mutex;

template <typename RangeType, typename IteratorType>
class ThreadedNodeLoop
{
public:
  ThreadedNodeLoop(FEProblemBase & fe_problem);

  // Splitting Constructor
  ThreadedNodeLoop(ThreadedNodeLoop & x, Threads::split split);

  virtual ~ThreadedNodeLoop(){};

  void operator()(const RangeType & range);

  virtual void pre();

  virtual void post();

  virtual void onNode(IteratorType & node_it);

  virtual void postNode(IteratorType & node_it);

  virtual void caughtMooseException(MooseException & e)
  {
    Threads::spin_mutex::scoped_lock lock(threaded_node_mutex);

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

  virtual bool keepGoing() { return !_fe_problem.hasException(); }

protected:
  FEProblemBase & _fe_problem;
  THREAD_ID _tid;

  virtual void printGeneralExecutionInformation() const {}
};

template <typename RangeType, typename IteratorType>
ThreadedNodeLoop<RangeType, IteratorType>::ThreadedNodeLoop(FEProblemBase & fe_problem)
  : _fe_problem(fe_problem)
{
}

template <typename RangeType, typename IteratorType>
ThreadedNodeLoop<RangeType, IteratorType>::ThreadedNodeLoop(ThreadedNodeLoop & x,
                                                            Threads::split /*split*/)
  : _fe_problem(x._fe_problem)
{
}

template <typename RangeType, typename IteratorType>
void
ThreadedNodeLoop<RangeType, IteratorType>::operator()(const RangeType & range)
{
  try
  {
    ParallelUniqueId puid;
    _tid = puid.id;

    pre();
    printGeneralExecutionInformation();

    for (IteratorType nd = range.begin(); nd != range.end(); ++nd)
    {
      if (!keepGoing())
        break;

      onNode(nd);

      postNode(nd);
    }

    post();
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

template <typename RangeType, typename IteratorType>
void
ThreadedNodeLoop<RangeType, IteratorType>::pre()
{
}

template <typename RangeType, typename IteratorType>
void
ThreadedNodeLoop<RangeType, IteratorType>::post()
{
}

template <typename RangeType, typename IteratorType>
void
ThreadedNodeLoop<RangeType, IteratorType>::onNode(IteratorType & /*node_it*/)
{
}

template <typename RangeType, typename IteratorType>
void
ThreadedNodeLoop<RangeType, IteratorType>::postNode(IteratorType & /*node_it*/)
{
}