ComputeNodalAuxBcsThread< AuxKernelType > Class Template Reference

#include <ComputeNodalAuxBcsThread.h>

Inheritance diagram for ComputeNodalAuxBcsThread< AuxKernelType >:

Public Member Functions
	ComputeNodalAuxBcsThread (FEProblemBase &fe_problem, const MooseObjectWarehouse< AuxKernelType > &storage)
	ComputeNodalAuxBcsThread (ComputeNodalAuxBcsThread &x, Threads::split split)
virtual void	onNode (ConstBndNodeRange::const_iterator &node_it) override
	Called for each node. More...
void	join (const ComputeNodalAuxBcsThread &)
void	operator() (const ConstBndNodeRange &range)
virtual void	pre ()
	Called before the node range loop. More...
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
AuxiliarySystem &	_aux_sys
const MooseObjectWarehouse< AuxKernelType > &	_storage
	Storage object containing active AuxKernel objects. More...
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Detailed Description

template<typename AuxKernelType>
class ComputeNodalAuxBcsThread< AuxKernelType >

Definition at line 21 of file ComputeNodalAuxBcsThread.h.

Constructor & Destructor Documentation

ComputeNodalAuxBcsThread() [1/2]

template<typename AuxKernelType >

ComputeNodalAuxBcsThread< AuxKernelType >::ComputeNodalAuxBcsThread	(	FEProblemBase &	fe_problem,
		const MooseObjectWarehouse< AuxKernelType > &	storage
	)

Definition at line 19 of file ComputeNodalAuxBcsThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::const_iterator>(fe_problem),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _storage(storage)
{
}

ComputeNodalAuxBcsThread() [2/2]

template<typename AuxKernelType >

ComputeNodalAuxBcsThread< AuxKernelType >::ComputeNodalAuxBcsThread	(	ComputeNodalAuxBcsThread< AuxKernelType > &	x,
		Threads::split	split
	)

Definition at line 29 of file ComputeNodalAuxBcsThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::const_iterator>(x, split),
    _aux_sys(x._aux_sys),
    _storage(x._storage)
{
}

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

template<typename AuxKernelType >

void ComputeNodalAuxBcsThread< AuxKernelType >::join

(

const ComputeNodalAuxBcsThread< AuxKernelType > &

)

Definition at line 73 of file ComputeNodalAuxBcsThread.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()

template<typename AuxKernelType >

void ComputeNodalAuxBcsThread< AuxKernelType >::onNode ( ConstBndNodeRange::const_iterator &  node_it )

overridevirtual

Called for each node.

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

Definition at line 39 of file ComputeNodalAuxBcsThread.C.

{
  const BndNode * bnode = *node_it;

  BoundaryID boundary_id = bnode->_bnd_id;

  Node * node = bnode->_node;

  if (node->processor_id() == _fe_problem.processor_id())
  {
    // Get a map of all active block restricted AuxKernel objects
    const auto & kernels = _storage.getActiveBoundaryObjects(_tid);

    // Operate on the node BoundaryID only
    const auto iter = kernels.find(boundary_id);
    if (iter != kernels.end())
    {
      _fe_problem.reinitNodeFace(node, boundary_id, _tid);

      for (const auto & aux : iter->second)
      {
        aux->compute();
        // This is the same conditional check that the aux kernel performs internally before calling
        // computeValue and _var.setNodalValue. We don't want to attempt to insert into the solution
        // if we don't actually have any dofs on this node
        if (aux->variable().isNodalDefined())
          aux->variable().insert(_aux_sys.solution());
      }
    }
  }
}

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 ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::pre ( )

virtualinherited

Called before the node range loop.

Reimplemented in ComputeNodalKernelBCJacobiansThread, and ComputeNodalKernelBcsThread.

Definition at line 124 of file ThreadedNodeLoop.h.

{
}

printGeneralExecutionInformation()

template<typename AuxKernelType >

void ComputeNodalAuxBcsThread< AuxKernelType >::printGeneralExecutionInformation ( ) const

overrideprotectedvirtual

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

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

Definition at line 79 of file ComputeNodalAuxBcsThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid) || !_storage.hasActiveObjects())
    return;

  const auto & console = _fe_problem.console();
  const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
  console << "[DBG] Executing nodal auxiliary kernels on boundary nodes on " << execute_on
          << std::endl;
  console << "[DBG] Ordering of the kernels on each boundary they are defined on:" << std::endl;
  // TODO Check that all objects are active at this point
  console << _storage.activeObjectsToFormattedString() << std::endl;
}

Member Data Documentation

_aux_sys

template<typename AuxKernelType>

AuxiliarySystem& ComputeNodalAuxBcsThread< AuxKernelType >::_aux_sys

protected

Definition at line 39 of file ComputeNodalAuxBcsThread.h.

_fe_problem

FEProblemBase& ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::_fe_problem

protectedinherited

Definition at line 72 of file ThreadedNodeLoop.h.

Referenced by ComputeBoundaryInitialConditionThread::onNode(), and BoundaryNodeIntegrityCheckThread::onNode().

_storage

template<typename AuxKernelType>

const MooseObjectWarehouse<AuxKernelType>& ComputeNodalAuxBcsThread< AuxKernelType >::_storage

protected

Storage object containing active AuxKernel objects.

Definition at line 42 of file ComputeNodalAuxBcsThread.h.

_tid

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

protectedinherited

Definition at line 73 of file ThreadedNodeLoop.h.

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

---

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

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