ComputeMortarNodalAuxBndThread< AuxKernelType > Class Template Reference

This class evaluates a single mortar nodal aux kernel. More...

#include <ComputeMortarNodalAuxBndThread.h>

Inheritance diagram for ComputeMortarNodalAuxBndThread< AuxKernelType >:

Public Member Functions
	ComputeMortarNodalAuxBndThread (FEProblemBase &fe_problem, const MooseObjectWarehouse< AuxKernelType > &storage, BoundaryID bnd_id, std::size_t object_container_index)
	ComputeMortarNodalAuxBndThread (ComputeMortarNodalAuxBndThread &x, Threads::split split)
void	onNode (ConstBndNodeRange::const_iterator &node_it) override
	Called for each node. More...
void	join (const ComputeMortarNodalAuxBndThread &)
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
virtual void	printGeneralExecutionInformation () const
	Print information about the loop, mostly order of execution of objects. More...

Protected Attributes
AuxiliarySystem &	_aux_sys
	The auxiliary system. More...
const MooseObjectWarehouse< AuxKernelType > &	_storage
	Storage object containing active AuxKernel objects. More...
const BoundaryID	_bnd_id
	The boundary ID for whose nodes we will evaluate the aux kernel on. More...
const std::size_t	_object_container_index
	The index at which we should index the aux kernel containers, e.g. More...
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Detailed Description

template<typename AuxKernelType>
class ComputeMortarNodalAuxBndThread< AuxKernelType >

This class evaluates a single mortar nodal aux kernel.

Definition at line 23 of file ComputeMortarNodalAuxBndThread.h.

Constructor & Destructor Documentation

ComputeMortarNodalAuxBndThread() [1/2]

template<typename AuxKernelType >

ComputeMortarNodalAuxBndThread< AuxKernelType >::ComputeMortarNodalAuxBndThread	(	FEProblemBase &	fe_problem,
		const MooseObjectWarehouse< AuxKernelType > &	storage,
		BoundaryID	bnd_id,
		std::size_t	object_container_index
	)

Definition at line 19 of file ComputeMortarNodalAuxBndThread.C.

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

ComputeMortarNodalAuxBndThread() [2/2]

template<typename AuxKernelType >

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

Definition at line 34 of file ComputeMortarNodalAuxBndThread.C.

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

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 ComputeMortarNodalAuxBndThread< AuxKernelType >::join

(

const ComputeMortarNodalAuxBndThread< AuxKernelType > &

)

Definition at line 72 of file ComputeMortarNodalAuxBndThread.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 ComputeMortarNodalAuxBndThread< AuxKernelType >::onNode ( ConstBndNodeRange::const_iterator &  node_it )

overridevirtual

Called for each node.

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

Definition at line 46 of file ComputeMortarNodalAuxBndThread.C.

{
  const BndNode * bnode = *node_it;

  if (bnode->_bnd_id != _bnd_id)
    return;

  Node * node = bnode->_node;

  if (node->processor_id() == _fe_problem.processor_id())
  {
    const auto & kernel = _storage.getActiveBoundaryObjects(_bnd_id, _tid)[_object_container_index];
    mooseAssert(dynamic_cast<MortarNodalAuxKernel *>(kernel.get()),
                "This should be a mortar nodal aux kernel");
    _fe_problem.reinitNodeFace(node, _bnd_id, _tid);
    kernel->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 (kernel->variable().isNodalDefined())
      kernel->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()

virtual void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::printGeneralExecutionInformation ( ) const

inlineprotectedvirtualinherited

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

Reimplemented in ComputeNodalKernelBCJacobiansThread, ComputeNodalAuxBcsThread< AuxKernelType >, and ComputeNodalKernelBcsThread.

Definition at line 76 of file ThreadedNodeLoop.h.

{}

Member Data Documentation

_aux_sys

template<typename AuxKernelType>

AuxiliarySystem& ComputeMortarNodalAuxBndThread< AuxKernelType >::_aux_sys

protected

The auxiliary system.

Definition at line 39 of file ComputeMortarNodalAuxBndThread.h.

_bnd_id

template<typename AuxKernelType>

const BoundaryID ComputeMortarNodalAuxBndThread< AuxKernelType >::_bnd_id

protected

The boundary ID for whose nodes we will evaluate the aux kernel on.

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

_object_container_index

template<typename AuxKernelType>

const std::size_t ComputeMortarNodalAuxBndThread< AuxKernelType >::_object_container_index

protected

The index at which we should index the aux kernel containers, e.g.

this data member helper ensures we get the correct mortar nodal aux kernel to evaluate

Definition at line 49 of file ComputeMortarNodalAuxBndThread.h.

_storage

template<typename AuxKernelType>

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

protected

Storage object containing active AuxKernel objects.

Definition at line 42 of file ComputeMortarNodalAuxBndThread.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/ComputeMortarNodalAuxBndThread.h
• src/loops/ComputeMortarNodalAuxBndThread.C