www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
ComputeElemDampingThread Class Reference

#include <ComputeElemDampingThread.h>

Inheritance diagram for ComputeElemDampingThread:
[legend]

Public Member Functions

 ComputeElemDampingThread (FEProblemBase &feproblem)
 
 ComputeElemDampingThread (ComputeElemDampingThread &x, Threads::split split)
 
virtual ~ComputeElemDampingThread ()
 
virtual void onElement (const Elem *elem) override
 Assembly of the element (not including surface assembly) More...
 
void join (const ComputeElemDampingThread &y)
 
Real damping ()
 
virtual void caughtMooseException (MooseException &e) override
 Called if a MooseException is caught anywhere during the computation. More...
 
virtual bool keepGoing () override
 Whether or not the loop should continue. More...
 
virtual void preElement (const Elem *elem) override
 Called before the element assembly. More...
 
virtual void preInternalSide (const Elem *elem, unsigned int side) override
 Called before evaluations on an element internal side. More...
 
virtual void neighborSubdomainChanged () override
 Called every time the neighbor subdomain changes (i.e. More...
 
void operator() (const ConstElemRange &range, bool bypass_threading=false)
 
virtual void pre ()
 Called before the element range loop. More...
 
virtual void post ()
 Called after the element range loop. More...
 
virtual void postElement (const Elem *elem)
 Called after the element assembly is done (including surface assembling) More...
 
virtual void onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id)
 Called when doing boundary assembling. More...
 
virtual void postInternalSide (const Elem *elem, unsigned int side)
 Called after evaluations on an element internal side. More...
 
virtual void onInternalSide (const Elem *elem, unsigned int side)
 Called when doing internal edge assembling. More...
 
virtual void onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id)
 Called when doing interface assembling. More...
 
virtual void subdomainChanged ()
 Called every time the current subdomain changes (i.e. More...
 

Protected Attributes

Real _damping
 
NonlinearSystemBase_nl
 
const MooseObjectWarehouse< ElementDamper > & _element_dampers
 
FEProblemBase_fe_problem
 
MooseMesh_mesh
 
THREAD_ID _tid
 
SubdomainID _subdomain
 The subdomain for the current element. More...
 
SubdomainID _old_subdomain
 The subdomain for the last element. More...
 
SubdomainID _neighbor_subdomain
 The subdomain for the current neighbor. More...
 
SubdomainID _old_neighbor_subdomain
 The subdomain for the last neighbor. More...
 

Detailed Description

Definition at line 29 of file ComputeElemDampingThread.h.

Constructor & Destructor Documentation

ComputeElemDampingThread::ComputeElemDampingThread ( FEProblemBase feproblem)

Definition at line 24 of file ComputeElemDampingThread.C.

26  _damping(1.0),
27  _nl(feproblem.getNonlinearSystemBase()),
29 {
30 }
const MooseObjectWarehouse< ElementDamper > & _element_dampers
NonlinearSystemBase & getNonlinearSystemBase()
const MooseObjectWarehouse< ElementDamper > & getElementDamperWarehouse()
ComputeElemDampingThread::ComputeElemDampingThread ( ComputeElemDampingThread x,
Threads::split  split 
)

Definition at line 33 of file ComputeElemDampingThread.C.

36  _damping(1.0),
37  _nl(x._nl),
38  _element_dampers(x._element_dampers)
39 {
40 }
const MooseObjectWarehouse< ElementDamper > & _element_dampers
static PetscErrorCode Vec x
ComputeElemDampingThread::~ComputeElemDampingThread ( )
virtual

Definition at line 42 of file ComputeElemDampingThread.C.

42 {}

Member Function Documentation

virtual void ThreadedElementLoop< ConstElemRange >::caughtMooseException ( MooseException e)
overridevirtualinherited

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Real ComputeElemDampingThread::damping ( )

Definition at line 71 of file ComputeElemDampingThread.C.

Referenced by NonlinearSystemBase::computeDamping().

72 {
73  return _damping;
74 }
void ComputeElemDampingThread::join ( const ComputeElemDampingThread y)

Definition at line 77 of file ComputeElemDampingThread.C.

78 {
79  if (y._damping < _damping)
80  _damping = y._damping;
81 }
virtual bool ThreadedElementLoop< ConstElemRange >::keepGoing ( )
inlineoverridevirtualinherited

Whether or not the loop should continue.

Returns
true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 50 of file ThreadedElementLoop.h.

50 { return !_fe_problem.hasException(); }
virtual bool hasException()
Whether or not an exception has occurred.
virtual void ThreadedElementLoop< ConstElemRange >::neighborSubdomainChanged ( )
overridevirtualinherited

Called every time the neighbor subdomain changes (i.e.

the subdomain of this neighbor is not the same as the subdomain of the last neighbor). Beware of over-using this! You might think that you can do some expensive stuff in here and get away with it... but there are applications that have TONS of subdomains....

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

virtual void ThreadedElementLoopBase< ConstElemRange >::onBoundary ( const Elem *  elem,
unsigned int  side,
BoundaryID  bnd_id 
)
virtualinherited

Called when doing boundary assembling.

Parameters
elem- The element we are checking is on the boundary.
side- The side of the element in question.
bnd_id- ID of the boundary we are at

Reimplemented in ComputeMaterialsObjectThread, ComputeUserObjectsThread, ComputeIndicatorThread, ComputeJacobianThread, ComputeResidualThread, and ComputeMarkerThread.

void ComputeElemDampingThread::onElement ( const Elem *  elem)
overridevirtual

Assembly of the element (not including surface assembly)

Parameters
elem- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 45 of file ComputeElemDampingThread.C.

46 {
47  _fe_problem.prepare(elem, _tid);
49 
50  std::set<MooseVariable *> damped_vars;
51 
52  const std::vector<std::shared_ptr<ElementDamper>> & edampers =
54  for (const auto & damper : edampers)
55  damped_vars.insert(damper->getVariable());
56 
58 
59  const std::vector<std::shared_ptr<ElementDamper>> & objects =
61  for (const auto & obj : objects)
62  {
63  Real cur_damping = obj->computeDamping();
64  obj->checkMinDamping(cur_damping);
65  if (cur_damping < _damping)
66  _damping = cur_damping;
67  }
68 }
virtual void prepare(const Elem *elem, THREAD_ID tid) override
const MooseObjectWarehouse< ElementDamper > & _element_dampers
virtual void reinitElem(const Elem *elem, THREAD_ID tid) override
const MooseObjectWarehouse< ElementDamper > & getElementDamperWarehouse()
void reinitIncrementAtQpsForDampers(THREAD_ID tid, const std::set< MooseVariable * > &damped_vars)
Compute the incremental change in variables at QPs for dampers.
const std::vector< std::shared_ptr< T > > & getActiveObjects(THREAD_ID tid=0) const
Retrieve complete vector to the active all/block/boundary restricted objects for a given thread...
virtual void ThreadedElementLoopBase< ConstElemRange >::onInterface ( const Elem *  elem,
unsigned int  side,
BoundaryID  bnd_id 
)
virtualinherited

Called when doing interface assembling.

Parameters
elem- Element we are on
side- local side number of the element 'elem'
bnd_id- ID of the interface we are at

Reimplemented in ComputeJacobianThread, and ComputeResidualThread.

virtual void ThreadedElementLoopBase< ConstElemRange >::onInternalSide ( const Elem *  elem,
unsigned int  side 
)
virtualinherited

Called when doing internal edge assembling.

Parameters
elem- Element we are on
side- local side number of the element 'elem'

Reimplemented in ComputeMaterialsObjectThread, ComputeUserObjectsThread, ComputeIndicatorThread, ComputeJacobianThread, ComputeResidualThread, and ComputeMarkerThread.

void ThreadedElementLoopBase< ConstElemRange >::operator() ( const ConstElemRange &  range,
bool  bypass_threading = false 
)
inherited
virtual void ThreadedElementLoopBase< ConstElemRange >::post ( )
virtualinherited
virtual void ThreadedElementLoopBase< ConstElemRange >::postElement ( const Elem *  elem)
virtualinherited

Called after the element assembly is done (including surface assembling)

Parameters
elem- active element

Reimplemented in ComputeJacobianBlocksThread, ComputeJacobianThread, ComputeIndicatorThread, ComputeResidualThread, and ComputeMarkerThread.

virtual void ThreadedElementLoopBase< ConstElemRange >::postInternalSide ( const Elem *  elem,
unsigned int  side 
)
virtualinherited

Called after evaluations on an element internal side.

Parameters
elem- Element we are on
side- local side number of the element 'elem'
virtual void ThreadedElementLoopBase< ConstElemRange >::pre ( )
virtualinherited

Called before the element range loop.

virtual void ThreadedElementLoop< ConstElemRange >::preElement ( const Elem *  elem)
overridevirtualinherited

Called before the element assembly.

Parameters
elem- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

virtual void ThreadedElementLoop< ConstElemRange >::preInternalSide ( const Elem *  elem,
unsigned int  side 
)
overridevirtualinherited

Called before evaluations on an element internal side.

Parameters
elem- Element we are on
side- local side number of the element 'elem'

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

virtual void ThreadedElementLoopBase< ConstElemRange >::subdomainChanged ( )
virtualinherited

Called every time the current subdomain changes (i.e.

the subdomain of this element is not the same as the subdomain of the last element). Beware of over-using this! You might think that you can do some expensive stuff in here and get away with it... but there are applications that have TONS of subdomains....

Reimplemented in ComputeUserObjectsThread, ComputeMaterialsObjectThread, ComputeIndicatorThread, ComputeJacobianThread, ComputeResidualThread, ComputeElemAuxVarsThread, and ComputeMarkerThread.

Member Data Documentation

Real ComputeElemDampingThread::_damping
protected

Definition at line 46 of file ComputeElemDampingThread.h.

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

const MooseObjectWarehouse<ElementDamper>& ComputeElemDampingThread::_element_dampers
protected

Definition at line 48 of file ComputeElemDampingThread.h.

Referenced by onElement().

FEProblemBase& ThreadedElementLoop< ConstElemRange >::_fe_problem
protectedinherited
MooseMesh& ThreadedElementLoopBase< ConstElemRange >::_mesh
protectedinherited

Definition at line 141 of file ThreadedElementLoopBase.h.

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_neighbor_subdomain
protectedinherited

The subdomain for the current neighbor.

Definition at line 151 of file ThreadedElementLoopBase.h.

NonlinearSystemBase& ComputeElemDampingThread::_nl
protected

Definition at line 47 of file ComputeElemDampingThread.h.

Referenced by onElement().

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_neighbor_subdomain
protectedinherited

The subdomain for the last neighbor.

Definition at line 154 of file ThreadedElementLoopBase.h.

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_subdomain
protectedinherited

The subdomain for the last element.

Definition at line 148 of file ThreadedElementLoopBase.h.

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_subdomain
protectedinherited
THREAD_ID ThreadedElementLoopBase< ConstElemRange >::_tid
protectedinherited

Definition at line 142 of file ThreadedElementLoopBase.h.

Referenced by ComputeFullJacobianThread::computeFaceJacobian(), ComputeJacobianThread::computeFaceJacobian(), ComputeFullJacobianThread::computeInternalFaceJacobian(), ComputeJacobianThread::computeInternalFaceJacobian(), ComputeFullJacobianThread::computeInternalInterFaceJacobian(), ComputeJacobianThread::computeInternalInterFaceJacobian(), ComputeFullJacobianThread::computeJacobian(), ComputeJacobianThread::computeJacobian(), ComputeResidualThread::onBoundary(), ComputeJacobianThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), ComputeMaterialsObjectThread::onBoundary(), ComputeMarkerThread::onElement(), onElement(), ComputeElemAuxVarsThread::onElement(), ComputeResidualThread::onElement(), ComputeJacobianThread::onElement(), ComputeIndicatorThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeResidualThread::onInterface(), ComputeJacobianThread::onInterface(), ComputeJacobianThread::onInternalSide(), ComputeResidualThread::onInternalSide(), ComputeIndicatorThread::onInternalSide(), ComputeUserObjectsThread::onInternalSide(), ComputeMaterialsObjectThread::onInternalSide(), ComputeMarkerThread::post(), ComputeElemAuxVarsThread::post(), ComputeMaterialsObjectThread::post(), ComputeResidualThread::post(), ComputeIndicatorThread::post(), ComputeJacobianThread::post(), ComputeUserObjectsThread::post(), ComputeResidualThread::postElement(), ComputeJacobianThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeMarkerThread::subdomainChanged(), ComputeElemAuxVarsThread::subdomainChanged(), ComputeResidualThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeJacobianThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().


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