ThreadedNodeLoop< RangeType, IteratorType > Class Template Reference

#include <ThreadedNodeLoop.h>

Public Member Functions
	ThreadedNodeLoop (FEProblemBase &fe_problem)
	ThreadedNodeLoop (ThreadedNodeLoop &x, Threads::split split)
virtual	~ThreadedNodeLoop ()
void	operator() (const RangeType &range)
virtual void	pre ()
	Called before the node range loop. More...
virtual void	post ()
	Called after the node range loop. More...
virtual void	onNode (IteratorType &node_it)
	Called for each node. More...
virtual void	postNode (IteratorType &node_it)
	Called after the node assembly is done (including surface assembling) More...
virtual void	caughtMooseException (MooseException &e)
	Called if a MooseException is caught anywhere during the computation. More...
virtual bool	keepGoing ()
	Whether or not the loop should continue. More...

Protected Attributes
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Detailed Description

template<typename RangeType, typename IteratorType>
class ThreadedNodeLoop< RangeType, IteratorType >

Definition at line 17 of file ThreadedNodeLoop.h.

Constructor & Destructor Documentation

ThreadedNodeLoop() [1/2]

template<typename RangeType , typename IteratorType >

ThreadedNodeLoop< RangeType, IteratorType >::ThreadedNodeLoop

(

FEProblemBase &

fe_problem

)

Definition at line 74 of file ThreadedNodeLoop.h.

  : _fe_problem(fe_problem)
{
}

ThreadedNodeLoop() [2/2]

template<typename RangeType , typename IteratorType >

ThreadedNodeLoop< RangeType, IteratorType >::ThreadedNodeLoop	(	ThreadedNodeLoop< RangeType, IteratorType > &	x,
		Threads::split	split
	)

Definition at line 80 of file ThreadedNodeLoop.h.

  : _fe_problem(x._fe_problem)
{
}

~ThreadedNodeLoop()

template<typename RangeType, typename IteratorType>

virtual ThreadedNodeLoop< RangeType, IteratorType >::~ThreadedNodeLoop ( )

inlinevirtual

Definition at line 25 of file ThreadedNodeLoop.h.

{};

Member Function Documentation

caughtMooseException()

template<typename RangeType, typename IteratorType>

virtual void ThreadedNodeLoop< RangeType, IteratorType >::caughtMooseException ( MooseException &  e )

inlinevirtual

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Definition at line 55 of file ThreadedNodeLoop.h.

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

keepGoing()

template<typename RangeType, typename IteratorType>

virtual bool ThreadedNodeLoop< RangeType, IteratorType >::keepGoing ( )

inlinevirtual

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Definition at line 66 of file ThreadedNodeLoop.h.

{ return !_fe_problem.hasException(); }

onNode()

template<typename RangeType , typename IteratorType>

void ThreadedNodeLoop< RangeType, IteratorType >::onNode ( IteratorType &  node_it )

virtual

Called for each node.

Reimplemented in ComputeNodalKernelJacobiansThread, ComputeNodalKernelsThread, AllNodesSendListThread, ComputeNodalDampingThread, UpdateDisplacedMeshThread, ComputeNodalAuxVarsThread, ComputeNodalKernelBCJacobiansThread, ComputeNodalAuxBcsThread, ComputeNodalKernelBcsThread, ComputeBoundaryInitialConditionThread, ResetDisplacedMeshThread, and ComputeNodalUserObjectsThread.

Definition at line 129 of file ThreadedNodeLoop.h.

{
}

operator()()

template<typename RangeType, typename IteratorType >

void ThreadedNodeLoop< RangeType, IteratorType >::operator()

(

const RangeType &

range

)

Definition at line 88 of file ThreadedNodeLoop.h.

{
  try
  {
    ParallelUniqueId puid;
    _tid = puid.id;

    pre();

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

      onNode(nd);

      postNode(nd);
    }

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

post()

template<typename RangeType , typename IteratorType >

void ThreadedNodeLoop< RangeType, IteratorType >::post ( )

virtual

Called after the node range loop.

Reimplemented in ComputeNodalAuxVarsThread.

Definition at line 123 of file ThreadedNodeLoop.h.

{
}

postNode()

template<typename RangeType , typename IteratorType>

void ThreadedNodeLoop< RangeType, IteratorType >::postNode ( IteratorType &  node_it )

virtual

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

Parameters

node	- active node

Definition at line 135 of file ThreadedNodeLoop.h.

{
}

pre()

template<typename RangeType , typename IteratorType >

void ThreadedNodeLoop< RangeType, IteratorType >::pre ( )

virtual

Called before the node range loop.

Reimplemented in ComputeNodalKernelJacobiansThread, ComputeNodalKernelsThread, ComputeNodalKernelBCJacobiansThread, and ComputeNodalKernelBcsThread.

Definition at line 117 of file ThreadedNodeLoop.h.

{
}

Member Data Documentation

_fe_problem

template<typename RangeType, typename IteratorType>

FEProblemBase& ThreadedNodeLoop< RangeType, IteratorType >::_fe_problem

protected

Definition at line 69 of file ThreadedNodeLoop.h.

Referenced by ThreadedNodeLoop< ConstBndNodeRange, ConstBndNodeRange::const_iterator >::caughtMooseException(), and ThreadedNodeLoop< ConstBndNodeRange, ConstBndNodeRange::const_iterator >::keepGoing().

_tid

template<typename RangeType, typename IteratorType>

THREAD_ID ThreadedNodeLoop< RangeType, IteratorType >::_tid

protected

Definition at line 70 of file ThreadedNodeLoop.h.

---

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

• include/loops/ThreadedNodeLoop.h