ComputeResidualThread Class Reference

#include <ComputeResidualThread.h>

Inheritance diagram for ComputeResidualThread:

Public Member Functions
	ComputeResidualThread (FEProblemBase &fe_problem, const std::set< TagID > &tags)
	ComputeResidualThread (ComputeResidualThread &x, Threads::split split)
virtual	~ComputeResidualThread ()
void	join (const ComputeResidualThread &)
virtual void	operator() (const ConstElemRange &range, bool bypass_threading=false) override
virtual void	operator() (const RangeType &range, bool bypass_threading=false)
virtual void	subdomainChanged () override
	Called every time the current subdomain changes (i.e.
virtual void	onElement (const Elem *elem) override
	Assembly of the element (not including surface assembly)
virtual void	onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override
	Called when doing boundary assembling.
virtual void	onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id) override
	Called when doing interface assembling.
virtual void	onInternalSide (const Elem *elem, unsigned int side) override
	Called when doing internal edge assembling.
virtual void	onExternalSide (const Elem *elem, unsigned int side) override
	Called when iterating over external sides (no side neighbor)
virtual void	postElement (const Elem *) override
	Called after the element assembly is done (including surface assembling)
virtual void	post () override
	Called after the element range loop.
bool	shouldComputeInternalSide (const Elem &elem, const Elem &neighbor) const override
	Whether to compute the internal side for the provided element-neighbor pair.
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	pre ()
	Called before the element range loop.
virtual void	postInternalSide (const Elem *elem, unsigned int side)
	Called after evaluations on an element internal side.

Protected Member Functions
virtual void	compute (ResidualObject &ro) override
	Will dispatch to computeResidual/computeJacobian/computeResidualAndJacobian based on the derived class.
virtual void	computeOnInternalFace () override
void	accumulateNeighbor () override
	Add neighbor residual/Jacobian into assembly global data.
void	accumulateNeighborLower () override
	Add neighbor and lower residual/Jacobian into assembly global data.
void	accumulateLower () override
	Add lower-d residual/Jacobian into assembly global data.
void	accumulate () override
	Add element residual/Jacobian into assembly global data.
void	determineObjectWarehouses () override
	Determine the objects we will actually compute based on vector/matrix tag information.
std::string	objectType () const override
	Return what the loops is meant to compute.
virtual void	compute (ResidualObject &ro)=0
	Will dispatch to computeResidual/computeJacobian/computeResidualAndJacobian based on the derived class.
virtual void	compute (KernelBase &kernel)
virtual void	compute (FVElementalKernel &kernel)
virtual void	compute (IntegratedBCBase &bc)
virtual void	compute (DGKernelBase &dg, const Elem *neighbor)
virtual void	compute (InterfaceKernelBase &ik)
virtual void	computeOnInternalFace (const Elem *neighbor)
virtual void	computeOnInternalFace ()=0
void	prepareFace (const Elem *elem, unsigned int side, BoundaryID bnd_id=Moose::INVALID_BOUNDARY_ID, const Elem *lower_d_elem=nullptr)
	Reinitialize variables and materials on a face.
void	onInterfaceWithHRefinementMismatch (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *fine_neighbor)
	Compute and accumulate the interface kernel contribution from a single active fine neighbor when elem's own neighbor_ptr(side) is an inactive ancestor, i.e.
void	printGeneralExecutionInformation () const override
	Print information about the loop, mostly order of execution of objects.
void	printBlockExecutionInformation () const override
	Print list of specific objects executed on each block and in which order.
void	printBoundaryExecutionInformation (const unsigned int bid) const override
	Print list of specific objects executed on each boundary and in which order.
void	prepareElement (const Elem *elem)
void	clearVarsAndMaterials ()
void	getRequiredBoundaryMaterials (const std::vector< const MaterialPropertyInterface * > &material_consumers, BoundaryID bnd_id, SubdomainID subdomain_id, std::deque< MaterialBase * > &required_face_materials, std::deque< MaterialBase * > &required_boundary_materials) const
	Determine the face and boundary materials required by material property consumers.
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
void	resetExecPrintedSets () const
	Resets the set of blocks and boundaries visited.
virtual void	computeOnElement ()
virtual void	computeOnBoundary (BoundaryID bnd_id, const Elem *lower_d_elem)
virtual void	computeOnInterface (BoundaryID bnd_id)

Protected Attributes
const std::set< TagID > &	_tags
	the tags denoting the vectors we want our residual objects to fill
NonlinearSystemBase &	_nl
	Reference to the underlying NonlinearSystemBase.
unsigned int	_num_cached
MooseObjectTagWarehouse< IntegratedBCBase > &	_integrated_bcs
	Reference to BC storage structures.
MooseObjectWarehouse< IntegratedBCBase > *	_ibc_warehouse
MooseObjectTagWarehouse< DGKernelBase > &	_dg_kernels
	Reference to DGKernel storage structure.
MooseObjectWarehouse< DGKernelBase > *	_dg_warehouse
MooseObjectTagWarehouse< InterfaceKernelBase > &	_interface_kernels
	Reference to interface kernel storage structure.
MooseObjectWarehouse< InterfaceKernelBase > *	_ik_warehouse
std::vector< FVElementalKernel * >	_fv_kernels
	Current subdomain FVElementalKernels.
const bool	_has_active_objects
	Whether there are any active residual objects; otherwise we will do an early return.
FEProblemBase &	_fe_problem
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.
MooseObjectTagWarehouse< KernelBase > &	_kernels
MooseObjectWarehouse< KernelBase > *	_tag_kernels
MooseObjectTagWarehouse< HDGKernel > &	_hdg_kernels
MooseObjectWarehouse< HDGKernel > *	_hdg_warehouse

Private Attributes
bool	_should_execute_dg
	Whether DG kernels should be executed for a given elem-neighbor pairing.
bool	_subdomain_has_dg
	Whether the subdomain has DGKernels.
bool	_subdomain_has_hdg
	Whether the subdomain has HDGKernels.
libMesh::ElemSideBuilder	_elem_side_builder
	Builds (and caches) the side element for elem/side pairs in onInterfaceWithHRefinementMismatch.

Detailed Description

Definition at line 16 of file ComputeResidualThread.h.

Constructor & Destructor Documentation

ComputeResidualThread() [1/2]

ComputeResidualThread::ComputeResidualThread	(	FEProblemBase &	fe_problem,
		const std::set< TagID > &	tags
	)

Definition at line 20 of file ComputeResidualThread.C.

  : NonlinearThread(fe_problem), _tags(tags)
{
}

ComputeResidualThread() [2/2]

ComputeResidualThread::ComputeResidualThread	(	ComputeResidualThread &	x,
		Threads::split	split
	)

Definition at line 27 of file ComputeResidualThread.C.

  : NonlinearThread(x, split), _tags(x._tags)
{
}

~ComputeResidualThread()

ComputeResidualThread::~ComputeResidualThread ( )

virtual

Definition at line 32 of file ComputeResidualThread.C.

{}

Member Function Documentation

accumulate()

void ComputeResidualThread::accumulate ( )

overrideprotectedvirtual

Add element residual/Jacobian into assembly global data.

Implements NonlinearThread.

Definition at line 60 of file ComputeResidualThread.C.

{
  _fe_problem.cacheResidual(_tid);
  _num_cached++;
 
  if (_num_cached % 20 == 0)
    _fe_problem.addCachedResidual(_tid);
}

accumulateLower()

void ComputeResidualThread::accumulateLower ( )

overrideprotectedvirtual

Add lower-d residual/Jacobian into assembly global data.

Implements NonlinearThread.

Definition at line 41 of file ComputeResidualThread.C.

{
  _fe_problem.addResidualLower(_tid);
}

accumulateNeighbor()

void ComputeResidualThread::accumulateNeighbor ( )

overrideprotectedvirtual

Add neighbor residual/Jacobian into assembly global data.

Implements NonlinearThread.

Definition at line 47 of file ComputeResidualThread.C.

{
  _fe_problem.addResidualNeighbor(_tid);
}

accumulateNeighborLower()

void ComputeResidualThread::accumulateNeighborLower ( )

overrideprotectedvirtual

Add neighbor and lower residual/Jacobian into assembly global data.

Implements NonlinearThread.

Definition at line 53 of file ComputeResidualThread.C.

{
  _fe_problem.addResidualNeighbor(_tid);
  _fe_problem.addResidualLower(_tid);
}

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 44 of file ThreadedElementLoop.h.

{
  Threads::spin_mutex::scoped_lock lock(threaded_element_mutex);
 
  std::string what(e.what());
  _fe_problem.setException(what);
}

clearVarsAndMaterials()

void ThreadedElementLoop< ConstElemRange >::clearVarsAndMaterials ( )

protectedinherited

Definition at line 61 of file ThreadedElementLoop.h.

{
  _fe_problem.clearActiveElementalMooseVariables(this->_tid);
  _fe_problem.clearActiveMaterialProperties(this->_tid);
}

compute() [1/7]

void NonlinearThread::compute ( DGKernelBase &  dg, const Elem *  neighbor  )

protectedvirtual

Reimplemented from NonlinearThread.

Definition at line 116 of file NonlinearThread.C.

{
  compute(cast_ref<ResidualObject &>(dg));
}

compute() [2/7]

void NonlinearThread::compute ( FVElementalKernel &  kernel )

protectedvirtual

Reimplemented from NonlinearThread.

Definition at line 114 of file NonlinearThread.C.

{
  compute(cast_ref<ResidualObject &>(kernel));
}

compute() [3/7]

void NonlinearThread::compute ( IntegratedBCBase &  bc )

protectedvirtual

Reimplemented from NonlinearThread.

Definition at line 115 of file NonlinearThread.C.

{
  compute(cast_ref<ResidualObject &>(bc));
}

compute() [4/7]

void NonlinearThread::compute ( InterfaceKernelBase &  ik )

protectedvirtual

Reimplemented from NonlinearThread.

Definition at line 117 of file NonlinearThread.C.

{
  compute(cast_ref<ResidualObject &>(ik));
}

compute() [5/7]

void NonlinearThread::compute ( KernelBase &  kernel )

protectedvirtual

Defaults to forwarding to the residual object class

Reimplemented from NonlinearThread.

Definition at line 113 of file NonlinearThread.C.

{
  compute(cast_ref<ResidualObject &>(kernel));
}

compute() [6/7]

void ComputeResidualThread::compute ( ResidualObject &  ro )

overrideprotectedvirtual

Will dispatch to computeResidual/computeJacobian/computeResidualAndJacobian based on the derived class.

Implements NonlinearThread.

Definition at line 35 of file ComputeResidualThread.C.

{
  ro.computeResidual();
}

compute() [7/7]

virtual void NonlinearThread::compute ( ResidualObject &  ro )

protectedvirtual

Will dispatch to computeResidual/computeJacobian/computeResidualAndJacobian based on the derived class.

Implements NonlinearThread.

computeOnBoundary()

void NonlinearThread::computeOnBoundary ( BoundaryID  bnd_id, const Elem *  lower_d_elem  )

protectedvirtualinherited

Reimplemented in ComputeFullJacobianThread.

Definition at line 186 of file NonlinearThread.C.

{
  const auto & bcs = _ibc_warehouse->getActiveBoundaryObjects(bnd_id, _tid);
  for (const auto & bc : bcs)
    if (bc->shouldApply())
      compute(*bc);
}

Referenced by NonlinearThread::onBoundary().

computeOnElement()

void NonlinearThread::computeOnElement ( )

protectedvirtualinherited

Base class version just calls compute on each object for the element

Reimplemented in ComputeFullJacobianThread, and ComputeJacobianForScalingThread.

Definition at line 149 of file NonlinearThread.C.

{
  if (_tag_kernels->hasActiveBlockObjects(_subdomain, _tid))
  {
    const auto & kernels = _tag_kernels->getActiveBlockObjects(_subdomain, _tid);
    for (const auto & kernel : kernels)
      compute(*kernel);
  }
 
  if (_fe_problem.haveFV())
    for (auto kernel : _fv_kernels)
      compute(*kernel);
}

Referenced by ComputeJacobianForScalingThread::computeOnElement(), and NonlinearThread::onElement().

computeOnInterface()

void NonlinearThread::computeOnInterface ( BoundaryID  bnd_id )

protectedvirtualinherited

Reimplemented in ComputeFullJacobianThread.

Definition at line 325 of file NonlinearThread.C.

{
  const auto & int_ks = _ik_warehouse->getActiveBoundaryObjects(bnd_id, _tid);
  for (const auto & interface_kernel : int_ks)
    compute(*interface_kernel);
}

Referenced by NonlinearThread::onInterface(), and NonlinearThread::onInterfaceWithHRefinementMismatch().

computeOnInternalFace() [1/3]

void ComputeResidualThread::computeOnInternalFace ( )

overrideprotectedvirtual

Implements NonlinearThread.

Definition at line 122 of file ComputeResidualThread.C.

{
  mooseAssert(_hdg_warehouse->hasActiveBlockObjects(_subdomain, _tid),
              "We should not be called if we have no active HDG kernels");
  for (const auto & hdg_kernel : _hdg_warehouse->getActiveBlockObjects(_subdomain, _tid))
  {
    mooseAssert(
        hdg_kernel->hasBlocks(_subdomain),
        "We queried the warehouse for active blocks on this subdomain, so this better be active");
    mooseAssert(
        _neighbor_subdomain != Moose::INVALID_BLOCK_ID,
        "We should have set a valid neighbor subdomain ID if we made it in side this method");
    if (hdg_kernel->hasBlocks(_neighbor_subdomain))
      hdg_kernel->computeResidualOnSide();
  }
}

computeOnInternalFace() [2/3]

virtual void NonlinearThread::computeOnInternalFace ( )

protectedvirtual

Implements NonlinearThread.

computeOnInternalFace() [3/3]

void NonlinearThread::computeOnInternalFace ( const Elem *  neighbor )

protectedvirtual

Reimplemented from NonlinearThread.

Definition at line 101 of file NonlinearThread.C.

{
  const auto & dgks = _dg_warehouse->getActiveBlockObjects(_subdomain, _tid);
  for (const auto & dg_kernel : dgks)
    if (dg_kernel->hasBlocks(neighbor->subdomain_id()))
      compute(*dg_kernel, neighbor);
}

determineObjectWarehouses()

void ComputeResidualThread::determineObjectWarehouses ( )

overrideprotectedvirtual

Determine the objects we will actually compute based on vector/matrix tag information.

Implements NonlinearThread.

Definition at line 75 of file ComputeResidualThread.C.

{
  // If users pass a empty vector or a full size of vector,
  // we take all kernels
  if (!_tags.size() || _tags.size() == _fe_problem.numVectorTags(Moose::VECTOR_TAG_RESIDUAL))
  {
    _tag_kernels = &_kernels;
    _dg_warehouse = &_dg_kernels;
    _ibc_warehouse = &_integrated_bcs;
    _ik_warehouse = &_interface_kernels;
    _hdg_warehouse = &_hdg_kernels;
  }
  // If we have one tag only,
  // We call tag based storage
  else if (_tags.size() == 1)
  {
    _tag_kernels = &(_kernels.getVectorTagObjectWarehouse(*(_tags.begin()), _tid));
    _dg_warehouse = &(_dg_kernels.getVectorTagObjectWarehouse(*(_tags.begin()), _tid));
    _ibc_warehouse = &(_integrated_bcs.getVectorTagObjectWarehouse(*(_tags.begin()), _tid));
    _ik_warehouse = &(_interface_kernels.getVectorTagObjectWarehouse(*(_tags.begin()), _tid));
    _hdg_warehouse = &(_hdg_kernels.getVectorTagObjectWarehouse(*(_tags.begin()), _tid));
  }
  // This one may be expensive
  else
  {
    _tag_kernels = &(_kernels.getVectorTagsObjectWarehouse(_tags, _tid));
    _dg_warehouse = &(_dg_kernels.getVectorTagsObjectWarehouse(_tags, _tid));
    _ibc_warehouse = &(_integrated_bcs.getVectorTagsObjectWarehouse(_tags, _tid));
    _ik_warehouse = &(_interface_kernels.getVectorTagsObjectWarehouse(_tags, _tid));
    _hdg_warehouse = &(_hdg_kernels.getVectorTagsObjectWarehouse(_tags, _tid));
  }
 
  if (_fe_problem.haveFV())
  {
    _fv_kernels.clear();
    _fe_problem.theWarehouse()
        .query()
        .template condition<AttribSysNum>(_nl.number())
        .template condition<AttribSystem>("FVElementalKernel")
        .template condition<AttribSubdomains>(_subdomain)
        .template condition<AttribThread>(_tid)
        .template condition<AttribVectorTags>(_tags)
        .queryInto(_fv_kernels);
  }
}

getRequiredBoundaryMaterials()

void ThreadedElementLoop< ConstElemRange >::getRequiredBoundaryMaterials ( const std::vector< const MaterialPropertyInterface * > &  material_consumers, BoundaryID  bnd_id, SubdomainID  subdomain_id, std::deque< MaterialBase * > &  required_face_materials, std::deque< MaterialBase * > &  required_boundary_materials  ) const

protectedinherited

Determine the face and boundary materials required by material property consumers.

Definition at line 63 of file ThreadedElementLoop.h.

{
  required_face_materials.clear();
  required_boundary_materials.clear();
 
  std::unordered_set<unsigned int> needed_face_props;
  for (const auto * const consumer : material_consumers)
  {
    const auto & dependencies = consumer->getMatPropDependencies();
    needed_face_props.insert(dependencies.begin(), dependencies.end());
  }
 
  const auto & materials = _fe_problem.getRegularMaterialsWarehouse();
  // Resolve boundary materials first. A boundary material can depend on a property supplied by a
  // face material, while a property supplied by the boundary-material chain does not also need a
  // face producer.
  if (!material_consumers.empty() && materials.hasActiveBoundaryObjects(bnd_id, this->_tid))
    required_boundary_materials = MaterialBase::buildRequiredMaterials(
        material_consumers, materials.getActiveBoundaryObjects(bnd_id, this->_tid), true);
  for (const auto * const material : required_boundary_materials)
  {
    const auto & dependencies = material->getMatPropDependencies();
    needed_face_props.insert(dependencies.begin(), dependencies.end());
  }
  // The boundary-material chain has already satisfied these properties. Removing them prevents a
  // face material that happens to declare the same property from being selected unnecessarily.
  for (const auto * const material : required_boundary_materials)
    for (const auto supplied_prop : material->getSuppliedPropIDs())
      needed_face_props.erase(supplied_prop);
 
  struct MaterialDependencyConsumer
  {
    const std::unordered_set<unsigned int> & dependencies;
    const std::unordered_set<unsigned int> & getMatPropDependencies() const { return dependencies; }
  };
  if (!needed_face_props.empty())
  {
    const auto & face_materials = materials[Moose::FACE_MATERIAL_DATA];
    if (face_materials.hasActiveBlockObjects(subdomain_id, this->_tid))
    {
      const MaterialDependencyConsumer face_consumer{needed_face_props};
      const std::vector<const MaterialDependencyConsumer *> face_consumers{&face_consumer};
      required_face_materials = MaterialBase::buildRequiredMaterials(
          face_consumers, face_materials.getActiveBlockObjects(subdomain_id, this->_tid), true);
    }
  }
}

join()

void ComputeResidualThread::join

(

const ComputeResidualThread &

)

Definition at line 70 of file ComputeResidualThread.C.

{
}

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 46 of file ThreadedElementLoop.h.

{ return !_fe_problem.hasException(); }

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 57 of file ThreadedElementLoop.h.

{
  _fe_problem.neighborSubdomainSetup(ThreadedElementLoopBase<RangeType>::_neighbor_subdomain,
                                     ThreadedElementLoopBase<RangeType>::_tid);
}

objectType()

std::string ComputeResidualThread::objectType ( ) const

inlineoverrideprotectedvirtual

Return what the loops is meant to compute.

Reimplemented from NonlinearThread.

Definition at line 40 of file ComputeResidualThread.h.

{ return "Residual"; }

onBoundary()

void NonlinearThread::onBoundary ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id, const Elem *  lower_d_elem = nullptr  )

overridevirtualinherited

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

Definition at line 164 of file NonlinearThread.C.

{
  if (_ibc_warehouse->hasActiveBoundaryObjects(bnd_id, _tid))
  {
    // Set up Sentinel class so that, after we swap in reinitMaterialsFace in prepareFace, even if
    // one of our callees throws we remember to swap back during stack unwinding. We put our
    // sentinel here as opposed to in prepareFace because we certainly don't want our materials
    // swapped back before we proceed to residual/Jacobian computation
    SwapBackSentinel sentinel(_fe_problem, &FEProblem::swapBackMaterialsFace, _tid);
 
    prepareFace(elem, side, bnd_id, lower_d_elem);
    computeOnBoundary(bnd_id, lower_d_elem);
 
    if (lower_d_elem)
      accumulateLower();
  }
}

onElement()

void NonlinearThread::onElement ( const Elem *  elem )

overridevirtualinherited

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 133 of file NonlinearThread.C.

{
  // Set up Sentinel class so that, even if reinitMaterials() throws in prepareElement, we
  // still remember to swap back during stack unwinding.
  SwapBackSentinel sentinel(_fe_problem, &FEProblemBase::swapBackMaterials, this->_tid);
 
  prepareElement(elem);
 
  if (dynamic_cast<ComputeJacobianThread *>(this))
    if (_nl.getScalarVariables(_tid).size() > 0)
      _fe_problem.reinitOffDiagScalars(_tid);
 
  computeOnElement();
}

Referenced by ComputeJacobianForScalingThread::operator()().

onExternalSide()

void NonlinearThread::onExternalSide ( const Elem *  elem, unsigned int  side  )

overridevirtualinherited

Called when iterating over external sides (no side neighbor)

Parameters

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

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 368 of file NonlinearThread.C.

{
  // Check that we don't have any interface kernels defined on this boundary
  const auto boundary_ids = _mesh.getBoundaryIDs(elem, side);
 
  bool has_interface_kernels = false;
  for (const auto bid : boundary_ids)
    if (_ik_warehouse && _ik_warehouse->hasActiveBoundaryObjects(bid, _tid))
      has_interface_kernels = true;
 
  if (has_interface_kernels)
    mooseError("Element ",
               elem->id(),
               " on side ",
               side,
               " is missing a neighbor (hence identified as an external side) but "
               "has interface kernel(s) defined on the boundary.");
}

onInterface()

void NonlinearThread::onInterface ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id  )

overridevirtualinherited

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

Definition at line 195 of file NonlinearThread.C.

{
  if (_ik_warehouse->hasActiveBoundaryObjects(bnd_id, _tid))
  {
 
    // Pointer to the neighbor we are currently working on.
    const Elem * neighbor = elem->neighbor_ptr(side);
 
    if (neighbor->active())
    {
      _fe_problem.reinitNeighbor(elem, side, _tid);
 
      // Set up Sentinels so that, even if one of the reinitMaterialsXXX() calls throws, we
      // still remember to swap back during stack unwinding. Note that face, boundary, and interface
      // all operate with the same MaterialData object
      SwapBackSentinel face_sentinel(_fe_problem, &FEProblem::swapBackMaterialsFace, _tid);
      _fe_problem.reinitMaterialsFaceOnBoundary(bnd_id, elem->subdomain_id(), _tid);
      _fe_problem.reinitMaterialsBoundary(bnd_id, _tid);
 
      SwapBackSentinel neighbor_sentinel(_fe_problem, &FEProblem::swapBackMaterialsNeighbor, _tid);
      _fe_problem.reinitMaterialsNeighborOnBoundary(bnd_id, neighbor->subdomain_id(), _tid);
 
      // Has to happen after face and neighbor properties have been computed. Note that we don't use
      // a sentinel here because FEProblem::swapBackMaterialsFace is going to handle face materials,
      // boundary materials, and interface materials (e.g. it queries the boundary material data
      // with the current element and side
      _fe_problem.reinitMaterialsInterface(bnd_id, _tid);
 
      computeOnInterface(bnd_id);
 
      accumulateNeighbor();
    }
    else
    {
      // elem's neighbor across this side is an inactive ancestor: elem is on the coarser side of
      // an interface with h-refinement on the other side.
      // The real geometric neighbors are the active children of this ancestor, so visit each of
      // them individually instead of silently skipping the whole face.
      std::vector<const Elem *> fine_neighbors;
      neighbor->active_family_tree_by_neighbor(fine_neighbors, elem);
      for (const Elem * fine_neighbor : fine_neighbors)
        onInterfaceWithHRefinementMismatch(elem, side, bnd_id, fine_neighbor);
    }
  }
}

onInterfaceWithHRefinementMismatch()

void NonlinearThread::onInterfaceWithHRefinementMismatch ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id, const Elem *  fine_neighbor  )

protectedinherited

Compute and accumulate the interface kernel contribution from a single active fine neighbor when elem's own neighbor_ptr(side) is an inactive ancestor, i.e.

elem is on the coarser side of an interface with h-refinement on the other side. variable 's dofs stay bound to elem (so the primary/boundary side's variable is unaffected by refinement direction), while elem 's face is reinitialized at the physical quadrature points of fine_neighbor with a Jacobian-rescaled weight so the integration measure matches fine_neighbor's true physical face area.

elem's own residual/Jacobian contribution must accumulate additively across every active fine neighbor of a given (elem, side) visit, since each one only covers a fraction of elem's face. That local storage was already correctly prepared and zeroed exactly once for elem by FEProblemBase::prepare() before this side loop ever started, so elem's face is reinitialized directly through Assembly/SystemBase here rather than through the FEProblemBase::reinitElemFaceRef() convenience bundle, which would unconditionally (re-)zero that storage - discarding the prior fine neighbors' contributions as well as every contribution already accumulated earlier in elem's visit (volumetric Kernels, IntegratedBCs and InterfaceKernels on other sides, etc.).

Definition at line 242 of file NonlinearThread.C.

{
  if (_fe_problem.getDisplacedProblem())
    mooseError("InterfaceKernel '",
               _ik_warehouse->getActiveBoundaryObjects(bnd_id, _tid)[0]->name(),
               "' is defined on boundary ",
               bnd_id,
               ", whose primary (boundary-tagged) side is coarser than its paired side. This "
               "case is not supported with a displaced mesh problem: the displaced problem's "
               "assembly is not reinitialized on these faces, and the borrowed integration "
               "weight used to handle the mismatched refinement is not AD-differentiable with "
               "respect to mesh displacement.");
 
  const unsigned int fine_side = fine_neighbor->which_neighbor_am_i(elem);
 
  // Measure the fine neighbor's own natural face quadrature: these physical points and weights
  // are the correct integration measure for the portion of elem's face that fine_neighbor
  // actually covers. Call this directly on the Assembly object (not through FEProblemBase) so no
  // variable/dof binding happens for fine_neighbor in the "elem" role.
  Assembly & current_assembly = _fe_problem.assembly(_tid, _fe_problem.currentNlSysNum());
  current_assembly.reinitElemFaceRef(fine_neighbor, fine_side, TOLERANCE, nullptr, nullptr);
  const auto fine_phys_points = current_assembly.qPointsFace().stdVector();
  const auto fine_phys_JxW = current_assembly.JxWFace().stdVector();
 
  // Find elem's own side-local reference coordinates for those same physical points.
  const Elem & elem_side_elem = _elem_side_builder(*elem, side);
  std::vector<Point> elem_side_ref_points;
  libMesh::FEMap::inverse_map(
      elem_side_elem.dim(), &elem_side_elem, fine_phys_points, elem_side_ref_points);
 
  // Measure elem's own local Jacobian at those points using dummy unit weights, then rescale so
  // that elem's face JxW, once bound for real below, exactly matches fine_neighbor's physical
  // weight computed above.
  current_assembly.reinitElemFaceRef(elem, side, TOLERANCE, &elem_side_ref_points, nullptr);
  const auto elem_dummy_JxW = current_assembly.JxWFace().stdVector();
  std::vector<Real> elem_ref_weights(fine_phys_JxW.size());
  for (const auto qp : index_range(elem_ref_weights))
    elem_ref_weights[qp] = fine_phys_JxW[qp] / elem_dummy_JxW[qp];
 
  // Bind elem's (primary side) variable to its own dofs, with the face reinitialized at the
  // corrected points/weights above. elem's residual/Jacobian contribution must accumulate
  // additively across every fine neighbor of this (elem, side) visit, since each one only covers
  // a fraction of elem's face; that local storage was already correctly prepared and zeroed
  // exactly once for this element by FEProblemBase::prepare() before this side loop ever started.
  // The loop below calls Assembly::reinitElemFaceRef() directly rather than the
  // FEProblemBase/SubProblem method of the same name: that convenience bundle also calls
  // Assembly::prepareResidual()/prepareJacobianBlock(), which would unconditionally re-zero elem's
  // local residual/Jacobian storage, discarding the prior fine neighbors' contributions as well as
  // every contribution already accumulated earlier in this element's visit (volumetric Kernels,
  // IntegratedBCs and InterfaceKernels on other sides, etc.). elem's dof indices don't change
  // across fine neighbors, so reinitializing the face at the new points/weights and recomputing
  // variable values from them is all that is needed; no further dof preparation step is required.
  for (const auto sys_num : make_range(_fe_problem.numNonlinearSystems()))
  {
    _fe_problem.assembly(_tid, sys_num)
        .reinitElemFaceRef(elem, side, TOLERANCE, &elem_side_ref_points, &elem_ref_weights);
    _fe_problem.getNonlinearSystemBase(sys_num).reinitElemFace(elem, side, _tid);
  }
  // Auxiliary variables use the system 0 assembly reinitialized above
  _fe_problem.getAuxiliarySystem().reinitElemFace(elem, side, _tid);
 
  SwapBackSentinel face_sentinel(_fe_problem, &FEProblem::swapBackMaterialsFace, _tid);
  _fe_problem.reinitMaterialsFaceOnBoundary(bnd_id, elem->subdomain_id(), _tid);
  _fe_problem.reinitMaterialsBoundary(bnd_id, _tid);
 
  // Bind the neighbor variable to fine_neighbor's own dofs at the matching physical points.
  _fe_problem.setNeighborSubdomainID(fine_neighbor, _tid);
  _fe_problem.reinitNeighborPhys(fine_neighbor, fine_side, fine_phys_points, _tid);
 
  SwapBackSentinel neighbor_sentinel(_fe_problem, &FEProblem::swapBackMaterialsNeighbor, _tid);
  _fe_problem.reinitMaterialsNeighborOnBoundary(bnd_id, fine_neighbor->subdomain_id(), _tid);
 
  _fe_problem.reinitMaterialsInterface(bnd_id, _tid);
 
  computeOnInterface(bnd_id);
 
  accumulateNeighbor();
}

Referenced by NonlinearThread::onInterface().

onInternalSide()

void NonlinearThread::onInternalSide ( const Elem *  elem, unsigned int  side  )

overridevirtualinherited

Called when doing internal edge assembling.

Parameters

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

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 333 of file NonlinearThread.C.

{
  if (_should_execute_dg)
  {
    // Pointer to the neighbor we are currently working on.
    const Elem * neighbor = elem->neighbor_ptr(side);
 
    _fe_problem.reinitElemNeighborAndLowerD(elem, side, _tid);
 
    // Set up Sentinels so that, even if one of the reinitMaterialsXXX() calls throws, we
    // still remember to swap back during stack unwinding.
    SwapBackSentinel face_sentinel(_fe_problem, &FEProblem::swapBackMaterialsFace, _tid);
    _fe_problem.reinitMaterialsFace(elem->subdomain_id(), _tid);
 
    SwapBackSentinel neighbor_sentinel(_fe_problem, &FEProblem::swapBackMaterialsNeighbor, _tid);
    _fe_problem.reinitMaterialsNeighbor(neighbor->subdomain_id(), _tid);
 
    computeOnInternalFace(neighbor);
 
    accumulateNeighborLower();
  }
  if (_subdomain_has_hdg)
  {
    // Set up Sentinel class so that, after we swap in reinitMaterialsFace in prepareFace, even if
    // one of our callees throws we remember to swap back during stack unwinding. We put our
    // sentinel here as opposed to in prepareFace because we certainly don't want our materials
    // swapped back before we proceed to residual/Jacobian computation
    SwapBackSentinel sentinel(_fe_problem, &FEProblem::swapBackMaterialsFace, _tid);
 
    prepareFace(elem, side, Moose::INVALID_BOUNDARY_ID, nullptr);
    computeOnInternalFace();
  }
}

operator()() [1/2]

void NonlinearThread::operator() ( const ConstElemRange &  range, bool  bypass_threading = false  )

overridevirtualinherited

Definition at line 65 of file NonlinearThread.C.

{
  if (_has_active_objects)
    ThreadedElementLoop<ConstElemRange>::operator()(range, bypass_threading);
}

operator()() [2/2]

template<typename RangeType >

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

virtualinherited

Definition at line 226 of file ThreadedElementLoopBase.h.

{
  try
  {
    try
    {
      ParallelUniqueId puid;
      _tid = bypass_threading ? 0 : puid.id;
 
      pre();
      printGeneralExecutionInformation();
 
      _subdomain = Moose::INVALID_BLOCK_ID;
      _neighbor_subdomain = Moose::INVALID_BLOCK_ID;
      typename RangeType::const_iterator el = range.begin();
      for (el = range.begin(); el != range.end(); ++el)
      {
        if (!keepGoing())
          break;
 
        const Elem * elem = *el;
 
        preElement(elem);
 
        _old_subdomain = _subdomain;
        _subdomain = elem->subdomain_id();
        if (_subdomain != _old_subdomain)
        {
          subdomainChanged();
          printBlockExecutionInformation();
        }
 
        onElement(elem);
 
        if (_mesh.interiorLowerDBlocks().count(elem->subdomain_id()) > 0 ||
            _mesh.boundaryLowerDBlocks().count(elem->subdomain_id()) > 0)
        {
          postElement(elem);
          continue;
        }
 
        const auto elem_boundary_ids = _mesh.getBoundaryIDs(elem);
        for (unsigned int side = 0; side < elem->n_sides(); side++)
        {
          const auto & boundary_ids = elem_boundary_ids[side];
          const Elem * lower_d_elem = _mesh.getLowerDElem(elem, side);
 
          for (const auto bnd_id : boundary_ids)
          {
            preBoundary(elem, side, bnd_id, lower_d_elem);
            printBoundaryExecutionInformation(bnd_id);
            onBoundary(elem, side, bnd_id, lower_d_elem);
          }
 
          const Elem * neighbor = elem->neighbor_ptr(side);
          if (neighbor)
          {
            preInternalSide(elem, side);
 
            _old_neighbor_subdomain = _neighbor_subdomain;
            _neighbor_subdomain = neighbor->subdomain_id();
            if (_neighbor_subdomain != _old_neighbor_subdomain)
              neighborSubdomainChanged();
 
            if (shouldComputeInternalSide(*elem, *neighbor))
              onInternalSide(elem, side);
 
            for (const auto bnd_id : boundary_ids)
              onInterface(elem, side, bnd_id);
 
            postInternalSide(elem, side);
          }
          else
            onExternalSide(elem, side);
        } // sides
 
        postElement(elem);
      } // range
 
      post();
      resetExecPrintedSets();
    }
    catch (MetaPhysicL::LogicError & e)
    {
      moose::translateMetaPhysicLError(e);
    }
    catch (std::exception & e)
    {
      // Continue if we find a libMesh degenerate map exception, but
      // just re-throw for any real error
      if (!strstr(e.what(), "Jacobian") && !strstr(e.what(), "singular") &&
          !strstr(e.what(), "det != 0"))
        throw; // not "throw e;" - that destroys type info!
 
      mooseException("We caught a libMesh degeneracy exception in ThreadedElementLoopBase:\n",
                     e.what());
    }
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

Referenced by NonlinearThread::operator()().

post()

void NonlinearThread::post ( )

overridevirtualinherited

Called after the element range loop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 433 of file NonlinearThread.C.

{
  clearVarsAndMaterials();
}

Referenced by ComputeJacobianForScalingThread::operator()().

postElement()

void NonlinearThread::postElement ( const Elem *  elem )

overridevirtualinherited

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

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Reimplemented in ComputeJacobianThread, and ComputeJacobianBlocksThread.

Definition at line 427 of file NonlinearThread.C.

{
  accumulate();
}

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.

{
}

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.

{
}

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 52 of file ThreadedElementLoop.h.

{
  _fe_problem.setCurrentBoundaryID(bnd_id, ThreadedElementLoopBase<RangeType>::_tid);
}

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 48 of file ThreadedElementLoop.h.

{
  _fe_problem.setCurrentSubdomainID(el, ThreadedElementLoopBase<RangeType>::_tid);
}

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 50 of file ThreadedElementLoop.h.

{
  _fe_problem.setNeighborSubdomainID(el, side, ThreadedElementLoopBase<RangeType>::_tid);
}

prepareElement()

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

protectedinherited

Definition at line 60 of file ThreadedElementLoop.h.

{
  _fe_problem.prepare(elem, this->_tid);
  _fe_problem.reinitElem(elem, this->_tid);
  _fe_problem.reinitMaterials(this->_subdomain, this->_tid);
}

prepareFace()

void NonlinearThread::prepareFace ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id = Moose::INVALID_BOUNDARY_ID, const Elem *  lower_d_elem = nullptr  )

protectedinherited

Reinitialize variables and materials on a face.

Parameters

fe_problem	The finite element problem to call reinit methods on
tid	The thread ID for which we should reinit variables and materials
elem	The element we are reiniting
side	The element side corresponding to the face we are reiniting
bnd_id	If provided, materials associated with this boundary ID will be reinit'd
lower_d_elem	If provided, lower dimensional variables coincident with the element face will be reinit'd

Definition at line 535 of file NonlinearThread.C.

{
  _fe_problem.reinitElemFace(elem, side, _tid);
 
  // Needed to use lower-dimensional variables on Materials
  if (lower_d_elem)
    _fe_problem.reinitLowerDElem(lower_d_elem, _tid);
 
  if (bnd_id != Moose::INVALID_BOUNDARY_ID)
  {
    _fe_problem.reinitMaterialsFaceOnBoundary(bnd_id, elem->subdomain_id(), _tid);
    _fe_problem.reinitMaterialsBoundary(bnd_id, _tid);
  }
  // Currently only used by HDG
  else
    _fe_problem.reinitMaterialsFace(elem->subdomain_id(), _tid);
}

Referenced by NonlinearThread::onBoundary(), and NonlinearThread::onInternalSide().

printBlockExecutionInformation()

void NonlinearThread::printBlockExecutionInformation ( ) const

overrideprotectedvirtualinherited

Print list of specific objects executed on each block and in which order.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 459 of file NonlinearThread.C.

{
  // Number of objects executing is approximated by size of warehouses
  const int num_objects = _kernels.size() + _fv_kernels.size() + _integrated_bcs.size() +
                          _dg_kernels.size() + _interface_kernels.size();
  const auto & console = _fe_problem.console();
  const auto block_name = _mesh.getSubdomainName(_subdomain);
 
  if (_fe_problem.shouldPrintExecution(_tid) && num_objects > 0)
  {
    if (_blocks_exec_printed.count(_subdomain))
      return;
    console << "[DBG] Ordering of " + objectType() + " Objects on block " << block_name << " ("
            << _subdomain << ")" << std::endl;
    if (_kernels.hasActiveBlockObjects(_subdomain, _tid))
    {
      console << "[DBG] Ordering of kernels:" << std::endl;
      console << _kernels.activeObjectsToFormattedString() << std::endl;
    }
    if (_fv_kernels.size())
    {
      console << "[DBG] Ordering of FV elemental kernels:" << std::endl;
      std::string fvkernels =
          std::accumulate(_fv_kernels.begin() + 1,
                          _fv_kernels.end(),
                          _fv_kernels[0]->name(),
                          [](const std::string & str_out, FVElementalKernel * kernel)
                          { return str_out + " " + kernel->name(); });
      console << ConsoleUtils::formatString(fvkernels, "[DBG]") << std::endl;
    }
    if (_dg_kernels.hasActiveBlockObjects(_subdomain, _tid))
    {
      console << "[DBG] Ordering of DG kernels:" << std::endl;
      console << _dg_kernels.activeObjectsToFormattedString() << std::endl;
    }
  }
  else if (_fe_problem.shouldPrintExecution(_tid) && num_objects == 0 &&
           !_blocks_exec_printed.count(_subdomain))
    console << "[DBG] No Active " + objectType() + " Objects on block " << block_name << " ("
            << _subdomain << ")" << std::endl;
 
  _blocks_exec_printed.insert(_subdomain);
}

printBoundaryExecutionInformation()

void NonlinearThread::printBoundaryExecutionInformation ( const unsigned int  bid ) const

overrideprotectedvirtualinherited

Print list of specific objects executed on each boundary and in which order.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 504 of file NonlinearThread.C.

{
  if (!_fe_problem.shouldPrintExecution(_tid) || _boundaries_exec_printed.count(bid) ||
      (!_integrated_bcs.hasActiveBoundaryObjects(bid, _tid) &&
       !_interface_kernels.hasActiveBoundaryObjects(bid, _tid)))
    return;
 
  const auto & console = _fe_problem.console();
  const auto b_name = _mesh.getBoundaryName(bid);
  console << "[DBG] Ordering of " + objectType() + " Objects on boundary " << b_name << " (" << bid
          << ")" << std::endl;
 
  if (_integrated_bcs.hasActiveBoundaryObjects(bid, _tid))
  {
    console << "[DBG] Ordering of integrated boundary conditions:" << std::endl;
    console << _integrated_bcs.activeObjectsToFormattedString() << std::endl;
  }
 
  // We have not checked if we have a neighbor. This could be premature for saying we are executing
  // interface kernels. However, we should assume the execution will happen on another side of the
  // same boundary
  if (_interface_kernels.hasActiveBoundaryObjects(bid, _tid))
  {
    console << "[DBG] Ordering of interface kernels:" << std::endl;
    console << _interface_kernels.activeObjectsToFormattedString() << std::endl;
  }
 
  _boundaries_exec_printed.insert(bid);
}

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 87 of file ThreadedElementLoop.h.

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

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

T	the object type

Parameters

objs	the vector with all the objects (should be pointers)
objects_type	the name of the type of objects. Defaults to the CPP object name
print_header	whether to print a header about the timing of execution and the type of objects

Definition at line 83 of file ThreadedElementLoop.h.

{
  if (!objs.size())
    return;
 
  auto & console = _fe_problem.console();
  const auto objects_type = MooseUtils::prettyCppType(objs[0]);
  std::vector<MooseObject *> moose_objs;
  for (auto obj_ptr : objs)
    moose_objs.push_back(dynamic_cast<MooseObject *>(obj_ptr));
  const auto names = ConsoleUtils::mooseObjectVectorToString(moose_objs);
 
  // Print string with a DBG prefix and with sufficient line breaks
  std::string message = print_header ? "Executing " + objects_type + " on " +
                                           _fe_problem.getCurrentExecuteOnFlag().name() + "\n"
                                     : "";
  message += (print_header ? "Order of execution:\n" : "") + names;
  console << ConsoleUtils::formatString(message, line_prefix) << std::endl;
}

printGeneralExecutionInformation()

void NonlinearThread::printGeneralExecutionInformation ( ) const

overrideprotectedvirtualinherited

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

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 439 of file NonlinearThread.C.

{
  if (_fe_problem.shouldPrintExecution(_tid))
  {
    const auto & console = _fe_problem.console();
    const auto execute_on = _fe_problem.getCurrentExecuteOnFlag();
    console << "[DBG] Beginning elemental loop to compute " + objectType() + " on " << execute_on
            << std::endl;
    mooseDoOnce(
        console << "[DBG] Execution order on each element:" << std::endl;
        console << "[DBG] - kernels on element quadrature points" << std::endl;
        console << "[DBG] - finite volume elemental kernels on element" << std::endl;
        console << "[DBG] - integrated boundary conditions on element side quadrature points"
                << std::endl;
        console << "[DBG] - DG kernels on element side quadrature points" << std::endl;
        console << "[DBG] - interface kernels on element side quadrature points" << std::endl;);
  }
}

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.

{
  _blocks_exec_printed.clear();
  _boundaries_exec_printed.clear();
}

shouldComputeInternalSide()

bool NonlinearThread::shouldComputeInternalSide ( const Elem &  elem, const Elem &  neighbor  ) const

overridevirtualinherited

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 557 of file NonlinearThread.C.

{
  // ThreadedElementLoop<ConstElemRange>::shouldComputeInternalSide gets expensive on high
  // h-refinement cases so we avoid it if possible
  _should_execute_dg = false;
  if (_subdomain_has_dg)
    _should_execute_dg =
        ThreadedElementLoop<ConstElemRange>::shouldComputeInternalSide(elem, neighbor);
  return _subdomain_has_hdg || _should_execute_dg;
}

subdomainChanged()

void NonlinearThread::subdomainChanged ( )

overridevirtualinherited

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

Definition at line 72 of file NonlinearThread.C.

{
  // This should come first to setup the residual objects before we do dependency determination of
  // material properties and variables
  determineObjectWarehouses();
 
  _fe_problem.subdomainSetup(_subdomain, _tid);
 
  // Update variable Dependencies
  std::set<MooseVariableFEBase *> needed_moose_vars;
  _tag_kernels->updateBlockVariableDependency(_subdomain, needed_moose_vars, _tid);
  _ibc_warehouse->updateBoundaryVariableDependency(needed_moose_vars, _tid);
  _dg_warehouse->updateBlockVariableDependency(_subdomain, needed_moose_vars, _tid);
  _ik_warehouse->updateBoundaryVariableDependency(needed_moose_vars, _tid);
 
  // Update FE variable coupleable vector tags
  std::set<TagID> needed_fe_var_vector_tags;
  _tag_kernels->updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_fe_var_vector_tags, _tid);
  _ibc_warehouse->updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_fe_var_vector_tags, _tid);
  _fe_problem.getMaterialWarehouse().updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_fe_var_vector_tags, _tid);
 
  // Update material dependencies
  std::unordered_set<unsigned int> needed_mat_props;
  _tag_kernels->updateBlockMatPropDependency(_subdomain, needed_mat_props, _tid);
  _ibc_warehouse->updateBoundaryMatPropDependency(needed_mat_props, _tid);
  _dg_warehouse->updateBlockMatPropDependency(_subdomain, needed_mat_props, _tid);
  _ik_warehouse->updateBoundaryMatPropDependency(needed_mat_props, _tid);
 
  if (_fe_problem.haveFV())
  {
    // Re-query the finite volume elemental kernels
    _fv_kernels.clear();
    _fe_problem.theWarehouse()
        .query()
        .template condition<AttribSysNum>(_nl.number())
        .template condition<AttribSystem>("FVElementalKernel")
        .template condition<AttribSubdomains>(_subdomain)
        .template condition<AttribThread>(_tid)
        .queryInto(_fv_kernels);
    for (const auto fv_kernel : _fv_kernels)
    {
      const auto & fv_mv_deps = fv_kernel->getMooseVariableDependencies();
      needed_moose_vars.insert(fv_mv_deps.begin(), fv_mv_deps.end());
      const auto & fv_mp_deps = fv_kernel->getMatPropDependencies();
      needed_mat_props.insert(fv_mp_deps.begin(), fv_mp_deps.end());
    }
  }
 
  // Cache these to avoid computing them on every side
  _subdomain_has_dg = _dg_warehouse->hasActiveBlockObjects(_subdomain, _tid);
  _subdomain_has_hdg = _hdg_warehouse->hasActiveBlockObjects(_subdomain, _tid);
 
  _fe_problem.setActiveElementalMooseVariables(needed_moose_vars, _tid);
  _fe_problem.setActiveFEVariableCoupleableVectorTags(needed_fe_var_vector_tags, _tid);
  _fe_problem.prepareMaterials(needed_mat_props, _subdomain, _tid);
}

Referenced by ComputeJacobianForScalingThread::operator()().

Member Data Documentation

_blocks_exec_printed

template<typename RangeType >

std::set<SubdomainID> ThreadedElementLoopBase< RangeType >::_blocks_exec_printed

mutableprotectedinherited

Keep track of which blocks were visited.

Definition at line 190 of file ThreadedElementLoopBase.h.

Referenced by ComputeDiracThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeUserObjectsThread::printBlockExecutionInformation(), and NonlinearThread::printBlockExecutionInformation().

_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().

_dg_kernels

MooseObjectTagWarehouse<DGKernelBase>& NonlinearThread::_dg_kernels

protectedinherited

Reference to DGKernel storage structure.

Definition at line 168 of file NonlinearThread.h.

Referenced by ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), and NonlinearThread::printBlockExecutionInformation().

_dg_warehouse

MooseObjectWarehouse<DGKernelBase>* NonlinearThread::_dg_warehouse

protectedinherited

Definition at line 170 of file NonlinearThread.h.

Referenced by NonlinearThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), ComputeJacobianBlocksThread::postInternalSide(), and NonlinearThread::subdomainChanged().

_elem_side_builder

libMesh::ElemSideBuilder NonlinearThread::_elem_side_builder

privateinherited

Builds (and caches) the side element for elem/side pairs in onInterfaceWithHRefinementMismatch.

Definition at line 209 of file NonlinearThread.h.

Referenced by NonlinearThread::onInterfaceWithHRefinementMismatch().

_fe_problem

FEProblemBase& ThreadedElementLoop< ConstElemRange >::_fe_problem

protectedinherited

Definition at line 69 of file ThreadedElementLoop.h.

_fv_kernels

std::vector<FVElementalKernel *> NonlinearThread::_fv_kernels

protectedinherited

Current subdomain FVElementalKernels.

Definition at line 192 of file NonlinearThread.h.

Referenced by NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), and NonlinearThread::printBlockExecutionInformation().

_has_active_objects

const bool NonlinearThread::_has_active_objects

protectedinherited

Whether there are any active residual objects; otherwise we will do an early return.

Definition at line 195 of file NonlinearThread.h.

Referenced by NonlinearThread::operator()().

_hdg_kernels

MooseObjectTagWarehouse<HDGKernel>& NonlinearThread::_hdg_kernels

protectedinherited

Reference to HDGKernel storage structures

Definition at line 186 of file NonlinearThread.h.

Referenced by ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), and determineObjectWarehouses().

_hdg_warehouse

MooseObjectWarehouse<HDGKernel>* NonlinearThread::_hdg_warehouse

protectedinherited

Definition at line 188 of file NonlinearThread.h.

Referenced by ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), computeOnInternalFace(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), and determineObjectWarehouses().

_ibc_warehouse

MooseObjectWarehouse<IntegratedBCBase>* NonlinearThread::_ibc_warehouse

protectedinherited

Definition at line 165 of file NonlinearThread.h.

Referenced by NonlinearThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnBoundary(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), NonlinearThread::onBoundary(), and NonlinearThread::subdomainChanged().

_ik_warehouse

MooseObjectWarehouse<InterfaceKernelBase>* NonlinearThread::_ik_warehouse

protectedinherited

Definition at line 175 of file NonlinearThread.h.

Referenced by NonlinearThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInterface(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), NonlinearThread::onExternalSide(), NonlinearThread::onInterface(), NonlinearThread::onInterfaceWithHRefinementMismatch(), and NonlinearThread::subdomainChanged().

_integrated_bcs

MooseObjectTagWarehouse<IntegratedBCBase>& NonlinearThread::_integrated_bcs

protectedinherited

Reference to BC storage structures.

Definition at line 163 of file NonlinearThread.h.

Referenced by ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), NonlinearThread::printBlockExecutionInformation(), and NonlinearThread::printBoundaryExecutionInformation().

_interface_kernels

MooseObjectTagWarehouse<InterfaceKernelBase>& NonlinearThread::_interface_kernels

protectedinherited

Reference to interface kernel storage structure.

Definition at line 173 of file NonlinearThread.h.

Referenced by ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), NonlinearThread::printBlockExecutionInformation(), and NonlinearThread::printBoundaryExecutionInformation().

_kernels

MooseObjectTagWarehouse<KernelBase>& NonlinearThread::_kernels

protectedinherited

Reference to Kernel storage structures

Definition at line 179 of file NonlinearThread.h.

Referenced by ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), and NonlinearThread::printBlockExecutionInformation().

_mesh

template<typename RangeType >

MooseMesh& ThreadedElementLoopBase< RangeType >::_mesh

protectedinherited

Definition at line 165 of file ThreadedElementLoopBase.h.

Referenced by ProjectMaterialProperties::onBoundary(), ProjectMaterialProperties::onElement(), NonlinearThread::onExternalSide(), ProjectMaterialProperties::onInternalSide(), NonlinearThread::printBlockExecutionInformation(), and NonlinearThread::printBoundaryExecutionInformation().

_neighbor_subdomain

template<typename RangeType >

SubdomainID ThreadedElementLoopBase< RangeType >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 175 of file ThreadedElementLoopBase.h.

Referenced by ComputeFullJacobianThread::computeOnInternalFace(), computeOnInternalFace(), and ComputeJacobianForScalingThread::operator()().

_nl

NonlinearSystemBase& NonlinearThread::_nl

protectedinherited

Reference to the underlying NonlinearSystemBase.

Definition at line 158 of file NonlinearThread.h.

Referenced by ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), ComputeJacobianForScalingThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), ComputeJacobianThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), NonlinearThread::onElement(), and ComputeJacobianThread::postElement().

_num_cached

unsigned int NonlinearThread::_num_cached

protectedinherited

Definition at line 160 of file NonlinearThread.h.

Referenced by ComputeResidualAndJacobianThread::accumulate(), accumulate(), and ComputeJacobianThread::postElement().

_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()().

_should_execute_dg

bool NonlinearThread::_should_execute_dg

mutableprivateinherited

Whether DG kernels should be executed for a given elem-neighbor pairing.

This is determined by calling down to our parent (ThreadedElementLoop) class's shouldComputeOnInternalSide method which checks things like whether the elem id is less than the neighbor id such that we make sure we do not execute DGKernels twice on the same face

Definition at line 202 of file NonlinearThread.h.

Referenced by NonlinearThread::onInternalSide(), and NonlinearThread::shouldComputeInternalSide().

_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 ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), 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().

_subdomain_has_dg

bool NonlinearThread::_subdomain_has_dg

privateinherited

Whether the subdomain has DGKernels.

Definition at line 204 of file NonlinearThread.h.

Referenced by NonlinearThread::shouldComputeInternalSide().

_subdomain_has_hdg

bool NonlinearThread::_subdomain_has_hdg

privateinherited

Whether the subdomain has HDGKernels.

Definition at line 206 of file NonlinearThread.h.

Referenced by NonlinearThread::onInternalSide(), and NonlinearThread::shouldComputeInternalSide().

_tag_kernels

MooseObjectWarehouse<KernelBase>* NonlinearThread::_tag_kernels

protectedinherited

Definition at line 181 of file NonlinearThread.h.

Referenced by NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), and NonlinearThread::subdomainChanged().

_tags

const std::set<TagID>& ComputeResidualThread::_tags

protected

the tags denoting the vectors we want our residual objects to fill

Definition at line 43 of file ComputeResidualThread.h.

Referenced by determineObjectWarehouses().

_tid

template<typename RangeType >

THREAD_ID ThreadedElementLoopBase< RangeType >::_tid

protectedinherited

Definition at line 166 of file ThreadedElementLoopBase.h.

Referenced by ComputeResidualAndJacobianThread::accumulate(), accumulate(), ComputeJacobianThread::accumulateLower(), ComputeResidualAndJacobianThread::accumulateLower(), accumulateLower(), ComputeJacobianThread::accumulateNeighbor(), ComputeResidualAndJacobianThread::accumulateNeighbor(), accumulateNeighbor(), ComputeJacobianThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::accumulateNeighborLower(), accumulateNeighborLower(), NonlinearThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), determineObjectWarehouses(), ComputeUserObjectsThread::getInterfaceMaterialReinitCache(), ComputeUserObjectsThread::getInternalSideMaterialReinitCache(), 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(), NonlinearThread::onInterfaceWithHRefinementMismatch(), 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:

• include/loops/ComputeResidualThread.h
• src/loops/ComputeResidualThread.C