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

#include <ComputeNodalKernelJacobiansThread.h>

Inheritance diagram for ComputeNodalKernelJacobiansThread:
[legend]

Public Member Functions

 ComputeNodalKernelJacobiansThread (FEProblemBase &fe_problem, NonlinearSystemBase &nl, MooseObjectTagWarehouse< NodalKernelBase > &nodal_kernels, const std::set< TagID > &tags)
 
 ComputeNodalKernelJacobiansThread (ComputeNodalKernelJacobiansThread &x, Threads::split split)
 
virtual void pre () override
 Called before the node range loop. More...
 
virtual void onNode (ConstNodeRange::const_iterator &node_it) override
 Called for each node. More...
 
void join (const ComputeNodalKernelJacobiansThread &)
 
void operator() (const ConstNodeRange &range)
 
virtual void post ()
 Called after the node range loop. More...
 
virtual void postNode (ConstNodeRange::const_iterator &node_it)
 Called after the node assembly is done (including surface assembling) More...
 
virtual void caughtMooseException (MooseException &e)
 Called if a MooseException is caught anywhere during the computation. More...
 
virtual bool keepGoing ()
 Whether or not the loop should continue. More...
 

Protected Member Functions

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

Protected Attributes

FEProblemBase_fe_problem
 
NonlinearSystemBase_nl
 
AuxiliarySystem_aux_sys
 
const std::set< TagID > & _tags
 
MooseObjectTagWarehouse< NodalKernelBase > & _nodal_kernels
 
MooseObjectWarehouse< NodalKernelBase > * _nkernel_warehouse
 
unsigned int _num_cached
 Number of contributions cached up. More...
 
THREAD_ID _tid
 

Detailed Description

Definition at line 30 of file ComputeNodalKernelJacobiansThread.h.

Constructor & Destructor Documentation

◆ ComputeNodalKernelJacobiansThread() [1/2]

ComputeNodalKernelJacobiansThread::ComputeNodalKernelJacobiansThread ( FEProblemBase fe_problem,
NonlinearSystemBase nl,
MooseObjectTagWarehouse< NodalKernelBase > &  nodal_kernels,
const std::set< TagID > &  tags 
)

◆ ComputeNodalKernelJacobiansThread() [2/2]

ComputeNodalKernelJacobiansThread::ComputeNodalKernelJacobiansThread ( ComputeNodalKernelJacobiansThread x,
Threads::split  split 
)

Member Function Documentation

◆ caughtMooseException()

virtual void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::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  };
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_node_mutex

◆ join()

void ComputeNodalKernelJacobiansThread::join ( const ComputeNodalKernelJacobiansThread )

Definition at line 140 of file ComputeNodalKernelJacobiansThread.C.

141 {
142 }

◆ keepGoing()

virtual bool ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::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()

void ComputeNodalKernelJacobiansThread::onNode ( ConstNodeRange::const_iterator &  node_it)
overridevirtual

Called for each node.

Reimplemented from ThreadedNodeLoop< ConstNodeRange, ConstNodeRange::const_iterator >.

Definition at line 65 of file ComputeNodalKernelJacobiansThread.C.

66 {
67  const Node * node = *node_it;
68 
69  auto & ce = _fe_problem.couplingEntries(_tid, _nl.number());
70  for (const auto & it : ce)
71  {
72  MooseVariableFEBase & ivariable = *(it.first);
73  MooseVariableFEBase & jvariable = *(it.second);
74 
75  unsigned int ivar = ivariable.number();
76  unsigned int jvar = jvariable.number();
77 
78  // The NodalKernels that are active and are coupled to the jvar in question
79  std::vector<std::shared_ptr<NodalKernelBase>> active_involved_kernels;
80 
81  const std::set<SubdomainID> & block_ids = _aux_sys.mesh().getNodeBlockIds(*node);
82  for (const auto & block : block_ids)
83  {
85  {
86  // Loop over each NodalKernel to see if it's involved with the jvar
87  const auto & objects = _nkernel_warehouse->getActiveBlockObjects(block, _tid);
88  for (const auto & nodal_kernel : objects)
89  {
90  if (nodal_kernel->variable().number() == ivar)
91  {
92  // If this NodalKernel is acting on the jvar add it to the list and short-circuit the
93  // loop
94  if (nodal_kernel->variable().number() == jvar)
95  {
96  active_involved_kernels.push_back(nodal_kernel);
97  continue;
98  }
99 
100  // See if this NodalKernel is coupled to the jvar
101  const std::vector<MooseVariableFEBase *> & coupled_vars =
102  nodal_kernel->getCoupledMooseVars();
103  for (const auto & var : coupled_vars)
104  if (var->number() == jvar)
105  {
106  active_involved_kernels.push_back(nodal_kernel);
107  break; // It only takes one
108  }
109  }
110  }
111  }
112  }
113 
114  // Did we find any NodalKernels coupled to this jvar?
115  if (!active_involved_kernels.empty())
116  {
117  // prepare variables
118  for (auto * var : _aux_sys._nodal_vars[_tid])
119  var->prepareAux();
120 
121  _fe_problem.reinitNode(node, _tid);
122 
123  for (const auto & nodal_kernel : active_involved_kernels)
124  nodal_kernel->computeOffDiagJacobian(jvar);
125 
126  _num_cached++;
127 
128  if (_num_cached == 20) // Cache 20 nodes worth before adding into the residual
129  {
130  _num_cached = 0;
131  // vectors are thread-safe, but matrices are not yet
132  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
134  }
135  }
136  }
137 }
std::vector< std::pair< MooseVariableFEBase *, MooseVariableFEBase * > > & couplingEntries(const THREAD_ID tid, const unsigned int nl_sys_num)
bool hasActiveBlockObjects(THREAD_ID tid=0) const
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
virtual void reinitNode(const Node *node, const THREAD_ID tid) override
unsigned int number() const
Get variable number coming from libMesh.
const std::set< SubdomainID > & getNodeBlockIds(const Node &node) const
Return list of blocks to which the given node belongs.
Definition: MooseMesh.C:1280
This class provides an interface for common operations on field variables of both FE and FV types wit...
MooseObjectWarehouse< NodalKernelBase > * _nkernel_warehouse
unsigned int number() const
Gets the number of this system.
Definition: SystemBase.C:1125
std::vector< std::vector< MooseVariableFEBase * > > _nodal_vars
virtual MooseMesh & mesh()
Definition: SystemBase.h:96
unsigned int _num_cached
Number of contributions cached up.
virtual void addCachedJacobian(const THREAD_ID tid) override

◆ operator()()

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

Definition at line 94 of file ThreadedNodeLoop.h.

95 {
96  try
97  {
98  ParallelUniqueId puid;
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 }
virtual void printGeneralExecutionInformation() const
Print information about the loop, mostly order of execution of objects.
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.
Provides a way for users to bail out of the current solve.
virtual void pre()
Called before the node range loop.
virtual void post()
Called after the node range loop.
virtual void postNode(ConstNodeRange::const_iterator &node_it)
Called after the node assembly is done (including surface assembling)
virtual void onNode(ConstNodeRange::const_iterator &node_it)
Called for each node.

◆ post()

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::post ( )
virtualinherited

Called after the node range loop.

Reimplemented in ComputeNodalAuxVarsThread< AuxKernelType >.

Definition at line 130 of file ThreadedNodeLoop.h.

131 {
132 }

◆ postNode()

void ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::postNode ( ConstNodeRange::const_iterator &  node_it)
virtualinherited

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

Parameters
node- active node

Definition at line 142 of file ThreadedNodeLoop.h.

143 {
144 }

◆ pre()

void ComputeNodalKernelJacobiansThread::pre ( )
overridevirtual

Called before the node range loop.

Reimplemented from ThreadedNodeLoop< ConstNodeRange, ConstNodeRange::const_iterator >.

Definition at line 52 of file ComputeNodalKernelJacobiansThread.C.

53 {
54  _num_cached = 0;
55 
56  if (!_tags.size() || _tags.size() == _fe_problem.numMatrixTags())
58  else if (_tags.size() == 1)
60  else
62 }
MooseObjectWarehouse< NodalKernelBase > * _nkernel_warehouse
MooseObjectWarehouse< T > & getMatrixTagObjectWarehouse(TagID tag_id, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object has the given matrix tag...
virtual unsigned int numMatrixTags() const
The total number of tags.
Definition: SubProblem.h:210
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...
MooseObjectTagWarehouse< NodalKernelBase > & _nodal_kernels
unsigned int _num_cached
Number of contributions cached up.

◆ printGeneralExecutionInformation()

void ComputeNodalKernelJacobiansThread::printGeneralExecutionInformation ( ) const
overrideprotectedvirtual

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

Reimplemented from ThreadedNodeLoop< ConstNodeRange, ConstNodeRange::const_iterator >.

Definition at line 145 of file ComputeNodalKernelJacobiansThread.C.

146 {
148  return;
149 
150  const auto & console = _fe_problem.console();
151  const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
152  console << "[DBG] Executing nodal kernels contribution to Jacobian on nodes on " << execute_on
153  << std::endl;
154  console << _nkernel_warehouse->activeObjectsToFormattedString() << std::endl;
155 }
std::string activeObjectsToFormattedString(THREAD_ID tid=0, const std::string &prefix="[DBG]") const
Output the active content of the warehouse to a string, meant to be output to the console...
const ExecFlagType & getCurrentExecuteOnFlag() const
Return/set the current execution flag.
MooseObjectWarehouse< NodalKernelBase > * _nkernel_warehouse
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
bool hasActiveObjects(THREAD_ID tid=0) const

Member Data Documentation

◆ _aux_sys

AuxiliarySystem& ComputeNodalKernelJacobiansThread::_aux_sys
protected

Definition at line 54 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode().

◆ _fe_problem

FEProblemBase& ComputeNodalKernelJacobiansThread::_fe_problem
protected

◆ _nkernel_warehouse

MooseObjectWarehouse<NodalKernelBase>* ComputeNodalKernelJacobiansThread::_nkernel_warehouse
protected

◆ _nl

NonlinearSystemBase& ComputeNodalKernelJacobiansThread::_nl
protected

Definition at line 53 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode().

◆ _nodal_kernels

MooseObjectTagWarehouse<NodalKernelBase>& ComputeNodalKernelJacobiansThread::_nodal_kernels
protected

Definition at line 58 of file ComputeNodalKernelJacobiansThread.h.

Referenced by pre().

◆ _num_cached

unsigned int ComputeNodalKernelJacobiansThread::_num_cached
protected

Number of contributions cached up.

Definition at line 63 of file ComputeNodalKernelJacobiansThread.h.

Referenced by onNode(), and pre().

◆ _tags

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

Definition at line 56 of file ComputeNodalKernelJacobiansThread.h.

Referenced by pre().

◆ _tid

THREAD_ID ThreadedNodeLoop< ConstNodeRange , ConstNodeRange::const_iterator >::_tid
protectedinherited

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