www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
ThreadedElementLoopBase< RangeType > Class Template Reference

Base class for assembly-like calculations. More...

#include <ThreadedElementLoopBase.h>

Inheritance diagram for ThreadedElementLoopBase< RangeType >:
[legend]

Public Member Functions

 ThreadedElementLoopBase (MooseMesh &mesh)
 
 ThreadedElementLoopBase (ThreadedElementLoopBase &x, Threads::split split)
 
virtual ~ThreadedElementLoopBase ()
 
void operator() (const RangeType &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 onElement (const Elem *elem)
 Assembly of the element (not including surface assembly) More...
 
virtual void preElement (const Elem *elem)
 Called before the element assembly. 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 preInternalSide (const Elem *elem, unsigned int side)
 Called before evaluations on an element internal side. 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...
 
virtual void neighborSubdomainChanged ()
 Called every time the neighbor subdomain changes (i.e. More...
 
virtual void caughtMooseException (MooseException &)
 Called if a MooseException is caught anywhere during the computation. More...
 
virtual bool keepGoing ()
 Whether or not the loop should continue. More...
 

Protected Attributes

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

template<typename RangeType>
class ThreadedElementLoopBase< RangeType >

Base class for assembly-like calculations.

Definition at line 22 of file ThreadedElementLoopBase.h.

Constructor & Destructor Documentation

◆ ThreadedElementLoopBase() [1/2]

template<typename RangeType >
ThreadedElementLoopBase< RangeType >::ThreadedElementLoopBase ( MooseMesh mesh)

Definition at line 153 of file ThreadedElementLoopBase.h.

153  : _mesh(mesh)
154 {
155 }

◆ ThreadedElementLoopBase() [2/2]

template<typename RangeType >
ThreadedElementLoopBase< RangeType >::ThreadedElementLoopBase ( ThreadedElementLoopBase< RangeType > &  x,
Threads::split  split 
)

Definition at line 158 of file ThreadedElementLoopBase.h.

160  : _mesh(x._mesh)
161 {
162 }
static PetscErrorCode Vec x

◆ ~ThreadedElementLoopBase()

template<typename RangeType >
ThreadedElementLoopBase< RangeType >::~ThreadedElementLoopBase ( )
virtual

Definition at line 165 of file ThreadedElementLoopBase.h.

166 {
167 }

Member Function Documentation

◆ caughtMooseException()

template<typename RangeType>
virtual void ThreadedElementLoopBase< RangeType >::caughtMooseException ( MooseException )
inlinevirtual

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 126 of file ThreadedElementLoopBase.h.

126 {};

◆ keepGoing()

template<typename RangeType>
virtual bool ThreadedElementLoopBase< RangeType >::keepGoing ( )
inlinevirtual

Whether or not the loop should continue.

Returns
true to keep going, false to stop.

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 133 of file ThreadedElementLoopBase.h.

133 { return true; }

◆ neighborSubdomainChanged()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::neighborSubdomainChanged ( )
virtual

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 in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 314 of file ThreadedElementLoopBase.h.

315 {
316 }

◆ onBoundary()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::onBoundary ( const Elem *  elem,
unsigned int  side,
BoundaryID  bnd_id 
)
virtual

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 ComputeUserObjectsThread, ProjectMaterialProperties, ComputeMaterialsObjectThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 274 of file ThreadedElementLoopBase.h.

277 {
278 }

◆ onElement()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::onElement ( const Elem *  elem)
virtual

◆ onInterface()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::onInterface ( const Elem *  elem,
unsigned int  side,
BoundaryID  bnd_id 
)
virtual

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 ComputeResidualThread, and ComputeJacobianThread.

Definition at line 300 of file ThreadedElementLoopBase.h.

303 {
304 }

◆ onInternalSide()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::onInternalSide ( const Elem *  elem,
unsigned int  side 
)
virtual

Called when doing internal edge assembling.

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

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

Definition at line 294 of file ThreadedElementLoopBase.h.

295 {
296 }

◆ operator()()

template<typename RangeType>
void ThreadedElementLoopBase< RangeType >::operator() ( const RangeType &  range,
bool  bypass_threading = false 
)

Definition at line 171 of file ThreadedElementLoopBase.h.

172 {
173  try
174  {
175  ParallelUniqueId puid;
176  _tid = bypass_threading ? 0 : puid.id;
177 
178  pre();
179 
182  typename RangeType::const_iterator el = range.begin();
183  for (el = range.begin(); el != range.end(); ++el)
184  {
185  if (!keepGoing())
186  break;
187 
188  const Elem * elem = *el;
189 
190  preElement(elem);
191 
193  _subdomain = elem->subdomain_id();
194  if (_subdomain != _old_subdomain)
196 
197  onElement(elem);
198 
199  for (unsigned int side = 0; side < elem->n_sides(); side++)
200  {
201  std::vector<BoundaryID> boundary_ids = _mesh.getBoundaryIDs(elem, side);
202 
203  if (boundary_ids.size() > 0)
204  for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
205  it != boundary_ids.end();
206  ++it)
207  onBoundary(elem, side, *it);
208 
209  const Elem * neighbor = elem->neighbor_ptr(side);
210  if (neighbor != nullptr)
211  {
212  preInternalSide(elem, side);
213 
215  _neighbor_subdomain = neighbor->subdomain_id();
218 
219  onInternalSide(elem, side);
220 
221  if (boundary_ids.size() > 0)
222  for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
223  it != boundary_ids.end();
224  ++it)
225  onInterface(elem, side, *it);
226 
227  postInternalSide(elem, side);
228  }
229  } // sides
230  postElement(elem);
231 
232  } // range
233 
234  post();
235  }
236  catch (MooseException & e)
237  {
239  }
240 }
virtual bool keepGoing()
Whether or not the loop should continue.
virtual void onElement(const Elem *elem)
Assembly of the element (not including surface assembly)
virtual void pre()
Called before the element range loop.
virtual void subdomainChanged()
Called every time the current subdomain changes (i.e.
virtual void neighborSubdomainChanged()
Called every time the neighbor subdomain changes (i.e.
virtual void preInternalSide(const Elem *elem, unsigned int side)
Called before evaluations on an element internal side.
virtual void postInternalSide(const Elem *elem, unsigned int side)
Called after evaluations on an element internal side.
const SubdomainID INVALID_BLOCK_ID
Definition: MooseTypes.h:329
virtual void postElement(const Elem *elem)
Called after the element assembly is done (including surface assembling)
virtual void onInterface(const Elem *elem, unsigned int side, BoundaryID bnd_id)
Called when doing interface assembling.
SubdomainID _old_neighbor_subdomain
The subdomain for the last neighbor.
virtual void onInternalSide(const Elem *elem, unsigned int side)
Called when doing internal edge assembling.
Provides a way for users to bail out of the current solve.
virtual void caughtMooseException(MooseException &)
Called if a MooseException is caught anywhere during the computation.
std::vector< BoundaryID > getBoundaryIDs(const Elem *const elem, const unsigned short int side) const
Returns a vector of boundary IDs for the requested element on the requested side. ...
Definition: MooseMesh.C:2105
SubdomainID _subdomain
The subdomain for the current element.
SubdomainID _old_subdomain
The subdomain for the last element.
virtual void post()
Called after the element range loop.
virtual void preElement(const Elem *elem)
Called before the element assembly.
SubdomainID _neighbor_subdomain
The subdomain for the current neighbor.
virtual void onBoundary(const Elem *elem, unsigned int side, BoundaryID bnd_id)
Called when doing boundary assembling.

◆ post()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::post ( )
virtual

◆ postElement()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::postElement ( const Elem *  elem)
virtual

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

Parameters
elem- active element

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

Definition at line 268 of file ThreadedElementLoopBase.h.

269 {
270 }

◆ postInternalSide()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::postInternalSide ( const Elem *  elem,
unsigned int  side 
)
virtual

Called after evaluations on an element internal side.

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

Definition at line 288 of file ThreadedElementLoopBase.h.

289 {
290 }

◆ pre()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::pre ( )
virtual

Called before the element range loop.

Reimplemented in ComputeDiracThread.

Definition at line 244 of file ThreadedElementLoopBase.h.

245 {
246 }

◆ preElement()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::preElement ( const Elem *  elem)
virtual

Called before the element assembly.

Parameters
elem- active element

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 262 of file ThreadedElementLoopBase.h.

263 {
264 }

◆ preInternalSide()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::preInternalSide ( const Elem *  elem,
unsigned int  side 
)
virtual

Called before evaluations on an element internal side.

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

Reimplemented in ThreadedElementLoop< RangeType >, ThreadedElementLoop< ConstElemRange >, ThreadedElementLoop< DistElemRange >, and ThreadedElementLoop< ConstElemPointerRange >.

Definition at line 282 of file ThreadedElementLoopBase.h.

283 {
284 }

◆ subdomainChanged()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::subdomainChanged ( )
virtual

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, ProjectMaterialProperties, ComputeMaterialsObjectThread, ComputeDiracThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, ComputeElemAuxVarsThread, and ComputeMarkerThread.

Definition at line 308 of file ThreadedElementLoopBase.h.

309 {
310 }

Member Data Documentation

◆ _mesh

template<typename RangeType>
MooseMesh& ThreadedElementLoopBase< RangeType >::_mesh
protected

Definition at line 136 of file ThreadedElementLoopBase.h.

◆ _neighbor_subdomain

template<typename RangeType>
SubdomainID ThreadedElementLoopBase< RangeType >::_neighbor_subdomain
protected

The subdomain for the current neighbor.

Definition at line 146 of file ThreadedElementLoopBase.h.

◆ _old_neighbor_subdomain

template<typename RangeType>
SubdomainID ThreadedElementLoopBase< RangeType >::_old_neighbor_subdomain
protected

The subdomain for the last neighbor.

Definition at line 149 of file ThreadedElementLoopBase.h.

◆ _old_subdomain

template<typename RangeType>
SubdomainID ThreadedElementLoopBase< RangeType >::_old_subdomain
protected

The subdomain for the last element.

Definition at line 143 of file ThreadedElementLoopBase.h.

◆ _subdomain

template<typename RangeType>
SubdomainID ThreadedElementLoopBase< RangeType >::_subdomain
protected

The subdomain for the current element.

Definition at line 140 of file ThreadedElementLoopBase.h.

◆ _tid

template<typename RangeType>
THREAD_ID ThreadedElementLoopBase< RangeType >::_tid
protected

Definition at line 137 of file ThreadedElementLoopBase.h.


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