ComputeNodalKernelsThread Class Reference

#include <ComputeNodalKernelsThread.h>

Inheritance diagram for ComputeNodalKernelsThread:

Public Member Functions
	ComputeNodalKernelsThread (FEProblemBase &fe_problem, MooseObjectTagWarehouse< NodalKernel > &nodal_kernels, const std::set< TagID > &tags)
	ComputeNodalKernelsThread (ComputeNodalKernelsThread &x, Threads::split split)
virtual void	pre () override
	Called before the node range loop. More...
virtual void	onNode (ConstNodeRange::const_iterator &node_it) override
	Called for each node. More...
void	join (const ComputeNodalKernelsThread &)
void	operator() (const ConstNodeRange &range)
virtual void	post ()
	Called after the node range loop. More...
virtual void	postNode (ConstNodeRange::const_iterator &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
AuxiliarySystem &	_aux_sys
const std::set< TagID > &	_tags
MooseObjectTagWarehouse< NodalKernel > &	_nodal_kernels
MooseObjectWarehouse< NodalKernel > *	_nkernel_warehouse
unsigned int	_num_cached
	Number of contributions cached up. More...
THREAD_ID	_tid

Detailed Description

Definition at line 23 of file ComputeNodalKernelsThread.h.

Constructor & Destructor Documentation

ComputeNodalKernelsThread() [1/2]

ComputeNodalKernelsThread::ComputeNodalKernelsThread	(	FEProblemBase &	fe_problem,
		MooseObjectTagWarehouse< NodalKernel > &	nodal_kernels,
		const std::set< TagID > &	tags
	)

Definition at line 21 of file ComputeNodalKernelsThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(fe_problem),
    _fe_problem(fe_problem),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _tags(tags),
    _nodal_kernels(nodal_kernels),
    _num_cached(0)
{
}

ComputeNodalKernelsThread() [2/2]

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

Definition at line 35 of file ComputeNodalKernelsThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(x, split),
    _fe_problem(x._fe_problem),
    _aux_sys(x._aux_sys),
    _tags(x._tags),
    _nodal_kernels(x._nodal_kernels),
    _num_cached(0)
{
}

Member Function Documentation

caughtMooseException()

virtual void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::caughtMooseException ( MooseException &  e )

inlinevirtualinherited

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

join()

void ComputeNodalKernelsThread::join

(

const ComputeNodalKernelsThread &

)

Definition at line 90 of file ComputeNodalKernelsThread.C.

{
}

keepGoing()

virtual bool ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::keepGoing ( )

inlinevirtualinherited

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

void ComputeNodalKernelsThread::onNode ( ConstNodeRange::const_iterator &  node_it )

overridevirtual

Called for each node.

Reimplemented from ThreadedNodeLoop< ConstNodeRange, ConstNodeRange::const_iterator >.

Definition at line 60 of file ComputeNodalKernelsThread.C.

{
  const Node * node = *node_it;

  // prepare variables
  for (auto * var : _aux_sys._nodal_vars[_tid])
    var->prepareAux();

  _fe_problem.reinitNode(node, _tid);

  const std::set<SubdomainID> & block_ids = _aux_sys.mesh().getNodeBlockIds(*node);
  for (const auto & block : block_ids)
    if (_nkernel_warehouse->hasActiveBlockObjects(block, _tid))
    {
      const auto & objects = _nkernel_warehouse->getActiveBlockObjects(block, _tid);
      for (const auto & nodal_kernel : objects)
        nodal_kernel->computeResidual();
    }

  _num_cached++;

  if (_num_cached == 20) // Cache 20 nodes worth before adding into the residual
  {
    _num_cached = 0;
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    _fe_problem.addCachedResidual(_tid);
  }
}

operator()()

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::operator() ( const ConstNodeRange &  range )

inherited

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

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::post ( )

virtualinherited

Called after the node range loop.

Reimplemented in ComputeNodalAuxVarsThread< AuxKernelType >.

Definition at line 123 of file ThreadedNodeLoop.h.

{
}

postNode()

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::postNode ( ConstNodeRange::const_iterator &  node_it )

virtualinherited

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

Parameters

node	- active node

Definition at line 135 of file ThreadedNodeLoop.h.

{
}

pre()

void ComputeNodalKernelsThread::pre ( )

overridevirtual

Called before the node range loop.

Reimplemented from ThreadedNodeLoop< ConstNodeRange, ConstNodeRange::const_iterator >.

Definition at line 47 of file ComputeNodalKernelsThread.C.

{
  _num_cached = 0;

  if (!_tags.size() || _tags.size() == _fe_problem.numVectorTags())
    _nkernel_warehouse = &_nodal_kernels;
  else if (_tags.size() == 1)
    _nkernel_warehouse = &(_nodal_kernels.getVectorTagObjectWarehouse(*(_tags.begin()), _tid));
  else
    _nkernel_warehouse = &(_nodal_kernels.getVectorTagsObjectWarehouse(_tags, _tid));
}

Member Data Documentation

_aux_sys

AuxiliarySystem& ComputeNodalKernelsThread::_aux_sys

protected

Definition at line 43 of file ComputeNodalKernelsThread.h.

Referenced by onNode().

_fe_problem

FEProblemBase& ComputeNodalKernelsThread::_fe_problem

protected

Definition at line 41 of file ComputeNodalKernelsThread.h.

Referenced by onNode(), and pre().

_nkernel_warehouse

MooseObjectWarehouse<NodalKernel>* ComputeNodalKernelsThread::_nkernel_warehouse

protected

Definition at line 49 of file ComputeNodalKernelsThread.h.

Referenced by onNode(), and pre().

_nodal_kernels

MooseObjectTagWarehouse<NodalKernel>& ComputeNodalKernelsThread::_nodal_kernels

protected

Definition at line 47 of file ComputeNodalKernelsThread.h.

Referenced by pre().

_num_cached

unsigned int ComputeNodalKernelsThread::_num_cached

protected

Number of contributions cached up.

Definition at line 52 of file ComputeNodalKernelsThread.h.

Referenced by onNode(), and pre().

_tags

const std::set<TagID>& ComputeNodalKernelsThread::_tags

protected

Definition at line 45 of file ComputeNodalKernelsThread.h.

Referenced by pre().

_tid

THREAD_ID ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::_tid

protectedinherited

Definition at line 70 of file ThreadedNodeLoop.h.

Referenced by ComputeNodalUserObjectsThread::onNode(), ComputeNodalDampingThread::onNode(), onNode(), ComputeNodalKernelJacobiansThread::onNode(), pre(), and ComputeNodalKernelJacobiansThread::pre().

---

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

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