AllNodesSendListThread Class Reference

#include <AllNodesSendListThread.h>

Inheritance diagram for AllNodesSendListThread:

Public Member Functions
	AllNodesSendListThread (FEProblemBase &fe_problem, const MooseMesh &mesh, const std::vector< unsigned int > &var_nums, const libMesh::System &system)
	AllNodesSendListThread (AllNodesSendListThread &x, Threads::split split)
virtual void	onNode (ConstNodeRange::const_iterator &nd) override
void	join (const AllNodesSendListThread &y)
void	unique ()
const std::vector< dof_id_type > &	send_list () const
void	operator() (const ConstNodeRange &range)
virtual void	pre ()
	Called before the node range loop.
virtual void	post ()
	Called after the node range loop.
virtual void	onNode (ConstNodeRange::const_iterator &node_it)
	Called for each node.
virtual void	postNode (ConstNodeRange::const_iterator &node_it)
	Called after the node assembly is done (including surface assembling)
virtual void	caughtMooseException (MooseException &e)
	Called if a MooseException is caught anywhere during the computation.
virtual bool	keepGoing ()
	Whether or not the loop should continue.

Protected Member Functions
virtual void	printGeneralExecutionInformation () const
	Print information about the loop, mostly order of execution of objects.

Protected Attributes
const MooseMesh &	_ref_mesh
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Private Attributes
std::vector< unsigned int >	_var_nums
const libMesh::System &	_system
const unsigned int	_system_number
const dof_id_type	_first_dof
const dof_id_type	_end_dof
std::vector< dof_id_type >	_send_list

Detailed Description

Definition at line 23 of file AllNodesSendListThread.h.

Constructor & Destructor Documentation

AllNodesSendListThread() [1/2]

AllNodesSendListThread::AllNodesSendListThread	(	FEProblemBase &	fe_problem,
		const MooseMesh &	mesh,
		const std::vector< unsigned int > &	var_nums,
		const libMesh::System &	system
	)

Definition at line 15 of file AllNodesSendListThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(fe_problem),
    _ref_mesh(mesh),
    _var_nums(var_nums),
    _system(system),
    _system_number(_system.number()),
    _first_dof(_system.get_dof_map().first_dof()),
    _end_dof(_system.get_dof_map().end_dof()),
    _send_list()
{
  // We may use the same _var_num multiple times, but it's inefficient
  // to examine it multiple times.
  std::sort(this->_var_nums.begin(), this->_var_nums.end());
 
  std::vector<unsigned int>::iterator new_end =
      std::unique(this->_var_nums.begin(), this->_var_nums.end());
 
  std::vector<unsigned int>(this->_var_nums.begin(), new_end).swap(this->_var_nums);
}

AllNodesSendListThread() [2/2]

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

Definition at line 38 of file AllNodesSendListThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(x, split),
    _ref_mesh(x._ref_mesh),
    _var_nums(x._var_nums),
    _system(x._system),
    _system_number(_system.number()),
    _first_dof(_system.get_dof_map().first_dof()),
    _end_dof(_system.get_dof_map().end_dof()),
    _send_list()
{
}

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

(

const AllNodesSendListThread &

y

)

Definition at line 67 of file AllNodesSendListThread.C.

{
  // Joining simply requires I add the dof indices from the other object
  this->_send_list.insert(this->_send_list.end(), y._send_list.begin(), y._send_list.end());
}

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 69 of file ThreadedNodeLoop.h.

{ return !_fe_problem.hasException(); }

onNode() [1/2]

void AllNodesSendListThread::onNode ( ConstNodeRange::const_iterator &  nd )

overridevirtual

Definition at line 51 of file AllNodesSendListThread.C.

{
  const Node & node = *(*nd);
 
  for (unsigned int i = 0; i < _var_nums.size(); i++)
  {
    if (node.n_dofs(_system_number, _var_nums[i]) > 0)
    {
      const dof_id_type id = node.dof_number(_system_number, _var_nums[i], 0);
      if (id < _first_dof || id >= _end_dof)
        this->_send_list.push_back(id);
    }
  }
}

onNode() [2/2]

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::onNode ( ConstNodeRange::const_iterator &  node_it )

virtualinherited

Called for each node.

Definition at line 43 of file ThreadedNodeLoop.h.

{
}

operator()()

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::operator() ( const ConstNodeRange &  range )

inherited

Definition at line 28 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< ConstNodeRange , ConstNodeRange::const_iterator >::post ( )

virtualinherited

Called after the node range loop.

Reimplemented in ComputeNodalAuxVarsThread< AuxKernelType >.

Definition at line 38 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 50 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 33 of file ThreadedNodeLoop.h.

{
}

printGeneralExecutionInformation()

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

inlineprotectedvirtualinherited

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

Reimplemented in ComputeNodalAuxVarsThread< AuxKernelType >, ComputeNodalDampingThread, ComputeNodalKernelJacobiansThread, ComputeNodalKernelsThread, and ComputeNodalUserObjectsThread.

Definition at line 76 of file ThreadedNodeLoop.h.

{}

send_list()

const std::vector< dof_id_type > & AllNodesSendListThread::send_list

(

)

const

Definition at line 95 of file AllNodesSendListThread.C.

{
  return this->_send_list;
}

Referenced by DisplacedProblem::UpdateDisplacedMeshThread::init().

unique()

void AllNodesSendListThread::unique

(

)

Definition at line 74 of file AllNodesSendListThread.C.

{
  // Sort the send list.  After this duplicated
  // elements will be adjacent in the vector
  std::sort(this->_send_list.begin(), this->_send_list.end());
 
  // Now use std::unique to remove any duplicate entries.  There
  // actually shouldn't be any, since we're hitting each node exactly
  // once and we pre-uniqued _var_nums.
  // std::vector<dof_id_type>::iterator new_end =
  //   std::unique (this->_send_list.begin(),
  //                this->_send_list.end());
 
  // If we *do* need to remove duplicate entries, then afterward we should
  // remove the end of the send_list, using the "swap trick" from Effective
  // STL.
  // std::vector<dof_id_type>
  //  (this->_send_list.begin(), new_end).swap (this->_send_list);
}

Referenced by DisplacedProblem::UpdateDisplacedMeshThread::init().

Member Data Documentation

_end_dof

const dof_id_type AllNodesSendListThread::_end_dof

private

Definition at line 54 of file AllNodesSendListThread.h.

Referenced by onNode().

_fe_problem

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

protectedinherited

Definition at line 72 of file ThreadedNodeLoop.h.

_first_dof

const dof_id_type AllNodesSendListThread::_first_dof

private

Definition at line 54 of file AllNodesSendListThread.h.

_ref_mesh

const MooseMesh& AllNodesSendListThread::_ref_mesh

protected

Definition at line 45 of file AllNodesSendListThread.h.

_send_list

std::vector<dof_id_type> AllNodesSendListThread::_send_list

private

Definition at line 56 of file AllNodesSendListThread.h.

Referenced by join(), onNode(), send_list(), and unique().

_system

const libMesh::System& AllNodesSendListThread::_system

private

Definition at line 50 of file AllNodesSendListThread.h.

_system_number

const unsigned int AllNodesSendListThread::_system_number

private

Definition at line 52 of file AllNodesSendListThread.h.

Referenced by onNode().

_tid

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

protectedinherited

Definition at line 73 of file ThreadedNodeLoop.h.

_var_nums

std::vector<unsigned int> AllNodesSendListThread::_var_nums

private

Definition at line 48 of file AllNodesSendListThread.h.

Referenced by AllNodesSendListThread(), and onNode().

---

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

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