ComputeNodalKernelJacobiansThread Class Reference

#include <ComputeNodalKernelJacobiansThread.h>

Inheritance diagram for ComputeNodalKernelJacobiansThread:

Public Member Functions
	ComputeNodalKernelJacobiansThread (FEProblemBase &fe_problem, NonlinearSystemBase &nl, MooseObjectTagWarehouse< NodalKernelBase > &nodal_kernels, const std::set< TagID > &tags)
	ComputeNodalKernelJacobiansThread (ComputeNodalKernelJacobiansThread &x, Threads::split split)
virtual void	pre () override
	Called before the node range loop. More...
virtual void	onNode (ConstNodeRange::const_iterator &node_it) override
void	join (const ComputeNodalKernelJacobiansThread &)
void	operator() (const ConstNodeRange &range)
virtual void	post ()
	Called after the node range loop. More...
virtual void	onNode (ConstNodeRange::const_iterator &node_it)
	Called for each node. 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 Member Functions
void	printGeneralExecutionInformation () const override
	Print information about the loop, mostly order of execution of objects. More...

Protected Attributes
FEProblemBase &	_fe_problem
NonlinearSystemBase &	_nl
AuxiliarySystem &	_aux_sys
const std::set< TagID > &	_tags
MooseObjectTagWarehouse< NodalKernelBase > &	_nodal_kernels
MooseObjectWarehouse< NodalKernelBase > *	_nkernel_warehouse
unsigned int	_num_cached
	Number of contributions cached up. More...
THREAD_ID	_tid

Detailed Description

Definition at line 30 of file ComputeNodalKernelJacobiansThread.h.

Constructor & Destructor Documentation

ComputeNodalKernelJacobiansThread() [1/2]

ComputeNodalKernelJacobiansThread::ComputeNodalKernelJacobiansThread	(	FEProblemBase &	fe_problem,
		NonlinearSystemBase &	nl,
		MooseObjectTagWarehouse< NodalKernelBase > &	nodal_kernels,
		const std::set< TagID > &	tags
	)

Definition at line 23 of file ComputeNodalKernelJacobiansThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(fe_problem),
    _fe_problem(fe_problem),
    _nl(nl),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _tags(tags),
    _nodal_kernels(nodal_kernels),
    _num_cached(0)
{
}

ComputeNodalKernelJacobiansThread() [2/2]

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

Definition at line 39 of file ComputeNodalKernelJacobiansThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(x, split),
    _fe_problem(x._fe_problem),
    _nl(x._nl),
    _aux_sys(x._aux_sys),
    _tags(x._tags),
    _nodal_kernels(x._nodal_kernels),
    _num_cached(0)
{
}

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

(

const ComputeNodalKernelJacobiansThread &

)

Definition at line 143 of file ComputeNodalKernelJacobiansThread.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 69 of file ThreadedNodeLoop.h.

{ return !_fe_problem.hasException(); }

onNode() [1/2]

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

virtualinherited

Called for each node.

Definition at line 136 of file ThreadedNodeLoop.h.

{
}

onNode() [2/2]

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

overridevirtual

Definition at line 65 of file ComputeNodalKernelJacobiansThread.C.

{
  const Node * node = *node_it;

  auto & ce = _fe_problem.couplingEntries(_tid, _nl.number());
  for (const auto & it : ce)
  {
    MooseVariableFEBase & ivariable = *(it.first);
    MooseVariableFEBase & jvariable = *(it.second);

    unsigned int ivar = ivariable.number();
    unsigned int jvar = jvariable.number();

    // The NodalKernels that are active and are coupled to the jvar in question
    std::vector<std::shared_ptr<NodalKernelBase>> active_involved_kernels;

    const auto & block_ids = _aux_sys.mesh().getNodeBlockIds(*node);
    for (const auto & block : block_ids)
    {
      if (_nkernel_warehouse->hasActiveBlockObjects(block, _tid))
      {
        // Loop over each NodalKernel to see if it's involved with the jvar
        const auto & objects = _nkernel_warehouse->getActiveBlockObjects(block, _tid);
        for (const auto & nodal_kernel : objects)
        {
          if (nodal_kernel->variable().number() == ivar)
          {
            // If this NodalKernel is acting on the jvar add it to the list and short-circuit the
            // loop
            if (nodal_kernel->variable().number() == jvar)
            {
              active_involved_kernels.push_back(nodal_kernel);
              continue;
            }

            // See if this NodalKernel is coupled to the jvar
            const std::vector<MooseVariableFEBase *> & coupled_vars =
                nodal_kernel->getCoupledMooseVars();
            for (const auto & var : coupled_vars)
              if (var->number() == jvar)
              {
                active_involved_kernels.push_back(nodal_kernel);
                break; // It only takes one
              }
          }
        }
      }
    }

    // Did we find any NodalKernels coupled to this jvar?
    if (!active_involved_kernels.empty())
    {
      // prepare variables
      for (auto * var : _aux_sys._nodal_vars[_tid])
        var->prepareAux();

      _fe_problem.reinitNode(node, _tid);

      for (const auto & nodal_kernel : active_involved_kernels)
      {
        nodal_kernel->setSubdomains(block_ids);
        nodal_kernel->computeOffDiagJacobian(jvar);
      }

      _num_cached++;

      if (_num_cached == 20) // Cache 20 nodes worth before adding into the residual
      {
        _num_cached = 0;
        // vectors are thread-safe, but matrices are not yet
        Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
        _fe_problem.addCachedJacobian(_tid);
      }
    }
  }
}

operator()()

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::operator() ( const ConstNodeRange &  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< ConstNodeRange , ConstNodeRange::const_iterator >::post ( )

virtualinherited

Called after the node range loop.

Reimplemented in ComputeNodalAuxVarsThread< AuxKernelType >.

Definition at line 130 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 142 of file ThreadedNodeLoop.h.

{
}

pre()

void ComputeNodalKernelJacobiansThread::pre ( )

overridevirtual

Called before the node range loop.

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

Definition at line 52 of file ComputeNodalKernelJacobiansThread.C.

{
  _num_cached = 0;

  if (!_tags.size() || _tags.size() == _fe_problem.numMatrixTags())
    _nkernel_warehouse = &_nodal_kernels;
  else if (_tags.size() == 1)
    _nkernel_warehouse = &(_nodal_kernels.getMatrixTagObjectWarehouse(*(_tags.begin()), _tid));
  else
    _nkernel_warehouse = &(_nodal_kernels.getMatrixTagsObjectWarehouse(_tags, _tid));
}

printGeneralExecutionInformation()

void ComputeNodalKernelJacobiansThread::printGeneralExecutionInformation ( ) const

overrideprotectedvirtual

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

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

Definition at line 148 of file ComputeNodalKernelJacobiansThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid) || !_nkernel_warehouse->hasActiveObjects())
    return;

  const auto & console = _fe_problem.console();
  const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
  console << "[DBG] Executing nodal kernels contribution to Jacobian on nodes on " << execute_on
          << std::endl;
  console << _nkernel_warehouse->activeObjectsToFormattedString() << std::endl;
}

Member Data Documentation

_aux_sys

AuxiliarySystem& ComputeNodalKernelJacobiansThread::_aux_sys

protected

Definition at line 54 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode().

_fe_problem

FEProblemBase& ComputeNodalKernelJacobiansThread::_fe_problem

protected

Definition at line 52 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode(), pre(), and printGeneralExecutionInformation().

_nkernel_warehouse

MooseObjectWarehouse<NodalKernelBase>* ComputeNodalKernelJacobiansThread::_nkernel_warehouse

protected

Definition at line 60 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode(), pre(), and printGeneralExecutionInformation().

_nl

NonlinearSystemBase& ComputeNodalKernelJacobiansThread::_nl

protected

Definition at line 53 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode().

_nodal_kernels

MooseObjectTagWarehouse<NodalKernelBase>& ComputeNodalKernelJacobiansThread::_nodal_kernels

protected

Definition at line 58 of file ComputeNodalKernelJacobiansThread.h.

Referenced by pre().

_num_cached

unsigned int ComputeNodalKernelJacobiansThread::_num_cached

protected

Number of contributions cached up.

Definition at line 63 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode(), and pre().

_tags

const std::set<TagID>& ComputeNodalKernelJacobiansThread::_tags

protected

Definition at line 56 of file ComputeNodalKernelJacobiansThread.h.

Referenced by pre().

_tid

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

protectedinherited

Definition at line 73 of file ThreadedNodeLoop.h.

Referenced by ComputeNodalUserObjectsThread::onNode(), ComputeNodalDampingThread::onNode(), ComputeNodalKernelsThread::onNode(), onNode(), ComputeNodalKernelsThread::pre(), pre(), ComputeNodalUserObjectsThread::printGeneralExecutionInformation(), ComputeNodalKernelsThread::printGeneralExecutionInformation(), ComputeNodalDampingThread::printGeneralExecutionInformation(), printGeneralExecutionInformation(), and ComputeNodalUserObjectsThread::subdomainChanged().

---

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

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