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

#include <BoundaryNodeIntegrityCheckThread.h>

Inheritance diagram for BoundaryNodeIntegrityCheckThread:
[legend]

Public Member Functions

 BoundaryNodeIntegrityCheckThread (FEProblemBase &fe_problem, const TheWarehouse::Query &query)
 
 BoundaryNodeIntegrityCheckThread (BoundaryNodeIntegrityCheckThread &x, Threads::split split)
 
virtual void onNode (ConstBndNodeRange::const_iterator &node_it) override
 
void join (const BoundaryNodeIntegrityCheckThread &)
 
void operator() (const ConstBndNodeRange &range)
 
virtual void pre ()
 Called before the node range loop.
 
virtual void post ()
 Called after the node range loop.
 
virtual void onNode (ConstBndNodeRange::const_iterator &node_it)
 Called for each node.
 
virtual void postNode (ConstBndNodeRange::const_iterator &node_it)
 Called after the node assembly is done (including surface assembling)
 
virtual void caughtMooseException (MooseException &e)
 Called if a MooseException is caught anywhere during the computation.
 
virtual bool keepGoing ()
 Whether or not the loop should continue.
 

Protected Member Functions

virtual void printGeneralExecutionInformation () const
 Print information about the loop, mostly order of execution of objects.
 

Protected Attributes

const AuxiliarySystem_aux_sys
 The auxiliary system to whom we'll delegate the boundary variable dependency integrity check.
 
const ExecuteMooseObjectWarehouse< AuxKernel > & _nodal_aux
 Nodal auxiliary kernels acting on standard field variables.
 
const ExecuteMooseObjectWarehouse< VectorAuxKernel > & _nodal_vec_aux
 Nodal auxiliary kernels acting on vector field variables.
 
const ExecuteMooseObjectWarehouse< ArrayAuxKernel > & _nodal_array_aux
 Nodal auxiliary kernels acting on array field variables.
 
const TheWarehouse::Query_query
 A warehouse query that we will use to obtain user objects for boundary variable dependency integrity checks.
 
FEProblemBase_fe_problem
 
THREAD_ID _tid
 

Detailed Description

Definition at line 24 of file BoundaryNodeIntegrityCheckThread.h.

Constructor & Destructor Documentation

◆ BoundaryNodeIntegrityCheckThread() [1/2]

BoundaryNodeIntegrityCheckThread::BoundaryNodeIntegrityCheckThread ( FEProblemBase fe_problem,
const TheWarehouse::Query query 
)

Definition at line 26 of file BoundaryNodeIntegrityCheckThread.C.

29 _aux_sys(fe_problem.getAuxiliarySystem()),
33 _query(query)
34{
35}
const ExecuteMooseObjectWarehouse< VectorAuxKernel > & nodalVectorAuxWarehouse() const
const ExecuteMooseObjectWarehouse< AuxKernel > & nodalAuxWarehouse() const
const ExecuteMooseObjectWarehouse< ArrayAuxKernel > & nodalArrayAuxWarehouse() const
const ExecuteMooseObjectWarehouse< AuxKernel > & _nodal_aux
Nodal auxiliary kernels acting on standard field variables.
const ExecuteMooseObjectWarehouse< ArrayAuxKernel > & _nodal_array_aux
Nodal auxiliary kernels acting on array field variables.
const TheWarehouse::Query & _query
A warehouse query that we will use to obtain user objects for boundary variable dependency integrity ...
const ExecuteMooseObjectWarehouse< VectorAuxKernel > & _nodal_vec_aux
Nodal auxiliary kernels acting on vector field variables.
const AuxiliarySystem & _aux_sys
The auxiliary system to whom we'll delegate the boundary variable dependency integrity check.
AuxiliarySystem & getAuxiliarySystem()

◆ BoundaryNodeIntegrityCheckThread() [2/2]

BoundaryNodeIntegrityCheckThread::BoundaryNodeIntegrityCheckThread ( BoundaryNodeIntegrityCheckThread x,
Threads::split  split 
)

Member Function Documentation

◆ caughtMooseException()

virtual void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::caughtMooseException ( MooseException e)
inlinevirtualinherited

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Definition at line 56 of file ThreadedNodeLoop.h.

57 {
58 Threads::spin_mutex::scoped_lock lock(threaded_node_mutex);
59
60 std::string what(e.what());
62 };
static Threads::spin_mutex threaded_node_mutex
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.

◆ join()

void BoundaryNodeIntegrityCheckThread::join ( const BoundaryNodeIntegrityCheckThread )

Definition at line 92 of file BoundaryNodeIntegrityCheckThread.C.

93{
94}

◆ keepGoing()

virtual bool ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::keepGoing ( )
inlinevirtualinherited

Whether or not the loop should continue.

Returns
true to keep going, false to stop.

Definition at line 69 of file ThreadedNodeLoop.h.

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

◆ onNode() [1/2]

Called for each node.

Definition at line 43 of file ThreadedNodeLoop.h.

137{
138}

◆ onNode() [2/2]

void BoundaryNodeIntegrityCheckThread::onNode ( ConstBndNodeRange::const_iterator node_it)
overridevirtual

Definition at line 50 of file BoundaryNodeIntegrityCheckThread.C.

51{
52 const BndNode * const bnode = *node_it;
53 const auto boundary_id = bnode->_bnd_id;
54 const Node * const node = bnode->_node;
55
56 // We can distribute work just as the actual execution code will
57 if (node->processor_id() != _fe_problem.processor_id())
58 return;
59
60 const auto & bnd_name = _fe_problem.mesh().getBoundaryName(boundary_id);
61
62 // uo check
63 std::vector<NodalUserObject *> objs;
66 .condition<AttribInterfaces>(Interfaces::NodalUserObject)
67 .condition<AttribBoundaries>(boundary_id, true)
68 .queryInto(objs);
69 for (const auto & uo : objs)
70 if (uo->checkVariableBoundaryIntegrity())
71 boundaryIntegrityCheckError(*uo, uo->checkAllVariables(*node), bnd_name);
72
73 auto check = [node, boundary_id, &bnd_name, this](const auto & warehouse)
74 {
75 if (!warehouse.hasBoundaryObjects(boundary_id, _tid))
76 return;
77
78 const auto & bnd_objects = warehouse.getBoundaryObjects(boundary_id, _tid);
79 for (const auto & bnd_object : bnd_objects)
80 // Skip if this object uses geometric search because coupled variables may be defined on
81 // paired boundaries instead of the boundary this node is on
82 if (!bnd_object->requiresGeometricSearch() && bnd_object->checkVariableBoundaryIntegrity())
83 boundaryIntegrityCheckError(*bnd_object, bnd_object->checkAllVariables(*node), bnd_name);
84 };
85
86 check(_nodal_aux);
87 check(_nodal_vec_aux);
88 check(_nodal_array_aux);
89}
void boundaryIntegrityCheckError(const MooseObject &object, const std::set< MooseVariableFieldBase * > &variables, const BoundaryName &boundary_name)
Compose boundary restricted error message for the provided object, variables, and boundary_name if th...
if(!dmm->_nl) SETERRQ(PETSC_COMM_WORLD
AttribBoundaries tracks all boundary IDs associated with an object.
Definition Attributes.h:190
virtual MooseMesh & mesh() override
const std::string & getBoundaryName(const BoundaryID boundary_id) const
Return the name of the boundary given the id.
Definition MooseMesh.C:1780
QueryCache & condition(Args &&... args)
Adds a new condition to the query.
QueryCache clone() const
clone creates and returns an independent copy of the query in its current state.
processor_id_type processor_id() const
BoundaryID _bnd_id
boundary id for the node
Definition BndNode.h:26
libMesh::Node * _node
pointer to the node
Definition BndNode.h:24

◆ operator()()

void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::operator() ( const ConstBndNodeRange range)
inherited

Definition at line 28 of file ThreadedNodeLoop.h.

95{
96 try
97 {
99 _tid = puid.id;
100
101 pre();
103
104 for (IteratorType nd = range.begin(); nd != range.end(); ++nd)
105 {
106 if (!keepGoing())
107 break;
108
109 onNode(nd);
110
111 postNode(nd);
112 }
113
114 post();
115 }
116 catch (MooseException & e)
117 {
119 }
120}
Provides a way for users to bail out of the current solve.
virtual void printGeneralExecutionInformation() const
Print information about the loop, mostly order of execution of objects.
virtual void postNode(ConstBndNodeRange::const_iterator &node_it)
Called after the node assembly is done (including surface assembling)
virtual void onNode(ConstBndNodeRange::const_iterator &node_it)
Called for each node.
virtual bool keepGoing()
Whether or not the loop should continue.
virtual void caughtMooseException(MooseException &e)
Called if a MooseException is caught anywhere during the computation.
const_iterator begin() const
const_iterator end() const

◆ post()

Called after the node range loop.

Definition at line 38 of file ThreadedNodeLoop.h.

131{
132}

◆ postNode()

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

Parameters
node- active node

Definition at line 50 of file ThreadedNodeLoop.h.

143{
144}

◆ pre()

Called before the node range loop.

Reimplemented in ComputeNodalKernelBCJacobiansThread, and ComputeNodalKernelBcsThread.

Definition at line 33 of file ThreadedNodeLoop.h.

125{
126}

◆ printGeneralExecutionInformation()

virtual void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::printGeneralExecutionInformation ( ) const
inlineprotectedvirtualinherited

Print information about the loop, mostly order of execution of objects.

Reimplemented in ComputeNodalAuxBcsThread< AuxKernelType >, ComputeNodalKernelBCJacobiansThread, and ComputeNodalKernelBcsThread.

Definition at line 76 of file ThreadedNodeLoop.h.

76{}

Member Data Documentation

◆ _aux_sys

const AuxiliarySystem& BoundaryNodeIntegrityCheckThread::_aux_sys
protected

The auxiliary system to whom we'll delegate the boundary variable dependency integrity check.

Definition at line 39 of file BoundaryNodeIntegrityCheckThread.h.

◆ _fe_problem

Definition at line 72 of file ThreadedNodeLoop.h.

◆ _nodal_array_aux

const ExecuteMooseObjectWarehouse<ArrayAuxKernel>& BoundaryNodeIntegrityCheckThread::_nodal_array_aux
protected

Nodal auxiliary kernels acting on array field variables.

Definition at line 48 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

◆ _nodal_aux

const ExecuteMooseObjectWarehouse<AuxKernel>& BoundaryNodeIntegrityCheckThread::_nodal_aux
protected

Nodal auxiliary kernels acting on standard field variables.

Definition at line 42 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

◆ _nodal_vec_aux

const ExecuteMooseObjectWarehouse<VectorAuxKernel>& BoundaryNodeIntegrityCheckThread::_nodal_vec_aux
protected

Nodal auxiliary kernels acting on vector field variables.

Definition at line 45 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

◆ _query

const TheWarehouse::Query& BoundaryNodeIntegrityCheckThread::_query
protected

A warehouse query that we will use to obtain user objects for boundary variable dependency integrity checks.

Definition at line 52 of file BoundaryNodeIntegrityCheckThread.h.

Referenced by onNode().

◆ _tid

Definition at line 73 of file ThreadedNodeLoop.h.


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