https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FlagElementsThread Class Reference

#include <FlagElementsThread.h>

Inheritance diagram for FlagElementsThread:
[legend]

Public Member Functions

 FlagElementsThread (FEProblemBase &fe_problem, std::vector< Number > &serialized_solution, unsigned int max_h_level, const std::string &marker_name, bool is_serialized_solution)
 
 FlagElementsThread (FlagElementsThread &x, Threads::split split)
 
virtual void onElement (const Elem *elem) override
 Assembly of the element (not including surface assembly)
 
bool shouldComputeInternalSide (const Elem &, const Elem &) const override
 Whether to compute the internal side for the provided element-neighbor pair.
 
void join (const FlagElementsThread &)
 
virtual void caughtMooseException (MooseException &e) override
 Called if a MooseException is caught anywhere during the computation.
 
virtual bool keepGoing () override
 Whether or not the loop should continue.
 
virtual void preElement (const Elem *elem) override
 Called before the element assembly.
 
virtual void preInternalSide (const Elem *elem, unsigned int side) override
 Called before evaluations on an element internal side.
 
virtual void preBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override
 Called before the boundary assembly.
 
virtual void neighborSubdomainChanged () override
 Called every time the neighbor subdomain changes (i.e.
 
virtual void operator() (const RangeType &range, bool bypass_threading=false)
 
virtual void pre ()
 Called before the element range loop.
 
virtual void post ()
 Called after the element range loop.
 
virtual void postElement (const Elem *elem)
 Called after the element assembly is done (including surface assembling)
 
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 postInternalSide (const Elem *elem, unsigned int side)
 Called after evaluations on an element internal side.
 
virtual void onInternalSide (const Elem *elem, unsigned int side)
 Called when doing internal edge assembling.
 
virtual void onExternalSide (const Elem *elem, unsigned int side)
 Called when iterating over external sides (no side neighbor)
 
virtual void onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id)
 Called when doing interface assembling.
 
virtual void subdomainChanged ()
 Called every time the current subdomain changes (i.e.
 

Protected Member Functions

void prepareElement (const Elem *elem)
 
void clearVarsAndMaterials ()
 
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.
 
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 printGeneralExecutionInformation () const
 Print information about the loop ordering.
 
virtual void printBlockExecutionInformation () const
 Print information about the particular ordering of objects on each block.
 
virtual void printBoundaryExecutionInformation (const unsigned int) const
 Print information about the particular ordering of objects on each boundary.
 
void resetExecPrintedSets () const
 Resets the set of blocks and boundaries visited.
 

Protected Attributes

FEProblemBase_fe_problem
 
std::shared_ptr< DisplacedProblem_displaced_problem
 
AuxiliarySystem_aux_sys
 
unsigned int _system_number
 
Adaptivity_adaptivity
 
MooseVariableFEBase_field_var
 
unsigned int _field_var_number
 
std::vector< Number > & _serialized_solution
 
unsigned int _max_h_level
 
bool _is_serialized_solution
 
MooseMesh_mesh
 
THREAD_ID _tid
 
SubdomainID _subdomain
 The subdomain for the current element.
 
SubdomainID _old_subdomain
 The subdomain for the last element.
 
SubdomainID _neighbor_subdomain
 The subdomain for the current neighbor.
 
SubdomainID _old_neighbor_subdomain
 The subdomain for the last neighbor.
 
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.
 

Detailed Description

Definition at line 20 of file FlagElementsThread.h.

Constructor & Destructor Documentation

◆ FlagElementsThread() [1/2]

FlagElementsThread::FlagElementsThread ( FEProblemBase fe_problem,
std::vector< Number > &  serialized_solution,
unsigned int  max_h_level,
const std::string &  marker_name,
bool  is_serialized_solution 
)

Definition at line 25 of file FlagElementsThread.C.

31 _fe_problem(fe_problem),
33 _aux_sys(fe_problem.getAuxiliarySystem()),
39 _serialized_solution(serialized_solution),
40 _max_h_level(max_h_level),
41 _is_serialized_solution(is_serialized_solution)
42{
43}
AuxiliarySystem & getAuxiliarySystem()
virtual std::shared_ptr< const DisplacedProblem > getDisplacedProblem() const
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const override
Returns the variable reference for requested variable which must be of the expected_var_type (Nonline...
Adaptivity & adaptivity()
FEProblemBase & _fe_problem
MooseVariableFEBase & _field_var
unsigned int _system_number
std::vector< Number > & _serialized_solution
AuxiliarySystem & _aux_sys
unsigned int _field_var_number
std::shared_ptr< DisplacedProblem > _displaced_problem
unsigned int number() const
Get variable number coming from libMesh.
unsigned int number() const
Gets the number of this system.
Base class for assembly-like calculations.
@ VAR_FIELD_ANY
Definition MooseTypes.h:781
@ VAR_ANY
Definition MooseTypes.h:772

◆ FlagElementsThread() [2/2]

FlagElementsThread::FlagElementsThread ( FlagElementsThread x,
Threads::split  split 
)

Member Function Documentation

◆ caughtMooseException()

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< RangeType >.

Definition at line 43 of file ThreadedElementLoop.h.

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

◆ clearVarsAndMaterials()

void ThreadedElementLoop< ConstElemRange >::clearVarsAndMaterials ( )
protectedinherited

Definition at line 60 of file ThreadedElementLoop.h.

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

◆ join()

void FlagElementsThread::join ( const FlagElementsThread )

Definition at line 108 of file FlagElementsThread.C.

109{
110}

◆ keepGoing()

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

Whether or not the loop should continue.

Returns
true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 45 of file ThreadedElementLoop.h.

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

◆ neighborSubdomainChanged()

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< RangeType >.

Definition at line 56 of file ThreadedElementLoop.h.

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

◆ onBoundary()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::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)

Reimplemented in ComputeIndicatorThread, ComputeMarkerThread, ComputeMaterialsObjectThread, ComputeUserObjectsThread, NonlinearThread, and ProjectMaterialProperties.

Definition at line 371 of file ThreadedElementLoopBase.h.

375{
376}

◆ onElement()

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

Assembly of the element (not including surface assembly)

Parameters
elem- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 62 of file FlagElementsThread.C.

63{
64 mooseAssert(elem->active(), "This thread should only act on active elements");
65
66 // By default do nothing, and only grab the marker from the solution if the current variable is
67 // active
68 // on the element subdomain.
70 if (_field_var.activeOnSubdomain(elem->subdomain_id()))
71 {
72 dof_id_type dof_number = elem->dof_number(_system_number, _field_var_number, 0);
73
74 Number dof_value = 0.;
75 // If solution is serialized in the caller,
76 // we use the serialized solution
78 dof_value = _serialized_solution[dof_number];
79 else // Otherwise, we look at the ghosted local solution
80 {
81 // Local ghosted solution
82 auto & current_local_solution = *_aux_sys.currentSolution();
83 // Libesh will convert a global dof number to a local one,
84 // then return the corresponding entry value
85 dof_value = current_local_solution(dof_number);
86 }
87
88 // round() is a C99 function, it is not located in the std:: namespace.
89 marker_value = static_cast<Marker::MarkerValue>(round(dof_value));
90
91 // Make sure we aren't masking an issue in the Marker system by rounding its values.
92 if (std::abs(static_cast<int>(marker_value) - dof_value) > TOLERANCE * TOLERANCE)
93 mooseError("Invalid Marker value detected: ", dof_value);
94 }
95
96 // If no Markers cared about what happened to this element let's just leave it alone
97 if (marker_value == Marker::DONT_MARK)
98 marker_value = Marker::DO_NOTHING;
99
100 // Don't refine past the max level
101 if (_max_h_level && marker_value == Marker::REFINE && elem->level() >= _max_h_level)
102 marker_value = Marker::DO_NOTHING;
103
104 const_cast<Elem *>(elem)->set_refinement_flag((Elem::RefinementState)marker_value);
105}
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application.
Definition MooseError.h:311
const NumericVector< Number > *const & currentSolution() const override
The solution vector that is currently being operated on.
MarkerValue
This mirrors the main refinement flag values in libMesh in Elem::RefinementState but adds "dont_mark"...
Definition Marker.h:60
@ REFINE
Definition Marker.h:64
@ DO_NOTHING
Definition Marker.h:63
@ DONT_MARK
Definition Marker.h:61
bool activeOnSubdomain(SubdomainID subdomain) const
Is the variable active on the subdomain?
T round(T x)
Definition MathUtils.h:77
Real Number
uint8_t dof_id_type

◆ onExternalSide()

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

Called when iterating over external sides (no side neighbor)

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

Reimplemented in ComputeUserObjectsThread, and NonlinearThread.

Definition at line 398 of file ThreadedElementLoopBase.h.

399{
400}

◆ onInterface()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::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 ComputeMaterialsObjectThread, ComputeUserObjectsThread, and NonlinearThread.

Definition at line 404 of file ThreadedElementLoopBase.h.

407{
408}

◆ onInternalSide()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::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 ComputeIndicatorThread, ComputeMarkerThread, ComputeMaterialsObjectThread, ComputeUserObjectsThread, NonlinearThread, and ProjectMaterialProperties.

Definition at line 392 of file ThreadedElementLoopBase.h.

393{
394}

◆ operator()()

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

Definition at line 226 of file ThreadedElementLoopBase.h.

227{
228 try
229 {
230 try
231 {
232 ParallelUniqueId puid;
233 _tid = bypass_threading ? 0 : puid.id;
234
235 pre();
237
240 typename RangeType::const_iterator el = range.begin();
241 for (el = range.begin(); el != range.end(); ++el)
242 {
243 if (!keepGoing())
244 break;
245
246 const Elem * elem = *el;
247
248 preElement(elem);
249
251 _subdomain = elem->subdomain_id();
253 {
256 }
257
258 onElement(elem);
259
260 if (_mesh.interiorLowerDBlocks().count(elem->subdomain_id()) > 0 ||
261 _mesh.boundaryLowerDBlocks().count(elem->subdomain_id()) > 0)
262 {
263 postElement(elem);
264 continue;
265 }
266
267 const auto elem_boundary_ids = _mesh.getBoundaryIDs(elem);
268 for (unsigned int side = 0; side < elem->n_sides(); side++)
269 {
270 const auto & boundary_ids = elem_boundary_ids[side];
271 const Elem * lower_d_elem = _mesh.getLowerDElem(elem, side);
272
273 for (const auto bnd_id : boundary_ids)
274 {
275 preBoundary(elem, side, bnd_id, lower_d_elem);
277 onBoundary(elem, side, bnd_id, lower_d_elem);
278 }
279
280 const Elem * neighbor = elem->neighbor_ptr(side);
281 if (neighbor)
282 {
283 preInternalSide(elem, side);
284
286 _neighbor_subdomain = neighbor->subdomain_id();
289
290 if (shouldComputeInternalSide(*elem, *neighbor))
291 onInternalSide(elem, side);
292
293 for (const auto bnd_id : boundary_ids)
294 onInterface(elem, side, bnd_id);
295
296 postInternalSide(elem, side);
297 }
298 else
299 onExternalSide(elem, side);
300 } // sides
301
302 postElement(elem);
303 } // range
304
305 post();
307 }
308 catch (MetaPhysicL::LogicError & e)
309 {
311 }
312 catch (std::exception & e)
313 {
314 // Continue if we find a libMesh degenerate map exception, but
315 // just re-throw for any real error
316 if (!strstr(e.what(), "Jacobian") && !strstr(e.what(), "singular") &&
317 !strstr(e.what(), "det != 0"))
318 throw; // not "throw e;" - that destroys type info!
319
320 mooseException("We caught a libMesh degeneracy exception in ThreadedElementLoopBase:\n",
321 e.what());
322 }
323 }
324 catch (MooseException & e)
325 {
327 }
328}
Provides a way for users to bail out of the current solve.
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:1690
const std::set< SubdomainID > & interiorLowerDBlocks() const
Definition MooseMesh.h:1552
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:3027
const std::set< SubdomainID > & boundaryLowerDBlocks() const
Definition MooseMesh.h:1556
virtual void onExternalSide(const Elem *elem, unsigned int side)
Called when iterating over external sides (no side neighbor)
virtual void caughtMooseException(MooseException &)
Called if a MooseException is caught anywhere during the computation.
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 printBoundaryExecutionInformation(const unsigned int) const
Print information about the particular ordering of objects on each boundary.
virtual void neighborSubdomainChanged()
Called every time the neighbor subdomain changes (i.e.
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.
virtual bool keepGoing()
Whether or not the loop should continue.
void resetExecPrintedSets() const
Resets the set of blocks and boundaries visited.
SubdomainID _old_subdomain
The subdomain for the last element.
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.
virtual void subdomainChanged()
Called every time the current subdomain changes (i.e.
virtual void onInternalSide(const Elem *elem, unsigned int side)
Called when doing internal edge assembling.
virtual void preBoundary(const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr)
Called before the boundary assembly.
virtual void onElement(const Elem *elem)
Assembly of the element (not including surface assembly)
virtual void postElement(const Elem *elem)
Called after the element assembly is done (including surface assembling)
virtual void preElement(const Elem *elem)
Called before the element assembly.
SubdomainID _old_neighbor_subdomain
The subdomain for the last neighbor.
SubdomainID _subdomain
The subdomain for the current element.
SubdomainID _neighbor_subdomain
The subdomain for the current neighbor.
virtual void printBlockExecutionInformation() const
Print information about the particular ordering of objects on each block.
virtual void post()
Called after the element range loop.
virtual void pre()
Called before the element range loop.
virtual bool shouldComputeInternalSide(const Elem &elem, const Elem &neighbor) const
Whether to compute the internal side for the provided element-neighbor pair.
const SubdomainID INVALID_BLOCK_ID
Definition MooseTypes.C:20
void translateMetaPhysicLError(const MetaPhysicL::LogicError &)
emit a relatively clear error message when we catch a MetaPhysicL logic error
Definition MooseError.C:155

Referenced by NonlinearThread::operator()().

◆ post()

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

◆ postElement()

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

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

Parameters
elem- active element

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

Definition at line 356 of file ThreadedElementLoopBase.h.

357{
358}

◆ postInternalSide()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::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'

Reimplemented in ComputeJacobianBlocksThread.

Definition at line 386 of file ThreadedElementLoopBase.h.

387{
388}

◆ pre()

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

Called before the element range loop.

Reimplemented in ComputeDiracThread.

Definition at line 332 of file ThreadedElementLoopBase.h.

333{
334}

Referenced by ComputeJacobianForScalingThread::operator()().

◆ preBoundary()

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

Definition at line 51 of file ThreadedElementLoop.h.

133{
135}
virtual void setCurrentBoundaryID(BoundaryID bid, const THREAD_ID tid) override
sets the current boundary ID in assembly

◆ preElement()

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

Called before the element assembly.

Parameters
elem- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 47 of file ThreadedElementLoop.h.

116{
118}
virtual void setCurrentSubdomainID(const Elem *elem, const THREAD_ID tid) override

◆ preInternalSide()

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< RangeType >.

Definition at line 49 of file ThreadedElementLoop.h.

123{
125}
virtual void setNeighborSubdomainID(const Elem *elem, unsigned int side, const THREAD_ID tid) override

◆ prepareElement()

void ThreadedElementLoop< ConstElemRange >::prepareElement ( const Elem *  elem)
protectedinherited

Definition at line 59 of file ThreadedElementLoop.h.

187{
188 _fe_problem.prepare(elem, this->_tid);
189 _fe_problem.reinitElem(elem, this->_tid);
191}
virtual void reinitElem(const Elem *elem, const THREAD_ID tid) override
void reinitMaterials(SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true)
virtual void prepare(const Elem *elem, const THREAD_ID tid) override

◆ printBlockExecutionInformation()

template<typename RangeType >
virtual void ThreadedElementLoopBase< RangeType >::printBlockExecutionInformation ( ) const
inlineprotectedvirtualinherited

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

Reimplemented in ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeIndicatorThread, ComputeMarkerThread, ComputeUserObjectsThread, and NonlinearThread.

Definition at line 184 of file ThreadedElementLoopBase.h.

184{}

◆ printBoundaryExecutionInformation()

template<typename RangeType >
virtual void ThreadedElementLoopBase< RangeType >::printBoundaryExecutionInformation ( const unsigned int  ) const
inlineprotectedvirtualinherited

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

Reimplemented in NonlinearThread.

Definition at line 187 of file ThreadedElementLoopBase.h.

187{}

◆ printExecutionOrdering() [1/2]

void ThreadedElementLoop< ConstElemRange >::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 80 of file ThreadedElementLoop.h.

177{
178 std::vector<T *> regular_ptrs;
179 for (auto shared_ptr : objs_ptrs)
180 regular_ptrs.push_back(shared_ptr.get());
181 printExecutionOrdering<T>(regular_ptrs, print_header, line_prefix);
182}
const Elem & get(const ElemType type_in)

◆ printExecutionOrdering() [2/2]

void ThreadedElementLoop< ConstElemRange >::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 76 of file ThreadedElementLoop.h.

151{
152 if (!objs.size())
153 return;
154
155 auto & console = _fe_problem.console();
156 const auto objects_type = MooseUtils::prettyCppType(objs[0]);
157 std::vector<MooseObject *> moose_objs;
158 for (auto obj_ptr : objs)
159 moose_objs.push_back(dynamic_cast<MooseObject *>(obj_ptr));
160 const auto names = ConsoleUtils::mooseObjectVectorToString(moose_objs);
161
162 // Print string with a DBG prefix and with sufficient line breaks
163 std::string message = print_header ? "Executing " + objects_type + " on " +
165 : "";
166 message += (print_header ? "Order of execution:\n" : "") + names;
167 console << ConsoleUtils::formatString(message, line_prefix) << std::endl;
168}
const ExecFlagType & getCurrentExecuteOnFlag() const
Return/set the current execution flag.
const std::string & name() const
Every object that can be built by the factory should be derived from this class.
Definition MooseObject.h:31
const ConsoleStream & console() const
Return console handle.
Definition Problem.h:48
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...
std::string mooseObjectVectorToString(const std::vector< MooseObject * > &objs, const std::string &sep=" ")
Routine to output the name of MooseObjects in a string.
std::string prettyCppType(const std::string &cpp_type)

◆ printGeneralExecutionInformation()

template<typename RangeType >
virtual void ThreadedElementLoopBase< RangeType >::printGeneralExecutionInformation ( ) const
inlineprotectedvirtualinherited

◆ resetExecPrintedSets()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::resetExecPrintedSets ( ) const
protectedinherited

Resets the set of blocks and boundaries visited.

Definition at line 454 of file ThreadedElementLoopBase.h.

455{
456 _blocks_exec_printed.clear();
458}
std::set< BoundaryID > _boundaries_exec_printed
Keep track of which boundaries were visited.
std::set< SubdomainID > _blocks_exec_printed
Keep track of which blocks were visited.

◆ shouldComputeInternalSide()

bool FlagElementsThread::shouldComputeInternalSide ( const Elem &  elem,
const Elem &  neighbor 
) const
inlineoverridevirtual

Whether to compute the internal side for the provided element-neighbor pair.

Typically this will return true if the element id is less than the neighbor id when the elements are equal level, or when the element is more refined than the neighbor, and then false otherwise. One type of loop where the logic will be different is when projecting stateful material properties

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 36 of file FlagElementsThread.h.

36{ return false; }

◆ subdomainChanged()

template<typename RangeType >
void ThreadedElementLoopBase< RangeType >::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 ComputeDiracThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeIndicatorThread, ComputeMarkerThread, ComputeMaterialsObjectThread, ComputeUserObjectsThread, NonlinearThread, and ProjectMaterialProperties.

Definition at line 412 of file ThreadedElementLoopBase.h.

413{
414}

Member Data Documentation

◆ _adaptivity

Adaptivity& FlagElementsThread::_adaptivity
protected

Definition at line 45 of file FlagElementsThread.h.

◆ _aux_sys

AuxiliarySystem& FlagElementsThread::_aux_sys
protected

Definition at line 43 of file FlagElementsThread.h.

Referenced by onElement().

◆ _blocks_exec_printed

template<typename RangeType >
std::set<SubdomainID> ThreadedElementLoopBase< RangeType >::_blocks_exec_printed
mutableprotectedinherited

◆ _boundaries_exec_printed

template<typename RangeType >
std::set<BoundaryID> ThreadedElementLoopBase< RangeType >::_boundaries_exec_printed
mutableprotectedinherited

Keep track of which boundaries were visited.

Definition at line 193 of file ThreadedElementLoopBase.h.

Referenced by NonlinearThread::printBoundaryExecutionInformation().

◆ _displaced_problem

std::shared_ptr<DisplacedProblem> FlagElementsThread::_displaced_problem
protected

Definition at line 42 of file FlagElementsThread.h.

◆ _fe_problem

FEProblemBase& FlagElementsThread::_fe_problem
protected

Definition at line 41 of file FlagElementsThread.h.

◆ _field_var

MooseVariableFEBase& FlagElementsThread::_field_var
protected

Definition at line 46 of file FlagElementsThread.h.

Referenced by onElement().

◆ _field_var_number

unsigned int FlagElementsThread::_field_var_number
protected

Definition at line 47 of file FlagElementsThread.h.

Referenced by onElement().

◆ _is_serialized_solution

bool FlagElementsThread::_is_serialized_solution
protected

Definition at line 50 of file FlagElementsThread.h.

Referenced by onElement().

◆ _max_h_level

unsigned int FlagElementsThread::_max_h_level
protected

Definition at line 49 of file FlagElementsThread.h.

Referenced by onElement().

◆ _mesh

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

◆ _neighbor_subdomain

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

◆ _old_neighbor_subdomain

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

The subdomain for the last neighbor.

Definition at line 178 of file ThreadedElementLoopBase.h.

◆ _old_subdomain

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

The subdomain for the last element.

Definition at line 172 of file ThreadedElementLoopBase.h.

Referenced by ComputeJacobianForScalingThread::operator()().

◆ _serialized_solution

std::vector<Number>& FlagElementsThread::_serialized_solution
protected

Definition at line 48 of file FlagElementsThread.h.

Referenced by onElement().

◆ _subdomain

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

The subdomain for the current element.

Definition at line 169 of file ThreadedElementLoopBase.h.

Referenced by ComputeResidualAndJacobianThread::compute(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeResidualThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeResidualThread::determineObjectWarehouses(), ComputeMaterialsObjectThread::onBoundary(), ComputeDiracThread::onElement(), ComputeIndicatorThread::onElement(), ComputeMarkerThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeMaterialsObjectThread::onInterface(), ComputeMaterialsObjectThread::onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeJacobianBlocksThread::postInternalSide(), ComputeDiracThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeUserObjectsThread::printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), ComputeUserObjectsThread::querySubdomain(), ComputeDiracThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeMarkerThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), ComputeUserObjectsThread::subdomainChanged(), NonlinearThread::subdomainChanged(), and ProjectMaterialProperties::subdomainChanged().

◆ _system_number

unsigned int FlagElementsThread::_system_number
protected

Definition at line 44 of file FlagElementsThread.h.

Referenced by onElement().

◆ _tid

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

Definition at line 166 of file ThreadedElementLoopBase.h.

Referenced by ComputeResidualAndJacobianThread::accumulate(), ComputeResidualThread::accumulate(), ComputeJacobianThread::accumulateLower(), ComputeResidualAndJacobianThread::accumulateLower(), ComputeResidualThread::accumulateLower(), ComputeJacobianThread::accumulateNeighbor(), ComputeResidualAndJacobianThread::accumulateNeighbor(), ComputeResidualThread::accumulateNeighbor(), ComputeJacobianThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::accumulateNeighborLower(), ComputeResidualThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::compute(), NonlinearThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeResidualThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeResidualThread::determineObjectWarehouses(), ComputeMaterialsObjectThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), NonlinearThread::onBoundary(), ProjectMaterialProperties::onBoundary(), ComputeDiracThread::onElement(), ComputeElemDampingThread::onElement(), ComputeIndicatorThread::onElement(), ComputeMarkerThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), NonlinearThread::onElement(), ProjectMaterialProperties::onElement(), UpdateErrorVectorsThread::onElement(), NonlinearThread::onExternalSide(), ComputeMaterialsObjectThread::onInterface(), ComputeUserObjectsThread::onInterface(), NonlinearThread::onInterface(), ComputeIndicatorThread::onInternalSide(), ComputeMaterialsObjectThread::onInternalSide(), ComputeUserObjectsThread::onInternalSide(), NonlinearThread::onInternalSide(), ProjectMaterialProperties::onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeDiracThread::post(), ComputeIndicatorThread::post(), ComputeMarkerThread::post(), ComputeMaterialsObjectThread::post(), ComputeUserObjectsThread::post(), ComputeDiracThread::postElement(), ComputeJacobianThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeJacobianBlocksThread::postInternalSide(), ComputeDiracThread::pre(), NonlinearThread::prepareFace(), ComputeDiracThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeUserObjectsThread::printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), NonlinearThread::printBoundaryExecutionInformation(), ComputeDiracThread::printGeneralExecutionInformation(), ComputeElemDampingThread::printGeneralExecutionInformation(), ComputeIndicatorThread::printGeneralExecutionInformation(), ComputeMarkerThread::printGeneralExecutionInformation(), ComputeUserObjectsThread::printGeneralExecutionInformation(), NonlinearThread::printGeneralExecutionInformation(), ComputeUserObjectsThread::queryBoundary(), ComputeUserObjectsThread::querySubdomain(), ComputeDiracThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeMarkerThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), ComputeUserObjectsThread::subdomainChanged(), NonlinearThread::subdomainChanged(), and ProjectMaterialProperties::subdomainChanged().


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