ComputeNodalDampingThread Class Reference

#include <ComputeNodalDampingThread.h>

Inheritance diagram for ComputeNodalDampingThread:

Public Member Functions
	ComputeNodalDampingThread (FEProblemBase &feproblem, NonlinearSystemBase &nl)
	ComputeNodalDampingThread (ComputeNodalDampingThread &x, Threads::split split)
virtual	~ComputeNodalDampingThread ()
virtual void	onNode (ConstNodeRange::const_iterator &node_it) override
void	join (const ComputeNodalDampingThread &y)
Real	damping ()
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
void	printGeneralExecutionInformation () const override
	Print information about the loop, mostly order of execution of objects.

Protected Attributes
Real	_damping
NonlinearSystemBase &	_nl
const MooseObjectWarehouse< NodalDamper > &	_nodal_dampers
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Detailed Description

Definition at line 23 of file ComputeNodalDampingThread.h.

Constructor & Destructor Documentation

ComputeNodalDampingThread() [1/2]

ComputeNodalDampingThread::ComputeNodalDampingThread	(	FEProblemBase &	feproblem,
		NonlinearSystemBase &	nl
	)

Definition at line 18 of file ComputeNodalDampingThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(feproblem),
    _damping(1.0),
    _nl(nl),
    _nodal_dampers(_nl.getNodalDamperWarehouse())
{
}

ComputeNodalDampingThread() [2/2]

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

Definition at line 28 of file ComputeNodalDampingThread.C.

  : ThreadedNodeLoop<ConstNodeRange, ConstNodeRange::const_iterator>(x, split),
    _damping(1.0),
    _nl(x._nl),
    _nodal_dampers(x._nodal_dampers)
{
}

~ComputeNodalDampingThread()

ComputeNodalDampingThread::~ComputeNodalDampingThread ( )

virtual

Definition at line 37 of file ComputeNodalDampingThread.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);
  };

damping()

Real ComputeNodalDampingThread::damping

(

)

Definition at line 68 of file ComputeNodalDampingThread.C.

{
  return _damping;
}

Referenced by NonlinearSystemBase::computeDamping().

join()

void ComputeNodalDampingThread::join

(

const ComputeNodalDampingThread &

y

)

Definition at line 74 of file ComputeNodalDampingThread.C.

{
  if (y._damping < _damping)
    _damping = y._damping;
}

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

{
}

onNode() [2/2]

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

overridevirtual

Definition at line 40 of file ComputeNodalDampingThread.C.

{
  const Node * node = *node_it;
  _fe_problem.reinitNode(node, _tid);
 
  std::set<MooseVariable *> damped_vars;
 
  const auto & ndampers = _nodal_dampers.getActiveObjects(_tid);
  for (const auto & damper : ndampers)
    if (damper->variableDefinedOnNode(node))
      damped_vars.insert(damper->getVariable());
 
  if (!damped_vars.empty())
    _nl.reinitIncrementAtNodeForDampers(_tid, damped_vars);
 
  for (const auto & damper : ndampers)
  {
    if (!damper->variableDefinedOnNode(node))
      continue;
 
    Real cur_damping = damper->computeDamping();
    damper->checkMinDamping(cur_damping);
    if (cur_damping < _damping)
      _damping = cur_damping;
  }
}

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

void ComputeNodalDampingThread::printGeneralExecutionInformation ( ) const

overrideprotectedvirtual

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

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

Definition at line 81 of file ComputeNodalDampingThread.C.

{
  const auto & damper_wh = _nl.getNodalDamperWarehouse();
  if (!_fe_problem.shouldPrintExecution(_tid) || !damper_wh.hasActiveObjects())
    return;
 
  const auto & console = _fe_problem.console();
  const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
  console << "[DBG] Executing nodal dampers on " << execute_on << std::endl;
  console << "[DBG] Ordering of the dampers on the blocks they are defined on:" << std::endl;
  // TODO Check that all objects are active at this point
  console << damper_wh.activeObjectsToFormattedString() << std::endl;
}

Member Data Documentation

_damping

Real ComputeNodalDampingThread::_damping

protected

Definition at line 44 of file ComputeNodalDampingThread.h.

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

_fe_problem

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

protectedinherited

Definition at line 72 of file ThreadedNodeLoop.h.

_nl

NonlinearSystemBase& ComputeNodalDampingThread::_nl

protected

Definition at line 45 of file ComputeNodalDampingThread.h.

Referenced by onNode(), and printGeneralExecutionInformation().

_nodal_dampers

const MooseObjectWarehouse<NodalDamper>& ComputeNodalDampingThread::_nodal_dampers

protected

Definition at line 46 of file ComputeNodalDampingThread.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/loops/ComputeNodalDampingThread.h
• src/loops/ComputeNodalDampingThread.C