BoundaryNodeIntegrityCheckThread Class Reference

#include <BoundaryNodeIntegrityCheckThread.h>

Inheritance diagram for BoundaryNodeIntegrityCheckThread:

Public Member Functions
	BoundaryNodeIntegrityCheckThread (FEProblemBase &fe_problem, const TheWarehouse::Query &query)
	BoundaryNodeIntegrityCheckThread (BoundaryNodeIntegrityCheckThread &x, Threads::split split)
virtual void	onNode (ConstBndNodeRange::const_iterator &node_it) override
	Called for each node. More...
void	join (const BoundaryNodeIntegrityCheckThread &)
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
const AuxiliarySystem &	_aux_sys
	The auxiliary system to whom we'll delegate the boundary variable dependency integrity check. More...
const ExecuteMooseObjectWarehouse< AuxKernel > &	_nodal_aux
	Nodal auxiliary kernels acting on standard field variables. More...
const ExecuteMooseObjectWarehouse< VectorAuxKernel > &	_nodal_vec_aux
	Nodal auxiliary kernels acting on vector field variables. More...
const ExecuteMooseObjectWarehouse< ArrayAuxKernel > &	_nodal_array_aux
	Nodal auxiliary kernels acting on array field variables. More...
const TheWarehouse::Query &	_query
	A warehouse query that we will use to obtain user objects for boundary variable dependency integrity checks. More...
const std::map< dof_id_type, std::vector< dof_id_type > >	_node_to_elem_map
	Node to element map. Used for determining vertex vs. non-vertex nodes. More...
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Detailed Description

Definition at line 24 of file BoundaryNodeIntegrityCheckThread.h.

Constructor & Destructor Documentation

BoundaryNodeIntegrityCheckThread() [1/2]

BoundaryNodeIntegrityCheckThread::BoundaryNodeIntegrityCheckThread	(	FEProblemBase &	fe_problem,
		const TheWarehouse::Query &	query
	)

Definition at line 26 of file BoundaryNodeIntegrityCheckThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::const_iterator>(fe_problem),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _nodal_aux(_aux_sys.nodalAuxWarehouse()),
    _nodal_vec_aux(_aux_sys.nodalVectorAuxWarehouse()),
    _nodal_array_aux(_aux_sys.nodalArrayAuxWarehouse()),
    _query(query),
    _node_to_elem_map(fe_problem.mesh().nodeToActiveSemilocalElemMap())
{
}

BoundaryNodeIntegrityCheckThread() [2/2]

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

Definition at line 39 of file BoundaryNodeIntegrityCheckThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::const_iterator>(x, split),
    _aux_sys(x._aux_sys),
    _nodal_aux(x._nodal_aux),
    _nodal_vec_aux(x._nodal_vec_aux),
    _nodal_array_aux(x._nodal_array_aux),
    _query(x._query),
    _node_to_elem_map(x._node_to_elem_map)
{
}

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 BoundaryNodeIntegrityCheckThread::join

(

const BoundaryNodeIntegrityCheckThread &

)

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

overridevirtual

Called for each node.

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

Definition at line 52 of file BoundaryNodeIntegrityCheckThread.C.

{
  const BndNode * const bnode = *node_it;
  const auto boundary_id = bnode->_bnd_id;
  const Node * const node = bnode->_node;

  // We can distribute work just as the actual execution code will
  if (node->processor_id() != _fe_problem.processor_id())
    return;

  auto & mesh = _fe_problem.mesh();

  // Only check vertices. Variables may not be defined on non-vertex nodes (think first order
  // Lagrange on a second order mesh) and user-code can often handle that
  const Elem * const an_elem =
      mesh.getMesh().elem_ptr(libmesh_map_find(_node_to_elem_map, node->id()).front());
  if (!an_elem->is_vertex(an_elem->get_node_index(node)))
    return;

  const auto & bnd_name = mesh.getBoundaryName(boundary_id);

  // uo check
  std::vector<NodalUserObject *> objs;
  _query.clone()
      .condition<AttribThread>(_tid)
      .condition<AttribInterfaces>(Interfaces::NodalUserObject)
      .condition<AttribBoundaries>(boundary_id, true)
      .queryInto(objs);
  for (const auto & uo : objs)
    if (uo->checkVariableBoundaryIntegrity())
      boundaryIntegrityCheckError(*uo, uo->checkAllVariables(*node), bnd_name);

  auto check = [node, boundary_id, &bnd_name, this](const auto & warehouse)
  {
    if (!warehouse.hasBoundaryObjects(boundary_id, _tid))
      return;

    const auto & bnd_objects = warehouse.getBoundaryObjects(boundary_id, _tid);
    for (const auto & bnd_object : bnd_objects)
      // Skip if this object uses geometric search because coupled variables may be defined on
      // paired boundaries instead of the boundary this node is on
      if (!bnd_object->requiresGeometricSearch() && bnd_object->checkVariableBoundaryIntegrity())
        boundaryIntegrityCheckError(*bnd_object, bnd_object->checkAllVariables(*node), bnd_name);
  };

  check(_nodal_aux);
  check(_nodal_vec_aux);
  check(_nodal_array_aux);
}

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

const AuxiliarySystem& BoundaryNodeIntegrityCheckThread::_aux_sys

protected

The auxiliary system to whom we'll delegate the boundary variable dependency integrity check.

Definition at line 39 of file BoundaryNodeIntegrityCheckThread.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 onNode().

_nodal_array_aux

const ExecuteMooseObjectWarehouse<ArrayAuxKernel>& BoundaryNodeIntegrityCheckThread::_nodal_array_aux

protected

Nodal auxiliary kernels acting on array field variables.

Definition at line 48 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

_nodal_aux

const ExecuteMooseObjectWarehouse<AuxKernel>& BoundaryNodeIntegrityCheckThread::_nodal_aux

protected

Nodal auxiliary kernels acting on standard field variables.

Definition at line 42 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

_nodal_vec_aux

const ExecuteMooseObjectWarehouse<VectorAuxKernel>& BoundaryNodeIntegrityCheckThread::_nodal_vec_aux

protected

Nodal auxiliary kernels acting on vector field variables.

Definition at line 45 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

_node_to_elem_map

const std::map<dof_id_type, std::vector<dof_id_type> > BoundaryNodeIntegrityCheckThread::_node_to_elem_map

protected

Node to element map. Used for determining vertex vs. non-vertex nodes.

Definition at line 55 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

_query

const TheWarehouse::Query& BoundaryNodeIntegrityCheckThread::_query

protected

A warehouse query that we will use to obtain user objects for boundary variable dependency integrity checks.

Definition at line 52 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

_tid

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

protectedinherited

Definition at line 73 of file ThreadedNodeLoop.h.

Referenced by ComputeBoundaryInitialConditionThread::onNode(), ComputeNodalKernelBcsThread::onNode(), 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/BoundaryNodeIntegrityCheckThread.h
• src/loops/BoundaryNodeIntegrityCheckThread.C