MaxVarNDofsPerNode Class Reference

#include <MaxVarNDofsPerNode.h>

Inheritance diagram for MaxVarNDofsPerNode:

Public Member Functions
	MaxVarNDofsPerNode (FEProblemBase &feproblem, SolverSystem &sys)
	MaxVarNDofsPerNode (MaxVarNDofsPerNode &x, Threads::split split)
virtual	~MaxVarNDofsPerNode ()
virtual void	onNode (ConstNodeRange::const_iterator &node_it) override
void	join (const MaxVarNDofsPerNode &)
dof_id_type	max ()
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
SolverSystem &	_system
	The nonlinear system.
size_t	_max
	Maximum number of dofs for any one variable on any one node.
const DofMap &	_dof_map
	DOF map.
std::vector< dof_id_type >	_dof_indices
	Reusable storage.
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Detailed Description

Definition at line 18 of file MaxVarNDofsPerNode.h.

Constructor & Destructor Documentation

MaxVarNDofsPerNode() [1/2]

MaxVarNDofsPerNode::MaxVarNDofsPerNode	(	FEProblemBase &	feproblem,
		SolverSystem &	sys
	)

Definition at line 18 of file MaxVarNDofsPerNode.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(feproblem),
    _system(sys),
    _max(0),
    _dof_map(_system.dofMap())
{
}

MaxVarNDofsPerNode() [2/2]

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

Definition at line 27 of file MaxVarNDofsPerNode.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(x, split),
    _system(x._system),
    _max(0),
    _dof_map(x._dof_map)
{
}

~MaxVarNDofsPerNode()

MaxVarNDofsPerNode::~MaxVarNDofsPerNode ( )

virtual

Definition at line 35 of file MaxVarNDofsPerNode.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 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 MaxVarNDofsPerNode::join

(

const MaxVarNDofsPerNode &

y

)

Definition at line 49 of file MaxVarNDofsPerNode.C.

{
  _max = std::max(_max, y._max);
}

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

max()

dof_id_type MaxVarNDofsPerNode::max ( )

inline

Definition at line 32 of file MaxVarNDofsPerNode.h.

{ return _max; }

Referenced by FEProblemBase::initialSetup().

onNode() [1/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.

{
}

onNode() [2/2]

void MaxVarNDofsPerNode::onNode ( ConstNodeRange::const_iterator &  node_it )

overridevirtual

Definition at line 38 of file MaxVarNDofsPerNode.C.

{
  for (unsigned int var = 0; var < _system.nVariables(); var++)
  {
    _dof_map.dof_indices(*node_it, _dof_indices, var);
 
    _max = std::max(_max, _dof_indices.size());
  }
}

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.

{}

Member Data Documentation

_dof_indices

std::vector<dof_id_type> MaxVarNDofsPerNode::_dof_indices

protected

Reusable storage.

Definition at line 45 of file MaxVarNDofsPerNode.h.

Referenced by onNode().

_dof_map

const DofMap& MaxVarNDofsPerNode::_dof_map

protected

DOF map.

Definition at line 42 of file MaxVarNDofsPerNode.h.

Referenced by onNode().

_fe_problem

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

protectedinherited

Definition at line 72 of file ThreadedNodeLoop.h.

_max

size_t MaxVarNDofsPerNode::_max

protected

Maximum number of dofs for any one variable on any one node.

Definition at line 39 of file MaxVarNDofsPerNode.h.

Referenced by join(), max(), and onNode().

_system

SolverSystem& MaxVarNDofsPerNode::_system

protected

The nonlinear system.

Definition at line 36 of file MaxVarNDofsPerNode.h.

Referenced by onNode().

_tid

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

protectedinherited

Definition at line 73 of file ThreadedNodeLoop.h.

---

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

• include/base/MaxVarNDofsPerNode.h
• src/base/MaxVarNDofsPerNode.C