ComputeNodalKernelBcsThread Class Reference

#include <ComputeNodalKernelBcsThread.h>

Inheritance diagram for ComputeNodalKernelBcsThread:

Public Member Functions
	ComputeNodalKernelBcsThread (FEProblemBase &fe_problem, MooseObjectTagWarehouse< NodalKernelBase > &nodal_kernels, const std::set< TagID > &tags)
	ComputeNodalKernelBcsThread (ComputeNodalKernelBcsThread &x, Threads::split split)
virtual void	pre () override
	Called before the node range loop. More...
virtual void	onNode (ConstBndNodeRange::const_iterator &node_it) override
	Called for each node. More...
void	join (const ComputeNodalKernelBcsThread &)
void	operator() (const ConstBndNodeRange &range)
virtual void	post ()
	Called after the node range loop. More...
virtual void	postNode (ConstBndNodeRange::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 Member Functions
void	printGeneralExecutionInformation () const override
	Print information about the loop, mostly order of execution of objects. More...

Protected Attributes
FEProblemBase &	_fe_problem
AuxiliarySystem &	_aux_sys
const std::set< TagID > &	_tags
MooseObjectTagWarehouse< NodalKernelBase > &	_nodal_kernels
MooseObjectWarehouse< NodalKernelBase > *	_nkernel_warehouse
unsigned int	_num_cached
THREAD_ID	_tid

Detailed Description

Definition at line 19 of file ComputeNodalKernelBcsThread.h.

Constructor & Destructor Documentation

ComputeNodalKernelBcsThread() [1/2]

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

Definition at line 20 of file ComputeNodalKernelBcsThread.C.

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

ComputeNodalKernelBcsThread() [2/2]

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

Definition at line 34 of file ComputeNodalKernelBcsThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::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< ConstBndNodeRange , ConstBndNodeRange::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 56 of file ThreadedNodeLoop.h.

  {
    Threads::spin_mutex::scoped_lock lock(threaded_node_mutex);

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

join()

void ComputeNodalKernelBcsThread::join

(

const ComputeNodalKernelBcsThread &

)

Definition at line 100 of file ComputeNodalKernelBcsThread.C.

{
}

keepGoing()

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

inlinevirtualinherited

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Definition at line 69 of file ThreadedNodeLoop.h.

{ return !_fe_problem.hasException(); }

onNode()

void ComputeNodalKernelBcsThread::onNode ( ConstBndNodeRange::const_iterator &  node_it )

overridevirtual

Called for each node.

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

Definition at line 59 of file ComputeNodalKernelBcsThread.C.

{
  const BndNode * bnode = *node_it;

  BoundaryID boundary_id = bnode->_bnd_id;

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

  if (_nkernel_warehouse->hasActiveBoundaryObjects(boundary_id, _tid))
  {
    Node * node = bnode->_node;
    if (node->processor_id() == _fe_problem.processor_id())
    {
      std::set<TagID> needed_fe_var_vector_tags;
      _nkernel_warehouse->updateBoundaryFEVariableCoupledVectorTagDependency(
          boundary_id, needed_fe_var_vector_tags, _tid);
      _fe_problem.setActiveFEVariableCoupleableVectorTags(needed_fe_var_vector_tags, _tid);

      _fe_problem.reinitNodeFace(node, boundary_id, _tid);
      const auto & objects = _nkernel_warehouse->getActiveBoundaryObjects(boundary_id, _tid);
      for (const auto & nodal_kernel : objects)
      {
        nodal_kernel->setSubdomains(Moose::NodeArg::undefined_subdomain_connection);
        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< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::operator() ( const ConstBndNodeRange &  range )

inherited

Definition at line 94 of file ThreadedNodeLoop.h.

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

post()

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

virtualinherited

Called after the node range loop.

Definition at line 130 of file ThreadedNodeLoop.h.

{
}

postNode()

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

virtualinherited

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

Parameters

node	- active node

Definition at line 142 of file ThreadedNodeLoop.h.

{
}

pre()

void ComputeNodalKernelBcsThread::pre ( )

overridevirtual

Called before the node range loop.

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

Definition at line 46 of file ComputeNodalKernelBcsThread.C.

{
  _num_cached = 0;

  if (!_tags.size() || _tags.size() == _fe_problem.numVectorTags(Moose::VECTOR_TAG_RESIDUAL))
    _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));
}

printGeneralExecutionInformation()

void ComputeNodalKernelBcsThread::printGeneralExecutionInformation ( ) const

overrideprotectedvirtual

Print information about the loop, mostly order of execution of objects.

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

Definition at line 105 of file ComputeNodalKernelBcsThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid) || !_nkernel_warehouse->hasActiveObjects())
    return;

  const auto & console = _fe_problem.console();
  const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
  console << "[DBG] Executing nodal kernels contribution to residual on nodes on " << execute_on
          << std::endl;
  console << "[DBG] Ordering of the nodal kernels on the nodes they are defined on:" << std::endl;
  console << _nkernel_warehouse->activeObjectsToFormattedString() << std::endl;
}

Member Data Documentation

_aux_sys

AuxiliarySystem& ComputeNodalKernelBcsThread::_aux_sys

protected

Definition at line 41 of file ComputeNodalKernelBcsThread.h.

Referenced by onNode().

_fe_problem

FEProblemBase& ComputeNodalKernelBcsThread::_fe_problem

protected

Definition at line 39 of file ComputeNodalKernelBcsThread.h.

Referenced by onNode(), pre(), and printGeneralExecutionInformation().

_nkernel_warehouse

MooseObjectWarehouse<NodalKernelBase>* ComputeNodalKernelBcsThread::_nkernel_warehouse

protected

Definition at line 47 of file ComputeNodalKernelBcsThread.h.

Referenced by onNode(), pre(), and printGeneralExecutionInformation().

_nodal_kernels

MooseObjectTagWarehouse<NodalKernelBase>& ComputeNodalKernelBcsThread::_nodal_kernels

protected

Definition at line 45 of file ComputeNodalKernelBcsThread.h.

Referenced by pre().

_num_cached

unsigned int ComputeNodalKernelBcsThread::_num_cached

protected

Definition at line 50 of file ComputeNodalKernelBcsThread.h.

Referenced by onNode(), and pre().

_tags

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

protected

Definition at line 43 of file ComputeNodalKernelBcsThread.h.

Referenced by pre().

_tid

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

protectedinherited

Definition at line 73 of file ThreadedNodeLoop.h.

Referenced by ComputeBoundaryInitialConditionThread::onNode(), onNode(), BoundaryNodeIntegrityCheckThread::onNode(), ComputeNodalKernelBCJacobiansThread::onNode(), pre(), ComputeNodalKernelBCJacobiansThread::pre(), printGeneralExecutionInformation(), and ComputeNodalKernelBCJacobiansThread::printGeneralExecutionInformation().

---

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

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