ComputeNodalDampingThread Class Reference

#include <ComputeNodalDampingThread.h>

Inheritance diagram for ComputeNodalDampingThread:

Public Member Functions
	ComputeNodalDampingThread (FEProblemBase &feproblem)
	ComputeNodalDampingThread (ComputeNodalDampingThread &x, Threads::split split)
virtual	~ComputeNodalDampingThread ()
virtual void	onNode (ConstNodeRange::const_iterator &node_it) override
	Called for each node. More...
void	join (const ComputeNodalDampingThread &y)
Real	damping ()
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
Real	_damping
NonlinearSystemBase &	_nl
const MooseObjectWarehouse< NodalDamper > &	_nodal_dampers
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Detailed Description

Definition at line 24 of file ComputeNodalDampingThread.h.

Constructor & Destructor Documentation

ComputeNodalDampingThread() [1/2]

ComputeNodalDampingThread::ComputeNodalDampingThread

(

FEProblemBase &

feproblem

)

Definition at line 18 of file ComputeNodalDampingThread.C.

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

ComputeNodalDampingThread() [2/2]

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

Definition at line 27 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 36 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 55 of file ThreadedNodeLoop.h.

  {
    std::string what(e.what());
    _fe_problem.setException(what);
  };

damping()

Real ComputeNodalDampingThread::damping

(

)

Definition at line 63 of file ComputeNodalDampingThread.C.

Referenced by NonlinearSystemBase::computeDamping().

{
  return _damping;
}

join()

void ComputeNodalDampingThread::join

(

const ComputeNodalDampingThread &

y

)

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

{ return !_fe_problem.hasException(); }

onNode()

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

overridevirtual

Called for each node.

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

Definition at line 39 of file ComputeNodalDampingThread.C.

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

  std::set<MooseVariable *> damped_vars;

  const auto & ndampers = _nl.getNodalDamperWarehouse().getActiveObjects(_tid);
  for (const auto & damper : ndampers)
    damped_vars.insert(damper->getVariable());

  _nl.reinitIncrementAtNodeForDampers(_tid, damped_vars);

  const auto & objects = _nodal_dampers.getActiveObjects(_tid);
  for (const auto & obj : objects)
  {
    Real cur_damping = obj->computeDamping();
    obj->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 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.

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

_damping

Real ComputeNodalDampingThread::_damping

protected

Definition at line 42 of file ComputeNodalDampingThread.h.

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

_fe_problem

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

protectedinherited

Definition at line 69 of file ThreadedNodeLoop.h.

Referenced by ComputeNodalUserObjectsThread::onNode(), ComputeNodalAuxVarsThread::onNode(), onNode(), ComputeNodalAuxVarsThread::post(), and ComputeNodalAuxVarsThread::subdomainChanged().

_nl

NonlinearSystemBase& ComputeNodalDampingThread::_nl

protected

Definition at line 43 of file ComputeNodalDampingThread.h.

Referenced by onNode().

_nodal_dampers

const MooseObjectWarehouse<NodalDamper>& ComputeNodalDampingThread::_nodal_dampers

protected

Definition at line 44 of file ComputeNodalDampingThread.h.

Referenced by onNode().

_tid

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

protectedinherited

Definition at line 70 of file ThreadedNodeLoop.h.

Referenced by ComputeNodalUserObjectsThread::onNode(), ComputeNodalAuxVarsThread::onNode(), onNode(), ComputeNodalKernelsThread::onNode(), ComputeNodalKernelJacobiansThread::onNode(), ComputeNodalAuxVarsThread::post(), ComputeNodalKernelsThread::pre(), ComputeNodalKernelJacobiansThread::pre(), and ComputeNodalAuxVarsThread::subdomainChanged().

---

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

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