Specialization for filling multiple "small" preconditioning matrices simulatenously. More...

#include <ComputeJacobianBlocksThread.h>

Inheritance diagram for ComputeJacobianBlocksThread:

Public Member Functions
	ComputeJacobianBlocksThread (FEProblemBase &fe_problem, std::vector< JacobianBlock * > &blocks, const std::set< TagID > &tags)

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

virtual	~ComputeJacobianBlocksThread ()

void	join (const ComputeJacobianThread &)

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

Protected Member Functions
virtual void	postElement (const Elem *elem) override
	Called after the element assembly is done (including surface assembling)

virtual void	postInternalSide (const Elem *elem, unsigned int side) override
	Called after evaluations on an element internal side.

virtual void	computeOnElement () override

virtual void	computeOnBoundary (BoundaryID bnd_id, const Elem *lower_d_elem) override

virtual void	computeOnInternalFace (const Elem *neighbor) override

virtual void	computeOnInternalFace () override

virtual void	computeOnInterface (BoundaryID bnd_id) override

void	determineObjectWarehouses () override
	Determine the objects we will actually compute based on vector/matrix tag information.

void	accumulateNeighbor () override
	Add neighbor residual/Jacobian into assembly global data.

virtual void	accumulateNeighborLower () override
	Add neighbor and lower residual/Jacobian into assembly global data.

virtual void	accumulateLower () override
	Add lower-d residual/Jacobian into assembly global data.

virtual void	accumulate () override
	Add element residual/Jacobian into assembly global data.

virtual void	compute (ResidualObject &) override
	Will dispatch to computeResidual/computeJacobian/computeResidualAndJacobian based on the derived class.

void	compute (KernelBase &kernel) override

void	compute (FVElementalKernel &kernel) override

void	compute (IntegratedBCBase &bc) override

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

void	compute (InterfaceKernelBase &ik) override

std::string	objectType () const override
	Return what the loops is meant to compute.

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

Protected Attributes
std::vector< JacobianBlock * >	_blocks

const std::set< TagID > &	_tags

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
std::vector< dof_id_type >	_dof_indices

std::vector< dof_id_type >	_dof_neighbor_indices

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.

Detailed Description

Specialization for filling multiple "small" preconditioning matrices simulatenously.

Definition at line 39 of file ComputeJacobianBlocksThread.h.

Constructor & Destructor Documentation

◆ ComputeJacobianBlocksThread() [1/2]

ComputeJacobianBlocksThread::ComputeJacobianBlocksThread	(	FEProblemBase &	fe_problem,
		std::vector< JacobianBlock * > &	blocks,
		const std::set< TagID > &	tags
	)

Definition at line 21 of file ComputeJacobianBlocksThread.C.

  : ComputeFullJacobianThread(fe_problem, tags), _blocks(blocks)
{
}

◆ ComputeJacobianBlocksThread() [2/2]

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

Definition at line 29 of file ComputeJacobianBlocksThread.C.

  : ComputeFullJacobianThread(x, split), _blocks(x._blocks)
{
}

◆ ~ComputeJacobianBlocksThread()

ComputeJacobianBlocksThread::~ComputeJacobianBlocksThread ( )

virtual

Definition at line 35 of file ComputeJacobianBlocksThread.C.

35{}

Member Function Documentation

◆ accumulate()

virtual void ComputeJacobianThread::accumulate ( )

inlineoverrideprotectedvirtualinherited

Add element residual/Jacobian into assembly global data.

Implements NonlinearThread.

Definition at line 47 of file ComputeJacobianThread.h.

47{}

◆ accumulateLower()

void ComputeJacobianThread::accumulateLower ( )

overrideprotectedvirtualinherited

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

Implements NonlinearThread.

Definition at line 134 of file ComputeJacobianThread.C.

{
  _fe_problem.addJacobianLowerD(_tid);
}

◆ accumulateNeighbor()

void ComputeJacobianThread::accumulateNeighbor ( )

overrideprotectedvirtualinherited

Add neighbor residual/Jacobian into assembly global data.

Implements NonlinearThread.

Definition at line 146 of file ComputeJacobianThread.C.

{
  _fe_problem.addJacobianNeighbor(_tid);
}

◆ accumulateNeighborLower()

void ComputeJacobianThread::accumulateNeighborLower ( )

overrideprotectedvirtualinherited

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

Implements NonlinearThread.

Definition at line 140 of file ComputeJacobianThread.C.

{
  _fe_problem.addJacobianNeighborLowerD(_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 43 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 60 of file ThreadedElementLoop.h.

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

◆ compute() [1/6]

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

overrideprotectedvirtualinherited

Reimplemented from NonlinearThread.

Definition at line 77 of file ComputeJacobianThread.C.

{
  if (dg.isImplicit())
  {
    dg.prepareShapes(dg.variable().number());
    dg.prepareNeighborShapes(dg.variable().number());
    if (dg.hasBlocks(neighbor->subdomain_id()))
      dg.computeJacobian();
  }
}

◆ compute() [2/6]

void ComputeJacobianThread::compute ( FVElementalKernel & kernel )

overrideprotectedvirtualinherited

Reimplemented from NonlinearThread.

Definition at line 56 of file ComputeJacobianThread.C.

{
  if (fvkernel.isImplicit())
    fvkernel.computeJacobian();
}

◆ compute() [3/6]

void ComputeJacobianThread::compute ( IntegratedBCBase & bc )

overrideprotectedvirtualinherited

Reimplemented from NonlinearThread.

Definition at line 63 of file ComputeJacobianThread.C.

{
  if (bc.shouldApply() && bc.isImplicit())
  {
    bc.prepareShapes(bc.variable().number());
    bc.computeJacobian();
    if (_fe_problem.checkNonlocalCouplingRequirement() && !_fe_problem.computingScalingJacobian())
      mooseError("Nonlocal boundary conditions only supported for non-diagonal coupling. Please "
                 "specify an SMP preconditioner, with appropriate row-column coupling or specify "
                 "full = true.");
  }
}

◆ compute() [4/6]

void ComputeJacobianThread::compute ( InterfaceKernelBase & ik )

overrideprotectedvirtualinherited

Reimplemented from NonlinearThread.

Definition at line 89 of file ComputeJacobianThread.C.

{
  if (intk.isImplicit())
  {
    intk.prepareShapes(intk.variable().number());
    intk.prepareNeighborShapes(intk.neighborVariable().number());
    intk.computeJacobian();
  }
}

◆ compute() [5/6]

void ComputeJacobianThread::compute ( KernelBase & kernel )

overrideprotectedvirtualinherited

Defaults to forwarding to the residual object class

Reimplemented from NonlinearThread.

Definition at line 43 of file ComputeJacobianThread.C.

{
  if (kernel.isImplicit())
  {
    kernel.prepareShapes(kernel.variable().number());
    kernel.computeJacobian();
    if (_fe_problem.checkNonlocalCouplingRequirement() && !_fe_problem.computingScalingJacobian())
      mooseError("Nonlocal kernels only supported for non-diagonal coupling. Please specify an SMP "
                 "preconditioner, with appropriate row-column coupling or specify full = true.");
  }
}

◆ compute() [6/6]

virtual void ComputeJacobianThread::compute ( ResidualObject & ro )

inlineoverrideprotectedvirtualinherited

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

Implements NonlinearThread.

Definition at line 49 of file ComputeJacobianThread.h.

49{ mooseError("Not implemented"); };

◆ computeOnBoundary()

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

overrideprotectedvirtualinherited

done only when nonlocal integrated_bcs exist in the system

Reimplemented from NonlinearThread.

Definition at line 137 of file ComputeFullJacobianThread.C.

{
  auto & ce = _fe_problem.couplingEntries(_tid, _nl.number());
  for (const auto & it : ce)
  {
    MooseVariableFieldBase & ivariable = *(it.first);
    MooseVariableFieldBase & jvariable = *(it.second);
 
    // We don't currently support coupling with FV variables
    if (ivariable.isFV() || jvariable.isFV())
      continue;
 
    const auto ivar = ivariable.number();
    const auto jvar = jvariable.number();
 
    if (!ivariable.activeOnSubdomain(_subdomain))
      continue;
 
    // only if there are dofs for j-variable (if it is subdomain restricted var, there may not be
    // any)
    if (lower_d_elem)
    {
      auto lower_d_subdomain = lower_d_elem->subdomain_id();
      if (!jvariable.activeOnSubdomain(_subdomain) &&
          !jvariable.activeOnSubdomain(lower_d_subdomain))
        continue;
    }
    else
    {
      if (!jvariable.activeOnSubdomain(_subdomain))
        continue;
    }
 
    if (!_ibc_warehouse->hasActiveBoundaryObjects(bnd_id, _tid))
      continue;
 
    const auto & bcs = _ibc_warehouse->getActiveBoundaryObjects(bnd_id, _tid);
    for (const auto & bc : bcs)
      if (bc->shouldApply() && bc->variable().number() == ivar && bc->isImplicit())
      {
        bc->prepareShapes(jvar);
        bc->computeOffDiagJacobian(jvar);
      }
  }
 
  if (_fe_problem.checkNonlocalCouplingRequirement())
  {
    auto & cne = _fe_problem.nonlocalCouplingEntries(_tid, _nl.number());
    for (const auto & it : cne)
    {
      MooseVariableFieldBase & ivariable = *(it.first);
      MooseVariableFieldBase & jvariable = *(it.second);
 
      if (ivariable.isFV())
        continue;
 
      unsigned int ivar = ivariable.number();
      unsigned int jvar = jvariable.number();
 
      if (ivariable.activeOnSubdomain(_subdomain) && jvariable.activeOnSubdomain(_subdomain) &&
          _ibc_warehouse->hasActiveBoundaryObjects(bnd_id, _tid))
      {
        const std::vector<std::shared_ptr<IntegratedBCBase>> & integrated_bcs =
            _ibc_warehouse->getBoundaryObjects(bnd_id, _tid);
        for (const auto & integrated_bc : integrated_bcs)
        {
          std::shared_ptr<NonlocalIntegratedBC> nonlocal_integrated_bc =
              std::dynamic_pointer_cast<NonlocalIntegratedBC>(integrated_bc);
          if (nonlocal_integrated_bc)
            if ((integrated_bc->variable().number() == ivar) && integrated_bc->isImplicit())
            {
              integrated_bc->prepareShapes(jvar);
              integrated_bc->computeNonlocalOffDiagJacobian(jvar);
            }
        }
      }
    }
  }
 
  const std::vector<MooseVariableScalar *> & scalar_vars = _nl.getScalarVariables(_tid);
  if (scalar_vars.size() > 0)
  {
    // go over nl-variables (non-scalar)
    const std::vector<MooseVariableFieldBase *> & vars = _nl.getVariables(_tid);
    for (const auto & ivar : vars)
      if (ivar->activeOnSubdomain(_subdomain) > 0 &&
          _ibc_warehouse->hasActiveBoundaryObjects(bnd_id, _tid))
      {
        // for each variable get the list of active kernels
        const auto & bcs = _ibc_warehouse->getActiveBoundaryObjects(bnd_id, _tid);
        for (const auto & bc : bcs)
          if (bc->variable().number() == ivar->number() && bc->isImplicit())
          {
            // now, get the list of coupled scalar vars and compute their off-diag jacobians
            const std::vector<MooseVariableScalar *> coupled_scalar_vars =
                bc->getCoupledMooseScalarVars();
 
            // Do: dvar / dscalar_var, only want to process only nl-variables (not aux ones)
            for (const auto & jvar : coupled_scalar_vars)
              if (_nl.hasScalarVariable(jvar->name()))
                bc->computeOffDiagJacobianScalar(jvar->number());
          }
      }
  }
}

◆ computeOnElement()

void ComputeFullJacobianThread::computeOnElement ( )

overrideprotectedvirtualinherited

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

done only when nonlocal kernels exist in the system

Reimplemented from NonlinearThread.

Reimplemented in ComputeJacobianForScalingThread.

Definition at line 41 of file ComputeFullJacobianThread.C.

{
  auto & ce = _fe_problem.couplingEntries(_tid, _nl.number());
  for (const auto & it : ce)
  {
    MooseVariableFieldBase & ivariable = *(it.first);
    MooseVariableFieldBase & jvariable = *(it.second);
 
    if (ivariable.isFV())
      continue;
 
    unsigned int ivar = ivariable.number();
    unsigned int jvar = jvariable.number();
 
    if (ivariable.activeOnSubdomain(_subdomain) && jvariable.activeOnSubdomain(_subdomain) &&
        _tag_kernels->hasActiveVariableBlockObjects(ivar, _subdomain, _tid))
    {
      // only if there are dofs for j-variable (if it is subdomain restricted var, there may not be
      // any)
      const auto & kernels = _tag_kernels->getActiveVariableBlockObjects(ivar, _subdomain, _tid);
      for (const auto & kernel : kernels)
        if ((kernel->variable().number() == ivar) && kernel->isImplicit())
        {
          kernel->prepareShapes(jvar);
          kernel->computeOffDiagJacobian(jvar);
        }
    }
  }
 
  if (_fe_problem.checkNonlocalCouplingRequirement())
  {
    auto & cne = _fe_problem.nonlocalCouplingEntries(_tid, _nl.number());
    for (const auto & it : cne)
    {
      MooseVariableFieldBase & ivariable = *(it.first);
      MooseVariableFieldBase & jvariable = *(it.second);
 
      if (ivariable.isFV())
        continue;
 
      unsigned int ivar = ivariable.number();
      unsigned int jvar = jvariable.number();
 
      if (ivariable.activeOnSubdomain(_subdomain) && jvariable.activeOnSubdomain(_subdomain) &&
          _tag_kernels->hasActiveVariableBlockObjects(ivar, _subdomain, _tid))
      {
        const auto & kernels = _tag_kernels->getActiveVariableBlockObjects(ivar, _subdomain, _tid);
        for (const auto & kernel : kernels)
        {
          std::shared_ptr<NonlocalKernel> nonlocal_kernel =
              std::dynamic_pointer_cast<NonlocalKernel>(kernel);
          if (nonlocal_kernel)
            if ((kernel->variable().number() == ivar) && kernel->isImplicit())
            {
              kernel->prepareShapes(jvar);
              kernel->computeNonlocalOffDiagJacobian(jvar);
            }
        }
      }
    }
  }
 
  const std::vector<MooseVariableScalar *> & scalar_vars = _nl.getScalarVariables(_tid);
  if (scalar_vars.size() > 0)
  {
    // go over nl-variables (non-scalar)
    const std::vector<MooseVariableFieldBase *> & vars = _nl.getVariables(_tid);
    for (const auto & ivariable : vars)
      if (ivariable->activeOnSubdomain(_subdomain) > 0 &&
          _tag_kernels->hasActiveVariableBlockObjects(ivariable->number(), _subdomain, _tid))
      {
        // for each variable get the list of active kernels
        const auto & kernels =
            _tag_kernels->getActiveVariableBlockObjects(ivariable->number(), _subdomain, _tid);
        for (const auto & kernel : kernels)
          if (kernel->isImplicit())
          {
            // now, get the list of coupled scalar vars and compute their off-diag jacobians
            const auto & coupled_scalar_vars = kernel->getCoupledMooseScalarVars();
 
            // Do: dvar / dscalar_var, only want to process only nl-variables (not aux ones)
            for (const auto & jvariable : coupled_scalar_vars)
              if (_nl.hasScalarVariable(jvariable->name()))
                kernel->computeOffDiagJacobianScalar(jvariable->number());
          }
      }
  }
 
  if (_fe_problem.haveFV())
    for (auto fv_kernel : _fv_kernels)
      if (fv_kernel->isImplicit())
        fv_kernel->computeOffDiagJacobian();
}

Referenced by ComputeJacobianForScalingThread::computeOnElement().

◆ computeOnInterface()

void ComputeFullJacobianThread::computeOnInterface ( BoundaryID bnd_id )

overrideprotectedvirtualinherited

Reimplemented from NonlinearThread.

Definition at line 245 of file ComputeFullJacobianThread.C.

{
  if (_ik_warehouse->hasActiveBoundaryObjects(bnd_id, _tid))
  {
    const auto & ce = _fe_problem.couplingEntries(_tid, _nl.number());
    for (const auto & it : ce)
    {
      MooseVariableFieldBase & ivariable = *(it.first);
      MooseVariableFieldBase & jvariable = *(it.second);
 
      if (ivariable.isFV())
        continue;
 
      unsigned int ivar = ivariable.number();
      unsigned int jvar = jvariable.number();
 
      const auto & int_ks = _ik_warehouse->getActiveBoundaryObjects(bnd_id, _tid);
      for (const auto & interface_kernel : int_ks)
      {
        if (!interface_kernel->isImplicit())
          continue;
 
        interface_kernel->prepareShapes(jvar);
        interface_kernel->prepareNeighborShapes(jvar);
 
        if (interface_kernel->variable().number() == ivar)
          interface_kernel->computeElementOffDiagJacobian(jvar);
 
        if (interface_kernel->neighborVariable().number() == ivar)
          interface_kernel->computeNeighborOffDiagJacobian(jvar);
      }
    }
  }
}

◆ computeOnInternalFace() [1/2]

void ComputeFullJacobianThread::computeOnInternalFace ( )

overrideprotectedvirtualinherited

Reimplemented from ComputeJacobianThread.

Definition at line 316 of file ComputeFullJacobianThread.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->computeJacobianOnSide();
  }
}

◆ computeOnInternalFace() [2/2]

void ComputeFullJacobianThread::computeOnInternalFace ( const Elem * neighbor )

overrideprotectedvirtualinherited

Reimplemented from NonlinearThread.

Definition at line 281 of file ComputeFullJacobianThread.C.

{
  if (_dg_warehouse->hasActiveBlockObjects(_subdomain, _tid))
  {
    const auto & ce = _fe_problem.couplingEntries(_tid, _nl.number());
    for (const auto & it : ce)
    {
      MooseVariableFieldBase & ivariable = *(it.first);
      MooseVariableFieldBase & jvariable = *(it.second);
 
      if (ivariable.isFV())
        continue;
 
      unsigned int ivar = ivariable.number();
      unsigned int jvar = jvariable.number();
 
      const auto & dgks = _dg_warehouse->getActiveBlockObjects(_subdomain, _tid);
      for (const auto & dg : dgks)
      {
        // this check may skip some couplings...
        if (dg->variable().number() == ivar && dg->isImplicit() &&
            dg->hasBlocks(neighbor->subdomain_id()) &&
            (jvariable.activeOnSubdomain(_subdomain) ||
             jvariable.activeOnSubdomains(_fe_problem.mesh().interiorLowerDBlocks())))
        {
          dg->prepareShapes(jvar);
          dg->prepareNeighborShapes(jvar);
          dg->computeOffDiagJacobian(jvar);
        }
      }
    }
  }
}

◆ determineObjectWarehouses()

void ComputeJacobianThread::determineObjectWarehouses ( )

overrideprotectedvirtualinherited

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

Implements NonlinearThread.

Definition at line 100 of file ComputeJacobianThread.C.

{
  // If users pass a empty vector or a full size of vector,
  // we take all kernels
  if (!_tags.size() || _tags.size() == _fe_problem.numMatrixTags())
  {
    _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.getMatrixTagObjectWarehouse(*(_tags.begin()), _tid));
    _dg_warehouse = &(_dg_kernels.getMatrixTagObjectWarehouse(*(_tags.begin()), _tid));
    _ibc_warehouse = &(_integrated_bcs.getMatrixTagObjectWarehouse(*(_tags.begin()), _tid));
    _ik_warehouse = &(_interface_kernels.getMatrixTagObjectWarehouse(*(_tags.begin()), _tid));
    _hdg_warehouse = &(_hdg_kernels.getMatrixTagObjectWarehouse(*(_tags.begin()), _tid));
  }
  // This one may be expensive, and hopefully we do not use it so often
  else
  {
    _tag_kernels = &(_kernels.getMatrixTagsObjectWarehouse(_tags, _tid));
    _dg_warehouse = &(_dg_kernels.getMatrixTagsObjectWarehouse(_tags, _tid));
    _ibc_warehouse = &(_integrated_bcs.getMatrixTagsObjectWarehouse(_tags, _tid));
    _ik_warehouse = &(_interface_kernels.getMatrixTagsObjectWarehouse(_tags, _tid));
    _hdg_warehouse = &(_hdg_kernels.getMatrixTagsObjectWarehouse(_tags, _tid));
  }
}

◆ join()

void ComputeJacobianBlocksThread::join ( const ComputeJacobianThread & )

inline

Definition at line 51 of file ComputeJacobianBlocksThread.h.

51{}

◆ keepGoing()

virtual bool ThreadedElementLoop< ConstElemRange >::keepGoing ( )

inlineoverridevirtualinherited

Whether or not the loop should continue.

Returns: true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 45 of file ThreadedElementLoop.h.

45{ return !_fe_problem.hasException(); }

FEProblemBase::hasException

virtual bool hasException()

Whether or not an exception has occurred.

Definition FEProblemBase.h:535

◆ neighborSubdomainChanged()

void ThreadedElementLoop< ConstElemRange >::neighborSubdomainChanged ( )

overridevirtualinherited

Called every time the neighbor subdomain changes (i.e.

the subdomain of this neighbor is not the same as the subdomain of the last neighbor). Beware of over-using this! You might think that you can do some expensive stuff in here and get away with it... but there are applications that have TONS of subdomains....

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 56 of file ThreadedElementLoop.h.

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

◆ objectType()

std::string ComputeJacobianThread::objectType ( ) const

inlineoverrideprotectedvirtualinherited

Return what the loops is meant to compute.

Reimplemented from NonlinearThread.

Definition at line 58 of file ComputeJacobianThread.h.

58{ return "Jacobian"; }

◆ 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 160 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 129 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 270 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 191 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();
    }
  }
}

◆ 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 235 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 61 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 335 of file NonlinearThread.C.

{
  clearVarsAndMaterials();
}

Referenced by ComputeJacobianForScalingThread::operator()().

◆ postElement()

void ComputeJacobianBlocksThread::postElement ( const Elem * elem )

overrideprotectedvirtual

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

Parameters

elem	- active element

Reimplemented from ComputeJacobianThread.

Definition at line 38 of file ComputeJacobianBlocksThread.C.

{
  _dof_indices.clear();
 
  for (const auto & block : _blocks)
  {
    const auto & dof_map = block->_precond_system.get_dof_map();
    dof_map.dof_indices(elem, _dof_indices);
 
    _fe_problem.addJacobianBlockTags(
        block->_jacobian, block->_ivar, block->_jvar, dof_map, _dof_indices, _tags, _tid);
  }
}

◆ postInternalSide()

void ComputeJacobianBlocksThread::postInternalSide	(	const Elem *	elem,
		unsigned int	side
	)

overrideprotectedvirtual

Called after 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 53 of file ComputeJacobianBlocksThread.C.

{
  if (_dg_warehouse->hasActiveBlockObjects(_subdomain, _tid))
  {
    _dof_indices.clear();
    _dof_neighbor_indices.clear();
 
    // Pointer to the neighbor we are currently working on.
    const Elem * neighbor = elem->neighbor_ptr(side);
 
    // Get the global id of the element and the neighbor
    const auto elem_id = elem->id(), neighbor_id = neighbor->id();
 
    if ((neighbor->active() && (neighbor->level() == elem->level()) && (elem_id < neighbor_id)) ||
        (neighbor->level() < elem->level()))
      for (const auto & block : _blocks)
      {
        const auto & dof_map = block->_precond_system.get_dof_map();
        dof_map.dof_indices(elem, _dof_indices);
        dof_map.dof_indices(neighbor, _dof_neighbor_indices);
 
        _fe_problem.addJacobianNeighbor(block->_jacobian,
                                        block->_ivar,
                                        block->_jvar,
                                        dof_map,
                                        _dof_indices,
                                        _dof_neighbor_indices,
                                        _tags,
                                        _tid);
      }
  }
}

◆ pre()

template<typename RangeType >

void ThreadedElementLoopBase< RangeType >::pre ( )

virtualinherited

Called before the element range loop.

Reimplemented in ComputeDiracThread.

Definition at line 332 of file ThreadedElementLoopBase.h.

333{

334}

Referenced by ComputeJacobianForScalingThread::operator()().

◆ preBoundary()

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

overridevirtualinherited

Called before the boundary assembly.

Parameters

elem	- The element we are checking is on the boundary.
side	- The side of the element in question.
bnd_id	- ID of the boundary we are at
lower_d_elem	- Lower dimensional element (e.g. Mortar)

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 51 of file ThreadedElementLoop.h.

{
  _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 47 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 49 of file ThreadedElementLoop.h.

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

◆ prepareElement()

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

protectedinherited

Definition at line 59 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 437 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 361 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 406 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 80 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 76 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 341 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 459 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 68 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

std::vector<JacobianBlock *> ComputeJacobianBlocksThread::_blocks

protected

Definition at line 58 of file ComputeJacobianBlocksThread.h.

Referenced by postElement(), and postInternalSide().

◆ _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 143 of file NonlinearThread.h.

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

◆ _dg_warehouse

MooseObjectWarehouse<DGKernelBase>* NonlinearThread::_dg_warehouse

protectedinherited

Definition at line 145 of file NonlinearThread.h.

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

◆ _dof_indices

std::vector<dof_id_type> ComputeJacobianBlocksThread::_dof_indices

private

Definition at line 61 of file ComputeJacobianBlocksThread.h.

Referenced by postElement(), and postInternalSide().

◆ _dof_neighbor_indices

std::vector<dof_id_type> ComputeJacobianBlocksThread::_dof_neighbor_indices

private

Definition at line 63 of file ComputeJacobianBlocksThread.h.

Referenced by postInternalSide().

◆ _fe_problem

FEProblemBase& ThreadedElementLoop< ConstElemRange >::_fe_problem

protectedinherited

Definition at line 62 of file ThreadedElementLoop.h.

◆ _fv_kernels

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

protectedinherited

Current subdomain FVElementalKernels.

Definition at line 167 of file NonlinearThread.h.

Referenced by ComputeResidualAndJacobianThread::compute(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeResidualThread::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 170 of file NonlinearThread.h.

Referenced by NonlinearThread::operator()().

◆ _hdg_kernels

MooseObjectTagWarehouse<HDGKernel>& NonlinearThread::_hdg_kernels

protectedinherited

Reference to HDGKernel storage structures

Definition at line 161 of file NonlinearThread.h.

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

◆ _hdg_warehouse

MooseObjectWarehouse<HDGKernel>* NonlinearThread::_hdg_warehouse

protectedinherited

Definition at line 163 of file NonlinearThread.h.

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

◆ _ibc_warehouse

MooseObjectWarehouse<IntegratedBCBase>* NonlinearThread::_ibc_warehouse

protectedinherited

Definition at line 140 of file NonlinearThread.h.

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

◆ _ik_warehouse

MooseObjectWarehouse<InterfaceKernelBase>* NonlinearThread::_ik_warehouse

protectedinherited

Definition at line 150 of file NonlinearThread.h.

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

◆ _integrated_bcs

MooseObjectTagWarehouse<IntegratedBCBase>& NonlinearThread::_integrated_bcs

protectedinherited

Reference to BC storage structures.

Definition at line 138 of file NonlinearThread.h.

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

◆ _interface_kernels

MooseObjectTagWarehouse<InterfaceKernelBase>& NonlinearThread::_interface_kernels

protectedinherited

Reference to interface kernel storage structure.

Definition at line 148 of file NonlinearThread.h.

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

◆ _kernels

MooseObjectTagWarehouse<KernelBase>& NonlinearThread::_kernels

protectedinherited

Reference to Kernel storage structures

Definition at line 154 of file NonlinearThread.h.

Referenced by ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeResidualThread::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(), ComputeResidualThread::computeOnInternalFace(), and ComputeJacobianForScalingThread::operator()().

◆ _nl

NonlinearSystemBase& NonlinearThread::_nl

protectedinherited

Reference to the underlying NonlinearSystemBase.

Definition at line 133 of file NonlinearThread.h.

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

◆ _num_cached

unsigned int NonlinearThread::_num_cached

protectedinherited

Definition at line 135 of file NonlinearThread.h.

Referenced by ComputeResidualAndJacobianThread::accumulate(), ComputeResidualThread::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 177 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 ComputeResidualAndJacobianThread::compute(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeResidualThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeResidualThread::determineObjectWarehouses(), ComputeMaterialsObjectThread::onBoundary(), ComputeDiracThread::onElement(), ComputeIndicatorThread::onElement(), ComputeMarkerThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeMaterialsObjectThread::onInterface(), ComputeMaterialsObjectThread::onInternalSide(), ComputeJacobianForScalingThread::operator()(), 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 179 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 181 of file NonlinearThread.h.

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

◆ _tag_kernels

MooseObjectWarehouse<KernelBase>* NonlinearThread::_tag_kernels

protectedinherited

Definition at line 156 of file NonlinearThread.h.

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

◆ _tags

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

protectedinherited

Definition at line 41 of file ComputeJacobianThread.h.

Referenced by ComputeJacobianThread::determineObjectWarehouses(), postElement(), and postInternalSide().

◆ _tid

template<typename RangeType >

THREAD_ID ThreadedElementLoopBase< RangeType >::_tid

protectedinherited

Definition at line 166 of file ThreadedElementLoopBase.h.

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

include/loops/ComputeJacobianBlocksThread.h
src/loops/ComputeJacobianBlocksThread.C

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ComputeJacobianBlocksThread() [1/2]

◆ ComputeJacobianBlocksThread() [2/2]

◆ ~ComputeJacobianBlocksThread()

Member Function Documentation

◆ accumulate()

◆ accumulateLower()

◆ accumulateNeighbor()

◆ accumulateNeighborLower()

◆ caughtMooseException()

◆ clearVarsAndMaterials()

◆ compute() [1/6]

◆ compute() [2/6]

◆ compute() [3/6]

◆ compute() [4/6]

◆ compute() [5/6]

◆ compute() [6/6]

◆ computeOnBoundary()

◆ computeOnElement()

◆ computeOnInterface()

◆ computeOnInternalFace() [1/2]

◆ computeOnInternalFace() [2/2]

◆ determineObjectWarehouses()

◆ join()

◆ keepGoing()

◆ neighborSubdomainChanged()

◆ objectType()

◆ onBoundary()

◆ onElement()

◆ onExternalSide()

◆ onInterface()

◆ onInternalSide()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ post()

◆ postElement()

◆ postInternalSide()

◆ pre()

◆ preBoundary()

◆ preElement()

◆ preInternalSide()

◆ prepareElement()

◆ prepareFace()

◆ printBlockExecutionInformation()

◆ printBoundaryExecutionInformation()

◆ printExecutionOrdering() [1/2]

◆ printExecutionOrdering() [2/2]

◆ printGeneralExecutionInformation()

◆ resetExecPrintedSets()

◆ shouldComputeInternalSide()

◆ subdomainChanged()

Member Data Documentation

◆ _blocks

◆ _blocks_exec_printed

◆ _boundaries_exec_printed

◆ _dg_kernels

◆ _dg_warehouse

◆ _dof_indices

◆ _dof_neighbor_indices

◆ _fe_problem

◆ _fv_kernels

◆ _has_active_objects

◆ _hdg_kernels

◆ _hdg_warehouse

◆ _ibc_warehouse

◆ _ik_warehouse

◆ _integrated_bcs

◆ _interface_kernels

◆ _kernels

◆ _mesh

◆ _neighbor_subdomain

◆ _nl

◆ _num_cached

◆ _old_neighbor_subdomain

◆ _old_subdomain