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

#include <ComputeDiracThread.h>

Inheritance diagram for ComputeDiracThread:
[legend]

Public Member Functions

 ComputeDiracThread (FEProblemBase &feproblem, const std::set< TagID > &tags, bool _is_jacobian)
 
 ComputeDiracThread (ComputeDiracThread &x, Threads::split)
 
virtual ~ComputeDiracThread ()
 
virtual void subdomainChanged () override
 Called every time the current subdomain changes (i.e. More...
 
virtual void pre () override
 Called before the element range loop. More...
 
virtual void onElement (const Elem *elem) override
 Assembly of the element (not including surface assembly) More...
 
virtual void postElement (const Elem *) override
 Called after the element assembly is done (including surface assembling) More...
 
virtual void post () override
 Called after the element range loop. More...
 
void join (const ComputeDiracThread &)
 
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 preBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override
 Called before the boundary assembly. More...
 
virtual void neighborSubdomainChanged () override
 Called every time the neighbor subdomain changes (i.e. More...
 
virtual void operator() (const DistElemRange &range, bool bypass_threading=false)
 
virtual void onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr)
 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...
 

Protected Member Functions

void printGeneralExecutionInformation () const override
 Output a message indicating execution on this execution flag. More...
 
void printBlockExecutionInformation () const override
 Output the order of execution of objects within the current subdomain. More...
 
void printExecutionOrdering (const std::vector< T * > &objs, const bool print_header=true, const std::string &line_prefix="[DBG]") const
 Routine to output the ordering of objects within a vector of pointers to these objects. More...
 
void printExecutionOrdering (const std::vector< std::shared_ptr< T >> &objs_ptrs, const bool print_header=true, const std::string &line_prefix="[DBG]") const
 
virtual void printBoundaryExecutionInformation (const unsigned int) const
 Print information about the particular ordering of objects on each boundary. More...
 
void resetExecPrintedSets () const
 Resets the set of blocks and boundaries visited. More...
 

Protected Attributes

bool _is_jacobian
 
NonlinearSystemBase_nl
 
const std::set< TagID > & _tags
 
MooseObjectTagWarehouse< DiracKernelBase > & _dirac_kernels
 Storage for DiracKernel objects. More...
 
MooseObjectWarehouse< DiracKernelBase > * _dirac_warehouse
 
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...
 
std::set< SubdomainID_blocks_exec_printed
 Keep track of which blocks were visited. More...
 
std::set< BoundaryID_boundaries_exec_printed
 Keep track of which boundaries were visited. More...
 

Detailed Description

Definition at line 27 of file ComputeDiracThread.h.

Constructor & Destructor Documentation

◆ ComputeDiracThread() [1/2]

ComputeDiracThread::ComputeDiracThread ( FEProblemBase feproblem,
const std::set< TagID > &  tags,
bool  _is_jacobian 
)

Definition at line 23 of file ComputeDiracThread.C.

27  _is_jacobian(is_jacobian),
28  _nl(feproblem.currentNonlinearSystem()),
29  _tags(tags),
31 {
32 }
MooseObjectTagWarehouse< DiracKernelBase > & _dirac_kernels
Storage for DiracKernel objects.
const std::set< TagID > & _tags
NonlinearSystemBase & currentNonlinearSystem()
NonlinearSystemBase & _nl
MooseObjectTagWarehouse< DiracKernelBase > & getDiracKernelWarehouse()

◆ ComputeDiracThread() [2/2]

ComputeDiracThread::ComputeDiracThread ( ComputeDiracThread x,
Threads::split  split 
)

Definition at line 35 of file ComputeDiracThread.C.

37  _is_jacobian(x._is_jacobian),
38  _nl(x._nl),
39  _tags(x._tags),
40  _dirac_kernels(x._dirac_kernels)
41 {
42 }
MooseObjectTagWarehouse< DiracKernelBase > & _dirac_kernels
Storage for DiracKernel objects.
const std::set< TagID > & _tags
NonlinearSystemBase & _nl
tbb::split split

◆ ~ComputeDiracThread()

ComputeDiracThread::~ComputeDiracThread ( )
virtual

Definition at line 44 of file ComputeDiracThread.C.

44 {}

Member Function Documentation

◆ caughtMooseException()

void ThreadedElementLoop< DistElemRange >::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< DistElemRange >.

Definition at line 101 of file ThreadedElementLoop.h.

102 {
103  Threads::spin_mutex::scoped_lock lock(threaded_element_mutex);
104 
105  std::string what(e.what());
107 }
virtual const char * what() const
Get out the error message.
virtual void setException(const std::string &message)
Set an exception, which is stored at this point by toggling a member variable in this class...
static Threads::spin_mutex threaded_element_mutex
This mutex is used by all derived classes of the ThreadedElementLoop.

◆ join()

void ComputeDiracThread::join ( const ComputeDiracThread )

Definition at line 166 of file ComputeDiracThread.C.

167 {
168 }

◆ keepGoing()

virtual bool ThreadedElementLoop< DistElemRange >::keepGoing ( )
inlineoverridevirtualinherited

Whether or not the loop should continue.

Returns
true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 44 of file ThreadedElementLoop.h.

44 { return !_fe_problem.hasException(); }
virtual bool hasException()
Whether or not an exception has occurred.

◆ neighborSubdomainChanged()

void ThreadedElementLoop< DistElemRange >::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< DistElemRange >.

Definition at line 135 of file ThreadedElementLoop.h.

136 {
139 }
Base class for assembly-like calculations.
virtual void neighborSubdomainSetup(SubdomainID subdomain, const THREAD_ID tid)

◆ onBoundary()

void ThreadedElementLoopBase< DistElemRange >::onBoundary ( const Elem *  elem,
unsigned int  side,
BoundaryID  bnd_id,
const Elem *  lower_d_elem = nullptr 
)
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
lower_d_elem- Lower dimensional element (e.g. Mortar)

Definition at line 357 of file ThreadedElementLoopBase.h.

361 {
362 }

◆ onElement()

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

Assembly of the element (not including surface assembly)

Parameters
elem- active element

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 85 of file ComputeDiracThread.C.

86 {
87  const bool has_dirac_kernels_on_elem = _fe_problem.reinitDirac(elem, _tid);
88  if (!has_dirac_kernels_on_elem)
89  return;
90 
91  std::set<MooseVariableFEBase *> needed_moose_vars;
92  const auto & dkernels = _dirac_warehouse->getActiveObjects(_tid);
93 
94  // Only call reinitMaterials() if one or more DiracKernels has
95  // actually called getMaterialProperty(). Loop over all the
96  // DiracKernels and check whether this is the case.
97  for (const auto & dirac_kernel : dkernels)
98  {
99  // If any of the DiracKernels have had getMaterialProperty()
100  // called, we need to reinit Materials.
101  if (dirac_kernel->getMaterialPropertyCalled())
102  {
103  _fe_problem.reinitMaterials(_subdomain, _tid, /*swap_stateful=*/false);
104  break;
105  }
106  }
107 
108  for (const auto & dirac_kernel : dkernels)
109  {
110  if (!dirac_kernel->hasPointsOnElem(elem))
111  continue;
112  else if (!_is_jacobian)
113  {
114  dirac_kernel->computeResidual();
115  continue;
116  }
117 
118  // Get a list of coupled variables from the SubProblem
119  const auto & coupling_entries =
120  dirac_kernel->subProblem().assembly(_tid, _nl.number()).couplingEntries();
121 
122  // Loop over the list of coupled variable pairs
123  for (const auto & it : coupling_entries)
124  {
125  const MooseVariableFEBase * const ivariable = it.first;
126  const MooseVariableFEBase * const jvariable = it.second;
127 
128  // A variant of the check that is in
129  // ComputeFullJacobianThread::computeJacobian(). We
130  // only want to call computeOffDiagJacobian() if both
131  // variables are active on this subdomain, and the
132  // off-diagonal variable actually has dofs.
133  if (dirac_kernel->variable().number() == ivariable->number() &&
134  ivariable->activeOnSubdomain(_subdomain) && jvariable->activeOnSubdomain(_subdomain) &&
135  (jvariable->numberOfDofs() > 0))
136  {
137  dirac_kernel->prepareShapes(jvariable->number());
138  dirac_kernel->computeOffDiagJacobian(jvariable->number());
139  }
140  }
141  }
142 
143  // Note that we do not call swapBackMaterials() here as they were
144  // never swapped in the first place. This avoids messing up
145  // stored values of stateful material properties.
146 }
virtual unsigned int numberOfDofs() const
Get the number of local DoFs.
unsigned int number() const
Get variable number coming from libMesh.
This class provides an interface for common operations on field variables of both FE and FV types wit...
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...
unsigned int number() const
Gets the number of this system.
Definition: SystemBase.C:1132
NonlinearSystemBase & _nl
virtual bool reinitDirac(const Elem *elem, const THREAD_ID tid) override
Returns true if the Problem has Dirac kernels it needs to compute on elem.
MooseObjectWarehouse< DiracKernelBase > * _dirac_warehouse
void reinitMaterials(SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true)
bool activeOnSubdomain(SubdomainID subdomain) const
Is the variable active on the subdomain?
SubdomainID _subdomain
The subdomain for the current element.

◆ onInterface()

void ThreadedElementLoopBase< DistElemRange >::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

Definition at line 384 of file ThreadedElementLoopBase.h.

387 {
388 }

◆ onInternalSide()

void ThreadedElementLoopBase< DistElemRange >::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'

Definition at line 378 of file ThreadedElementLoopBase.h.

379 {
380 }

◆ operator()()

void ThreadedElementLoopBase< DistElemRange >::operator() ( const DistElemRange range,
bool  bypass_threading = false 
)
virtualinherited

Definition at line 216 of file ThreadedElementLoopBase.h.

217 {
218  try
219  {
220  try
221  {
222  ParallelUniqueId puid;
223  _tid = bypass_threading ? 0 : puid.id;
224 
225  pre();
227 
230  typename RangeType::const_iterator el = range.begin();
231  for (el = range.begin(); el != range.end(); ++el)
232  {
233  if (!keepGoing())
234  break;
235 
236  const Elem * elem = *el;
237 
238  preElement(elem);
239 
241  _subdomain = elem->subdomain_id();
242  if (_subdomain != _old_subdomain)
243  {
246  }
247 
248  onElement(elem);
249 
250  if (elem->subdomain_id() == Moose::INTERNAL_SIDE_LOWERD_ID ||
251  elem->subdomain_id() == Moose::BOUNDARY_SIDE_LOWERD_ID)
252  {
253  postElement(elem);
254  continue;
255  }
256 
257  for (unsigned int side = 0; side < elem->n_sides(); side++)
258  {
259  std::vector<BoundaryID> boundary_ids = _mesh.getBoundaryIDs(elem, side);
260  const Elem * lower_d_elem = _mesh.getLowerDElem(elem, side);
261 
262  if (boundary_ids.size() > 0)
263  for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
264  it != boundary_ids.end();
265  ++it)
266  {
267  preBoundary(elem, side, *it, lower_d_elem);
269  onBoundary(elem, side, *it, lower_d_elem);
270  }
271 
272  const Elem * neighbor = elem->neighbor_ptr(side);
273  if (neighbor)
274  {
275  preInternalSide(elem, side);
276 
278  _neighbor_subdomain = neighbor->subdomain_id();
281 
282  if (shouldComputeInternalSide(*elem, *neighbor))
283  onInternalSide(elem, side);
284 
285  if (boundary_ids.size() > 0)
286  for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
287  it != boundary_ids.end();
288  ++it)
289  onInterface(elem, side, *it);
290 
291  postInternalSide(elem, side);
292  }
293  } // sides
294 
295  postElement(elem);
296  } // range
297 
298  post();
300  }
301  catch (libMesh::LogicError & e)
302  {
303  mooseException("We caught a libMesh error in ThreadedElementLoopBase:", e.what());
304  }
305  catch (MetaPhysicL::LogicError & e)
306  {
308  }
309  }
310  catch (MooseException & e)
311  {
313  }
314 }
virtual bool keepGoing()
Whether or not the loop should continue.
void resetExecPrintedSets() const
Resets the set of blocks and boundaries visited.
virtual bool shouldComputeInternalSide(const Elem &elem, const Elem &neighbor) const
Whether to compute the internal side for the provided element-neighbor pair.
virtual void onElement(const Elem *elem)
Assembly of the element (not including surface assembly)
void translateMetaPhysicLError(const MetaPhysicL::LogicError &)
emit a relatively clear error message when we catch a MetaPhysicL logic error
Definition: MooseError.C:110
virtual void printBoundaryExecutionInformation(const unsigned int) const
Print information about the particular ordering of objects on each boundary.
virtual void pre()
Called before the element range loop.
const Elem * getLowerDElem(const Elem *, unsigned short int) const
Returns a const pointer to a lower dimensional element that corresponds to a side of a higher dimensi...
Definition: MooseMesh.C:1484
const SubdomainID BOUNDARY_SIDE_LOWERD_ID
Definition: MooseTypes.C:21
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.C:22
virtual void onBoundary(const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr)
Called when doing boundary assembling.
virtual void postElement(const Elem *elem)
Called after the element assembly is done (including surface assembling)
virtual void printGeneralExecutionInformation() const
Print information about the loop ordering.
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.
const SubdomainID INTERNAL_SIDE_LOWERD_ID
Definition: MooseTypes.C:20
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:2720
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 printBlockExecutionInformation() const
Print information about the particular ordering of objects on each block.
virtual void preElement(const Elem *elem)
Called before the element assembly.
virtual void preBoundary(const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr)
Called before the boundary assembly.
SubdomainID _neighbor_subdomain
The subdomain for the current neighbor.

◆ post()

void ComputeDiracThread::post ( )
overridevirtual

Called after the element range loop.

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 159 of file ComputeDiracThread.C.

160 {
163 }
void clearActiveMaterialProperties(const THREAD_ID tid)
Clear the active material properties.
virtual void clearActiveElementalMooseVariables(const THREAD_ID tid) override
Clear the active elemental MooseVariableFEBase.

◆ postElement()

void ComputeDiracThread::postElement ( const Elem *  elem)
overridevirtual

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

Parameters
elem- active element

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 149 of file ComputeDiracThread.C.

150 {
151  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
152  if (!_is_jacobian)
154  else
156 }
virtual void addJacobian(const THREAD_ID tid) override
virtual void addResidual(const THREAD_ID tid) override

◆ postInternalSide()

void ThreadedElementLoopBase< DistElemRange >::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'

Definition at line 372 of file ThreadedElementLoopBase.h.

373 {
374 }

◆ pre()

void ComputeDiracThread::pre ( )
overridevirtual

Called before the element range loop.

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 47 of file ComputeDiracThread.C.

48 {
49  // Force TID=0 because we run this object _NON THREADED_
50  // Take this out if we ever get Dirac's working with threads!
51  _tid = 0;
52 }

◆ preBoundary()

void ThreadedElementLoop< DistElemRange >::preBoundary ( const Elem *  elem,
unsigned int  side,
BoundaryID  bnd_id,
const Elem *  lower_d_elem = nullptr 
)
overridevirtualinherited

Called before the boundary assembly.

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
lower_d_elem- Lower dimensional element (e.g. Mortar)

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 125 of file ThreadedElementLoop.h.

129 {
131 }
virtual void setCurrentBoundaryID(BoundaryID bid, const THREAD_ID tid) override
sets the current boundary ID in assembly
Base class for assembly-like calculations.

◆ preElement()

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

Called before the element assembly.

Parameters
elem- active element

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 111 of file ThreadedElementLoop.h.

112 {
114 }
virtual void setCurrentSubdomainID(const Elem *elem, const THREAD_ID tid) override
Base class for assembly-like calculations.

◆ preInternalSide()

void ThreadedElementLoop< DistElemRange >::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< DistElemRange >.

Definition at line 118 of file ThreadedElementLoop.h.

119 {
121 }
Base class for assembly-like calculations.
virtual void setNeighborSubdomainID(const Elem *elem, unsigned int side, const THREAD_ID tid) override

◆ printBlockExecutionInformation()

void ComputeDiracThread::printBlockExecutionInformation ( ) const
overrideprotectedvirtual

Output the order of execution of objects within the current subdomain.

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 181 of file ComputeDiracThread.C.

182 {
185  return;
186 
187  const auto & dkernels = _dirac_warehouse->getActiveBlockObjects(_subdomain, _tid);
188  const auto & console = _fe_problem.console();
189  console << "[DBG] Ordering of DiracKernels on subdomain " << _subdomain << std::endl;
190  printExecutionOrdering<DiracKernelBase>(dkernels, false);
192 }
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
bool shouldPrintExecution(const THREAD_ID tid) const
Check whether the problem should output execution orders at this time.
std::set< SubdomainID > _blocks_exec_printed
Keep track of which blocks were visited.
const ConsoleStream & console() const
Return console handle.
Definition: Problem.h:48
MooseObjectWarehouse< DiracKernelBase > * _dirac_warehouse
SubdomainID _subdomain
The subdomain for the current element.

◆ printBoundaryExecutionInformation()

virtual void ThreadedElementLoopBase< DistElemRange >::printBoundaryExecutionInformation ( const unsigned  int) const
inlineprotectedvirtualinherited

Print information about the particular ordering of objects on each boundary.

Definition at line 176 of file ThreadedElementLoopBase.h.

176 {}

◆ printExecutionOrdering() [1/2]

void ThreadedElementLoop< DistElemRange >::printExecutionOrdering ( const std::vector< T *> &  objs,
const bool  print_header = true,
const std::string &  line_prefix = "[DBG]" 
) const
protectedinherited

Routine to output the ordering of objects within a vector of pointers to these objects.

These objects must implement the name() routine, and it must return a string or compatible type.

Template Parameters
Tthe object type
Parameters
objsthe vector with all the objects (should be pointers)
objects_typethe name of the type of objects. Defaults to the CPP object name
print_headerwhether to print a header about the timing of execution and the type of objects

Definition at line 144 of file ThreadedElementLoop.h.

147 {
148  if (!objs.size())
149  return;
150 
151  auto & console = _fe_problem.console();
152  const auto objects_type = MooseUtils::prettyCppType(objs[0]);
153  std::vector<MooseObject *> moose_objs;
154  for (auto obj_ptr : objs)
155  moose_objs.push_back(dynamic_cast<MooseObject *>(obj_ptr));
156  const auto names = ConsoleUtils::mooseObjectVectorToString(moose_objs);
157 
158  // Print string with a DBG prefix and with sufficient line breaks
159  std::string message = print_header ? "Executing " + objects_type + " on " +
161  : "";
162  message += (print_header ? "Order of execution:\n" : "") + names;
163  console << ConsoleUtils::formatString(message, line_prefix) << std::endl;
164 }
std::string mooseObjectVectorToString(const std::vector< MooseObject *> &objs, const std::string &sep=" ")
Routine to output the name of MooseObjects in a string.
Definition: ConsoleUtils.C:452
const std::string & name() const
Definition: MooseEnumItem.h:35
const ExecFlagType & getCurrentExecuteOnFlag() const
Return/set the current execution flag.
std::string formatString(std::string message, const std::string &prefix)
Add new lines and prefixes to a string for pretty display in output NOTE: This makes a copy of the st...
Definition: ConsoleUtils.C:436
const ConsoleStream & console() const
Return console handle.
Definition: Problem.h:48
std::string prettyCppType(const std::string &cpp_type)
Definition: MooseUtils.C:1235

◆ printExecutionOrdering() [2/2]

void ThreadedElementLoop< DistElemRange >::printExecutionOrdering ( const std::vector< std::shared_ptr< T >> &  objs_ptrs,
const bool  print_header = true,
const std::string &  line_prefix = "[DBG]" 
) const
protectedinherited

Definition at line 169 of file ThreadedElementLoop.h.

173 {
174  std::vector<T *> regular_ptrs;
175  for (auto shared_ptr : objs_ptrs)
176  regular_ptrs.push_back(shared_ptr.get());
177  printExecutionOrdering<T>(regular_ptrs, print_header, line_prefix);
178 }

◆ printGeneralExecutionInformation()

void ComputeDiracThread::printGeneralExecutionInformation ( ) const
overrideprotectedvirtual

Output a message indicating execution on this execution flag.

Reimplemented from ThreadedElementLoopBase< DistElemRange >.

Definition at line 171 of file ComputeDiracThread.C.

172 {
174  return;
175  const auto & console = _fe_problem.console();
176  console << "[DBG] Executing Dirac Kernels on " << _fe_problem.getCurrentExecuteOnFlag().name()
177  << std::endl;
178 }
const std::string & name() const
Definition: MooseEnumItem.h:35
const ExecFlagType & getCurrentExecuteOnFlag() const
Return/set the current execution flag.
bool shouldPrintExecution(const THREAD_ID tid) const
Check whether the problem should output execution orders at this time.
const ConsoleStream & console() const
Return console handle.
Definition: Problem.h:48

◆ resetExecPrintedSets()

void ThreadedElementLoopBase< DistElemRange >::resetExecPrintedSets ( ) const
protectedinherited

Resets the set of blocks and boundaries visited.

Definition at line 429 of file ThreadedElementLoopBase.h.

430 {
431  _blocks_exec_printed.clear();
432  _boundaries_exec_printed.clear();
433 }
std::set< SubdomainID > _blocks_exec_printed
Keep track of which blocks were visited.
std::set< BoundaryID > _boundaries_exec_printed
Keep track of which boundaries were visited.

◆ subdomainChanged()

void ComputeDiracThread::subdomainChanged ( )
overridevirtual

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 from ThreadedElementLoopBase< DistElemRange >.

Definition at line 55 of file ComputeDiracThread.C.

56 {
58 
59  std::set<MooseVariableFEBase *> needed_moose_vars;
60  _dirac_kernels.updateVariableDependency(needed_moose_vars, _tid);
61 
62  // Update material dependencies
63  std::unordered_set<unsigned int> needed_mat_props;
64  _dirac_kernels.updateMatPropDependency(needed_mat_props, _tid);
65 
67  _fe_problem.setActiveMaterialProperties(needed_mat_props, _tid);
68 
69  // If users pass a empty vector or a full size of vector,
70  // we take all kernels
71  if (!_tags.size() || _tags.size() == _fe_problem.numMatrixTags())
73  // If we have one tag only, We call tag based storage
74  else if (_tags.size() == 1)
78  // This one may be expensive, and hopefully we do not use it so often
79  else
82 }
void updateVariableDependency(std::set< MooseVariableFieldBase *> &needed_moose_vars, THREAD_ID tid=0) const
Update variable dependency vector.
void setActiveMaterialProperties(const std::unordered_set< unsigned int > &mat_prop_ids, const THREAD_ID tid)
Record and set the material properties required by the current computing thread.
MooseObjectWarehouse< T > & getVectorTagsObjectWarehouse(const std::set< TagID > &tags, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object at least has one of the given vector ta...
MooseObjectTagWarehouse< DiracKernelBase > & _dirac_kernels
Storage for DiracKernel objects.
virtual void setActiveElementalMooseVariables(const std::set< MooseVariableFEBase *> &moose_vars, const THREAD_ID tid) override
Set the MOOSE variables to be reinited on each element.
const std::set< TagID > & _tags
MooseObjectWarehouse< T > & getMatrixTagObjectWarehouse(TagID tag_id, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object has the given matrix tag...
void updateMatPropDependency(std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
Update material property dependency vector.
virtual unsigned int numMatrixTags() const
The total number of tags.
Definition: SubProblem.h:220
MooseObjectWarehouse< DiracKernelBase > * _dirac_warehouse
virtual void subdomainSetup(SubdomainID subdomain, const THREAD_ID tid)
MooseObjectWarehouse< T > & getMatrixTagsObjectWarehouse(const std::set< TagID > &tags, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object has one of the given matrix tags...
MooseObjectWarehouse< T > & getVectorTagObjectWarehouse(TagID tag_id, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object has the given vector tag...
SubdomainID _subdomain
The subdomain for the current element.

Member Data Documentation

◆ _blocks_exec_printed

std::set<SubdomainID> ThreadedElementLoopBase< DistElemRange >::_blocks_exec_printed
mutableprotectedinherited

Keep track of which blocks were visited.

Definition at line 179 of file ThreadedElementLoopBase.h.

Referenced by printBlockExecutionInformation().

◆ _boundaries_exec_printed

std::set<BoundaryID> ThreadedElementLoopBase< DistElemRange >::_boundaries_exec_printed
mutableprotectedinherited

Keep track of which boundaries were visited.

Definition at line 182 of file ThreadedElementLoopBase.h.

◆ _dirac_kernels

MooseObjectTagWarehouse<DiracKernelBase>& ComputeDiracThread::_dirac_kernels
protected

Storage for DiracKernel objects.

Definition at line 58 of file ComputeDiracThread.h.

Referenced by subdomainChanged().

◆ _dirac_warehouse

MooseObjectWarehouse<DiracKernelBase>* ComputeDiracThread::_dirac_warehouse
protected

◆ _fe_problem

FEProblemBase& ThreadedElementLoop< DistElemRange >::_fe_problem
protectedinherited

◆ _is_jacobian

bool ComputeDiracThread::_is_jacobian
protected

Definition at line 52 of file ComputeDiracThread.h.

Referenced by onElement(), postElement(), and subdomainChanged().

◆ _mesh

MooseMesh& ThreadedElementLoopBase< DistElemRange >::_mesh
protectedinherited

Definition at line 154 of file ThreadedElementLoopBase.h.

◆ _neighbor_subdomain

SubdomainID ThreadedElementLoopBase< DistElemRange >::_neighbor_subdomain
protectedinherited

The subdomain for the current neighbor.

Definition at line 164 of file ThreadedElementLoopBase.h.

◆ _nl

NonlinearSystemBase& ComputeDiracThread::_nl
protected

Definition at line 53 of file ComputeDiracThread.h.

Referenced by onElement().

◆ _old_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< DistElemRange >::_old_neighbor_subdomain
protectedinherited

The subdomain for the last neighbor.

Definition at line 167 of file ThreadedElementLoopBase.h.

◆ _old_subdomain

SubdomainID ThreadedElementLoopBase< DistElemRange >::_old_subdomain
protectedinherited

The subdomain for the last element.

Definition at line 161 of file ThreadedElementLoopBase.h.

◆ _subdomain

SubdomainID ThreadedElementLoopBase< DistElemRange >::_subdomain
protectedinherited

The subdomain for the current element.

Definition at line 158 of file ThreadedElementLoopBase.h.

Referenced by onElement(), printBlockExecutionInformation(), and subdomainChanged().

◆ _tags

const std::set<TagID>& ComputeDiracThread::_tags
protected

Definition at line 55 of file ComputeDiracThread.h.

Referenced by subdomainChanged().

◆ _tid

THREAD_ID ThreadedElementLoopBase< DistElemRange >::_tid
protectedinherited

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