ComputeNodalUserObjectsThread Class Reference

#include <ComputeNodalUserObjectsThread.h>

Inheritance diagram for ComputeNodalUserObjectsThread:

Public Member Functions
	ComputeNodalUserObjectsThread (FEProblemBase &fe_problem, const TheWarehouse::Query &query)
	ComputeNodalUserObjectsThread (ComputeNodalUserObjectsThread &x, Threads::split split)
virtual	~ComputeNodalUserObjectsThread ()
virtual void	onNode (ConstNodeRange::const_iterator &node_it) override
	Called for each node. More...
void	join (const ComputeNodalUserObjectsThread &)
void	operator() (const ConstNodeRange &range)
virtual void	pre ()
	Called before the node range loop. More...
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
THREAD_ID	_tid

Private Attributes
const TheWarehouse::Query	_query

Detailed Description

Definition at line 20 of file ComputeNodalUserObjectsThread.h.

Constructor & Destructor Documentation

ComputeNodalUserObjectsThread() [1/2]

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

Definition at line 19 of file ComputeNodalUserObjectsThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(fe_problem), _query(query)
{
}

ComputeNodalUserObjectsThread() [2/2]

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

Definition at line 26 of file ComputeNodalUserObjectsThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(x, split), _query(x._query)
{
}

~ComputeNodalUserObjectsThread()

ComputeNodalUserObjectsThread::~ComputeNodalUserObjectsThread ( )

virtual

Definition at line 32 of file ComputeNodalUserObjectsThread.C.

{}

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

(

const ComputeNodalUserObjectsThread &

)

Definition at line 84 of file ComputeNodalUserObjectsThread.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 ComputeNodalUserObjectsThread::onNode ( ConstNodeRange::const_iterator &  node_it )

overridevirtual

Called for each node.

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

Definition at line 35 of file ComputeNodalUserObjectsThread.C.

{
  const Node * node = *node_it;
  _fe_problem.reinitNode(node, _tid);

  std::vector<NodalUserObject *> objs;

  // Boundary Restricted
  std::vector<BoundaryID> nodeset_ids;
  _fe_problem.mesh().getMesh().get_boundary_info().boundary_ids(node, nodeset_ids);
  for (const auto & bnd : nodeset_ids)
  {
    _query.clone()
        .condition<AttribThread>(_tid)
        .condition<AttribInterfaces>(Interfaces::NodalUserObject)
        .condition<AttribBoundaries>(bnd, true)
        .queryInto(objs);
    for (const auto & uo : objs)
      uo->execute();
  }

  // Block Restricted
  // NodalUserObjects may be block restricted, in this case by default the execute() method is
  // called for
  // each subdomain that the node "belongs". This may be disabled in the NodalUserObject by setting
  // "unique_node_execute = true".

  // To inforce the unique execution this vector is populated and checked if the unique flag is
  // enabled.
  std::set<NodalUserObject *> computed;
  const std::set<SubdomainID> & block_ids = _fe_problem.mesh().getNodeBlockIds(*node);
  for (const auto & block : block_ids)
  {
    _query.clone()
        .condition<AttribThread>(_tid)
        .condition<AttribInterfaces>(Interfaces::NodalUserObject)
        .condition<AttribSubdomains>(block)
        .queryInto(objs);

    for (const auto & uo : objs)
      if (!uo->isUniqueNodeExecute() || computed.count(uo) == 0)
      {
        uo->execute();
        computed.insert(uo);
      }
  }
}

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

virtualinherited

Called before the node range loop.

Reimplemented in ComputeNodalKernelJacobiansThread, and ComputeNodalKernelsThread.

Definition at line 117 of file ThreadedNodeLoop.h.

{
}

Member Data Documentation

_fe_problem

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

protectedinherited

Definition at line 69 of file ThreadedNodeLoop.h.

Referenced by onNode(), and ComputeNodalDampingThread::onNode().

_query

const TheWarehouse::Query ComputeNodalUserObjectsThread::_query

private

Definition at line 35 of file ComputeNodalUserObjectsThread.h.

Referenced by onNode().

_tid

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

protectedinherited

Definition at line 70 of file ThreadedNodeLoop.h.

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

---

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

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