ComputeMaterialsObjectThread Class Reference

#include <ComputeMaterialsObjectThread.h>

Inheritance diagram for ComputeMaterialsObjectThread:

Public Member Functions
	ComputeMaterialsObjectThread (FEProblemBase &fe_problem, MaterialPropertyStorage &material_props, MaterialPropertyStorage &bnd_material_props, MaterialPropertyStorage &neighbor_material_props, std::vector< std::vector< std::unique_ptr< Assembly > > > &assembly)
	ComputeMaterialsObjectThread (ComputeMaterialsObjectThread &x, Threads::split split)
virtual void	post () override
	Called after the element range loop.
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	onInternalSide (const Elem *elem, unsigned int side) override
	Called when doing internal edge assembling.
virtual void	onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id) override
	Called when doing interface assembling.
void	join (const ComputeMaterialsObjectThread &)
virtual void	caughtMooseException (MooseException &e) override
	Called if a MooseException is caught anywhere during the computation.
virtual bool	keepGoing () override
	Whether or not the loop should continue.
virtual void	preElement (const Elem *elem) override
	Called before the element assembly.
virtual void	preInternalSide (const Elem *elem, unsigned int side) override
	Called before evaluations on an element internal side.
virtual void	preBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override
	Called before the boundary assembly.
virtual void	neighborSubdomainChanged () override
	Called every time the neighbor subdomain changes (i.e.
virtual void	operator() (const RangeType &range, bool bypass_threading=false)
virtual void	pre ()
	Called before the element range loop.
virtual void	postElement (const Elem *elem)
	Called after the element assembly is done (including surface assembling)
virtual void	postInternalSide (const Elem *elem, unsigned int side)
	Called after evaluations on an element internal side.
virtual void	onExternalSide (const Elem *elem, unsigned int side)
	Called when iterating over external sides (no side neighbor)

Protected Member Functions
void	prepareElement (const Elem *elem)
void	clearVarsAndMaterials ()
void	printExecutionOrdering (const std::vector< T * > &objs, const bool print_header=true, const std::string &line_prefix="[DBG]") const
	Routine to output the ordering of objects within a vector of pointers to these objects.
void	printExecutionOrdering (const std::vector< std::shared_ptr< T > > &objs_ptrs, const bool print_header=true, const std::string &line_prefix="[DBG]") const
virtual void	printGeneralExecutionInformation () const
	Print information about the loop ordering.
virtual void	printBlockExecutionInformation () const
	Print information about the particular ordering of objects on each block.
virtual void	printBoundaryExecutionInformation (const unsigned int) const
	Print information about the particular ordering of objects on each boundary.
void	resetExecPrintedSets () const
	Resets the set of blocks and boundaries visited.
virtual bool	shouldComputeInternalSide (const Elem &elem, const Elem &neighbor) const
	Whether to compute the internal side for the provided element-neighbor pair.

Protected Attributes
FEProblemBase &	_fe_problem
MaterialPropertyStorage &	_material_props
MaterialPropertyStorage &	_bnd_material_props
MaterialPropertyStorage &	_neighbor_material_props
const MaterialWarehouse &	_materials
	This is populated using _fe_problem.getResidualMaterialsWarehouse because it has the union of traditional materials and the residual version of AD materials.
const MaterialWarehouse &	_interface_materials
	This is populated using _fe_problem.getResidualInterfaceMaterialsWarehouse because it has the union of traditional interface materials and the residual version of AD interface materials.
const MaterialWarehouse &	_discrete_materials
std::vector< std::vector< std::unique_ptr< Assembly > > > &	_assembly
bool	_need_internal_side_material
const bool	_has_stateful_props
const bool	_has_bnd_stateful_props
const bool	_has_neighbor_stateful_props
MooseMesh &	_mesh
THREAD_ID	_tid
SubdomainID	_subdomain
	The subdomain for the current element.
SubdomainID	_old_subdomain
	The subdomain for the last element.
SubdomainID	_neighbor_subdomain
	The subdomain for the current neighbor.
SubdomainID	_old_neighbor_subdomain
	The subdomain for the last neighbor.
std::set< SubdomainID >	_blocks_exec_printed
	Keep track of which blocks were visited.
std::set< BoundaryID >	_boundaries_exec_printed
	Keep track of which boundaries were visited.

Detailed Description

Definition at line 23 of file ComputeMaterialsObjectThread.h.

Constructor & Destructor Documentation

ComputeMaterialsObjectThread() [1/2]

ComputeMaterialsObjectThread::ComputeMaterialsObjectThread	(	FEProblemBase &	fe_problem,
		MaterialPropertyStorage &	material_props,
		MaterialPropertyStorage &	bnd_material_props,
		MaterialPropertyStorage &	neighbor_material_props,
		std::vector< std::vector< std::unique_ptr< Assembly > > > &	assembly
	)

Definition at line 24 of file ComputeMaterialsObjectThread.C.

  : ThreadedElementLoop<ConstElemRange>(fe_problem),
    _fe_problem(fe_problem),
    _material_props(material_props),
    _bnd_material_props(bnd_material_props),
    _neighbor_material_props(neighbor_material_props),
    _materials(_fe_problem.getRegularMaterialsWarehouse()),
    _interface_materials(_fe_problem.getInterfaceMaterialsWarehouse()),
    _discrete_materials(_fe_problem.getDiscreteMaterialWarehouse()),
    _assembly(assembly),
    _need_internal_side_material(false),
    _has_stateful_props(_material_props.hasStatefulProperties()),
    _has_bnd_stateful_props(_bnd_material_props.hasStatefulProperties()),
    _has_neighbor_stateful_props(_neighbor_material_props.hasStatefulProperties())
{
}

ComputeMaterialsObjectThread() [2/2]

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

Definition at line 47 of file ComputeMaterialsObjectThread.C.

  : ThreadedElementLoop<ConstElemRange>(x, split),
    _fe_problem(x._fe_problem),
    _material_props(x._material_props),
    _bnd_material_props(x._bnd_material_props),
    _neighbor_material_props(x._neighbor_material_props),
    _materials(x._materials),
    _interface_materials(x._interface_materials),
    _discrete_materials(x._discrete_materials),
    _assembly(x._assembly),
    _need_internal_side_material(x._need_internal_side_material),
    _has_stateful_props(_material_props.hasStatefulProperties()),
    _has_bnd_stateful_props(_bnd_material_props.hasStatefulProperties()),
    _has_neighbor_stateful_props(_neighbor_material_props.hasStatefulProperties())
{
}

Member Function Documentation

caughtMooseException()

void ThreadedElementLoop< ConstElemRange >::caughtMooseException ( MooseException &  e )

overridevirtualinherited

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 43 of file ThreadedElementLoop.h.

{
  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);
}

join()

void ComputeMaterialsObjectThread::join

(

const ComputeMaterialsObjectThread &

)

Definition at line 300 of file ComputeMaterialsObjectThread.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 45 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 56 of file ThreadedElementLoop.h.

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

onBoundary()

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

overridevirtual

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 115 of file ComputeMaterialsObjectThread.C.

{
  if (_fe_problem.needBoundaryMaterialOnSide(bnd_id, _tid))
  {
    _fe_problem.reinitElemFace(elem, side, _tid);
    const auto face_n_points = _assembly[_tid][/*system_index*/ 0]->qRuleFace()->n_points();
 
    _bnd_material_props.getMaterialData(_tid).resize(face_n_points);
 
    if (_has_bnd_stateful_props)
    {
      // Face Materials
      if (_discrete_materials[Moose::FACE_MATERIAL_DATA].hasActiveBlockObjects(_subdomain, _tid))
        _bnd_material_props.initStatefulProps(
            _tid,
            _discrete_materials[Moose::FACE_MATERIAL_DATA].getActiveBlockObjects(_subdomain, _tid),
            face_n_points,
            *elem,
            side);
      if (_materials[Moose::FACE_MATERIAL_DATA].hasActiveBlockObjects(_subdomain, _tid))
        _bnd_material_props.initStatefulProps(
            _tid,
            _materials[Moose::FACE_MATERIAL_DATA].getActiveBlockObjects(_subdomain, _tid),
            face_n_points,
            *elem,
            side);
 
      // Boundary Materials
      if (_discrete_materials.hasActiveBoundaryObjects(bnd_id, _tid))
        _bnd_material_props.initStatefulProps(
            _tid, _materials.getActiveBoundaryObjects(bnd_id, _tid), face_n_points, *elem, side);
      if (_materials.hasActiveBoundaryObjects(bnd_id, _tid))
        _bnd_material_props.initStatefulProps(
            _tid, _materials.getActiveBoundaryObjects(bnd_id, _tid), face_n_points, *elem, side);
    }
  }
}

onElement()

void ComputeMaterialsObjectThread::onElement ( const Elem *  elem )

overridevirtual

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 89 of file ComputeMaterialsObjectThread.C.

{
  if (_materials.hasActiveBlockObjects(_subdomain, _tid) ||
      _discrete_materials.hasActiveBlockObjects(_subdomain, _tid))
  {
    _fe_problem.prepare(elem, _tid);
    _fe_problem.reinitElem(elem, _tid);
 
    auto & material_data = _material_props.getMaterialData(_tid);
 
    unsigned int n_points = _assembly[_tid][0]->qRule()->n_points();
    material_data.resize(n_points);
 
    if (_has_stateful_props)
    {
      if (_discrete_materials.hasActiveBlockObjects(_subdomain, _tid))
        _material_props.initStatefulProps(
            _tid, _discrete_materials.getActiveBlockObjects(_subdomain, _tid), n_points, *elem);
      if (_materials.hasActiveBlockObjects(_subdomain, _tid))
        _material_props.initStatefulProps(
            _tid, _materials.getActiveBlockObjects(_subdomain, _tid), n_points, *elem);
    }
  }
}

onExternalSide()

template<typename RangeType >

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

virtualinherited

Called when iterating over external sides (no side neighbor)

Parameters

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

Reimplemented in ComputeUserObjectsThread, and NonlinearThread.

Definition at line 398 of file ThreadedElementLoopBase.h.

{
}

onInterface()

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

overridevirtual

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 214 of file ComputeMaterialsObjectThread.C.

{
  if (!_fe_problem.needInterfaceMaterialOnSide(bnd_id, _tid))
    return;
 
  _fe_problem.reinitElemFace(elem, side, _tid);
  unsigned int face_n_points = _assembly[_tid][0]->qRuleFace()->n_points();
 
  _bnd_material_props.getMaterialData(_tid).resize(face_n_points);
  _neighbor_material_props.getMaterialData(_tid).resize(face_n_points);
 
  if (_has_bnd_stateful_props)
  {
    // Face Materials
    if (_discrete_materials[Moose::FACE_MATERIAL_DATA].hasActiveBlockObjects(_subdomain, _tid))
      _bnd_material_props.initStatefulProps(
          _tid,
          _discrete_materials[Moose::FACE_MATERIAL_DATA].getActiveBlockObjects(_subdomain, _tid),
          face_n_points,
          *elem,
          side);
 
    if (_materials[Moose::FACE_MATERIAL_DATA].hasActiveBlockObjects(_subdomain, _tid))
      _bnd_material_props.initStatefulProps(
          _tid,
          _materials[Moose::FACE_MATERIAL_DATA].getActiveBlockObjects(_subdomain, _tid),
          face_n_points,
          *elem,
          side);
 
    // Boundary Materials
    if (_discrete_materials.hasActiveBoundaryObjects(bnd_id, _tid))
      _bnd_material_props.initStatefulProps(
          _tid, _materials.getActiveBoundaryObjects(bnd_id, _tid), face_n_points, *elem, side);
 
    if (_materials.hasActiveBoundaryObjects(bnd_id, _tid))
      _bnd_material_props.initStatefulProps(
          _tid, _materials.getActiveBoundaryObjects(bnd_id, _tid), face_n_points, *elem, side);
  }
 
  const Elem * neighbor = elem->neighbor_ptr(side);
  unsigned int neighbor_side = neighbor->which_neighbor_am_i(_assembly[_tid][0]->elem());
 
  // Do we have neighbor stateful properties or do we have stateful interface material properties?
  // If either then we need to reinit the neighbor, so at least at a minimum _neighbor_elem isn't
  // NULL!
  if (neighbor->active() &&
      (_has_neighbor_stateful_props ||
       (_has_bnd_stateful_props && _interface_materials.hasActiveBoundaryObjects(bnd_id, _tid))))
    _fe_problem.reinitNeighbor(elem, side, _tid);
 
  if (_has_neighbor_stateful_props && neighbor->active())
  {
    // Neighbor Materials
    if (_discrete_materials[Moose::NEIGHBOR_MATERIAL_DATA].hasActiveBlockObjects(
            neighbor->subdomain_id(), _tid))
      _neighbor_material_props.initStatefulProps(
          _tid,
          _discrete_materials[Moose::NEIGHBOR_MATERIAL_DATA].getActiveBlockObjects(
              neighbor->subdomain_id(), _tid),
          face_n_points,
          *elem,
          side);
 
    if (_materials[Moose::NEIGHBOR_MATERIAL_DATA].hasActiveBlockObjects(neighbor->subdomain_id(),
                                                                        _tid))
      _neighbor_material_props.initStatefulProps(
          _tid,
          _materials[Moose::NEIGHBOR_MATERIAL_DATA].getActiveBlockObjects(neighbor->subdomain_id(),
                                                                          _tid),
          face_n_points,
          *neighbor,
          neighbor_side);
  }
 
  // Interface Materials. Make sure we do these after neighbors
  if (_has_bnd_stateful_props && _interface_materials.hasActiveBoundaryObjects(bnd_id, _tid))
    _bnd_material_props.initStatefulProps(
        _tid,
        _interface_materials.getActiveBoundaryObjects(bnd_id, _tid),
        face_n_points,
        *elem,
        side);
}

onInternalSide()

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

overridevirtual

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 157 of file ComputeMaterialsObjectThread.C.

{
  if (_need_internal_side_material)
  {
    const Elem * neighbor = elem->neighbor_ptr(side);
 
    _fe_problem.reinitElemNeighborAndLowerD(elem, side, _tid);
    unsigned int face_n_points = _assembly[_tid][0]->qRuleFace()->n_points();
    _bnd_material_props.getMaterialData(_tid).resize(face_n_points);
    _neighbor_material_props.getMaterialData(_tid).resize(face_n_points);
 
    if (_has_bnd_stateful_props)
    {
      if (_discrete_materials[Moose::FACE_MATERIAL_DATA].hasActiveBlockObjects(_subdomain, _tid))
        _bnd_material_props.initStatefulProps(
            _tid,
            _discrete_materials[Moose::FACE_MATERIAL_DATA].getActiveBlockObjects(_subdomain, _tid),
            face_n_points,
            *elem,
            side);
      if (_materials[Moose::FACE_MATERIAL_DATA].hasActiveBlockObjects(_subdomain, _tid))
        _bnd_material_props.initStatefulProps(
            _tid,
            _materials[Moose::FACE_MATERIAL_DATA].getActiveBlockObjects(_subdomain, _tid),
            face_n_points,
            *elem,
            side);
    }
 
    unsigned int neighbor_side = neighbor->which_neighbor_am_i(_assembly[_tid][0]->elem());
 
    if (_has_neighbor_stateful_props)
    {
      // Neighbor Materials
      if (_discrete_materials[Moose::NEIGHBOR_MATERIAL_DATA].hasActiveBlockObjects(
              neighbor->subdomain_id(), _tid))
        _neighbor_material_props.initStatefulProps(
            _tid,
            _discrete_materials[Moose::NEIGHBOR_MATERIAL_DATA].getActiveBlockObjects(
                neighbor->subdomain_id(), _tid),
            face_n_points,
            *elem,
            side);
      if (_materials[Moose::NEIGHBOR_MATERIAL_DATA].hasActiveBlockObjects(neighbor->subdomain_id(),
                                                                          _tid))
        _neighbor_material_props.initStatefulProps(
            _tid,
            _materials[Moose::NEIGHBOR_MATERIAL_DATA].getActiveBlockObjects(
                neighbor->subdomain_id(), _tid),
            face_n_points,
            *neighbor,
            neighbor_side);
    }
  }
}

operator()()

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 ComputeMaterialsObjectThread::post ( )

overridevirtual

Called after the element range loop.

Reimplemented from ThreadedElementLoopBase< RangeType >.

Definition at line 305 of file ComputeMaterialsObjectThread.C.

{
  _fe_problem.clearActiveElementalMooseVariables(_tid);
}

postElement()

template<typename RangeType >

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

virtualinherited

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

Parameters

elem	- active element

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

Definition at line 356 of file ThreadedElementLoopBase.h.

{
}

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 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);
}

printBlockExecutionInformation()

template<typename RangeType >

virtual void ThreadedElementLoopBase< RangeType >::printBlockExecutionInformation ( ) const

inlineprotectedvirtualinherited

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

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

Definition at line 184 of file ThreadedElementLoopBase.h.

{}

printBoundaryExecutionInformation()

template<typename RangeType >

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

inlineprotectedvirtualinherited

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

Reimplemented in NonlinearThread.

Definition at line 187 of file ThreadedElementLoopBase.h.

{}

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

template<typename RangeType >

virtual void ThreadedElementLoopBase< RangeType >::printGeneralExecutionInformation ( ) const

inlineprotectedvirtualinherited

Print information about the loop ordering.

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

Definition at line 181 of file ThreadedElementLoopBase.h.

{}

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

template<typename RangeType >

bool ThreadedElementLoopBase< RangeType >::shouldComputeInternalSide ( const Elem &  elem, const Elem &  neighbor  ) const

protectedvirtualinherited

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 in FlagElementsThread, ProjectMaterialProperties, CacheChangedListsThread, and NonlinearThread.

Definition at line 424 of file ThreadedElementLoopBase.h.

{
  // If we're going to compute the internal side with this elem-neighbor pair, then they must both
  // be active. Note that if elem is an active coarse element at an interface with finer elements,
  // then its neighbor will be an equal-level inactive element, hence the following
  // neighbor.active() check. In that case we'll catch current 'elem' when we come around and
  // examine one of the finer elements as 'elem'
  mooseAssert(elem.active(), "This method should never be called with an inactive element");
  if (!neighbor.active())
    return false;
 
  //
  // Define an ordering: first prefer finer by h (higher level()), then prefer finer by p (higher
  // p_level()), then prefer smaller id()"
  //
 
  const auto elem_level = elem.level(), neighbor_level = neighbor.level();
  if (elem_level != neighbor_level)
    return elem_level > neighbor_level;
 
  const auto elem_p_level = elem.p_level(), neighbor_p_level = neighbor.p_level();
  if (elem_p_level != neighbor_p_level)
    return elem_p_level > neighbor_p_level;
 
  return elem.id() < neighbor.id();
}

Referenced by NonlinearThread::shouldComputeInternalSide().

subdomainChanged()

void ComputeMaterialsObjectThread::subdomainChanged ( )

overridevirtual

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 66 of file ComputeMaterialsObjectThread.C.

{
  _need_internal_side_material = _fe_problem.needInternalNeighborSideMaterial(_subdomain, _tid);
  _fe_problem.subdomainSetup(_subdomain, _tid);
 
  std::set<MooseVariableFEBase *> needed_moose_vars;
  _materials.updateVariableDependency(needed_moose_vars, _tid);
  _discrete_materials.updateVariableDependency(needed_moose_vars, _tid);
  _fe_problem.setActiveElementalMooseVariables(needed_moose_vars, _tid);
 
  std::set<TagID> needed_fe_var_vector_tags;
  _materials.updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_fe_var_vector_tags, _tid);
  _discrete_materials.updateBlockFEVariableCoupledVectorTagDependency(
      _subdomain, needed_fe_var_vector_tags, _tid);
  _fe_problem.setActiveFEVariableCoupleableVectorTags(needed_fe_var_vector_tags, _tid);
 
  // Note that we do not know here which materials will be active on this subdomain because we don't
  // have the various warehouses (kernels, ...) to gather the needed material properties like in
  // NonlinearThread
}

Member Data Documentation

_assembly

std::vector<std::vector<std::unique_ptr<Assembly> > >& ComputeMaterialsObjectThread::_assembly

protected

Definition at line 66 of file ComputeMaterialsObjectThread.h.

Referenced by onBoundary(), onElement(), onInterface(), and onInternalSide().

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

_bnd_material_props

MaterialPropertyStorage& ComputeMaterialsObjectThread::_bnd_material_props

protected

Definition at line 50 of file ComputeMaterialsObjectThread.h.

Referenced by onBoundary(), onInterface(), and onInternalSide().

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

_discrete_materials

const MaterialWarehouse& ComputeMaterialsObjectThread::_discrete_materials

protected

Definition at line 64 of file ComputeMaterialsObjectThread.h.

Referenced by onBoundary(), onElement(), onInterface(), onInternalSide(), and subdomainChanged().

_fe_problem

FEProblemBase& ComputeMaterialsObjectThread::_fe_problem

protected

Definition at line 48 of file ComputeMaterialsObjectThread.h.

Referenced by onBoundary(), onElement(), onInterface(), onInternalSide(), post(), and subdomainChanged().

_has_bnd_stateful_props

const bool ComputeMaterialsObjectThread::_has_bnd_stateful_props

protected

Definition at line 70 of file ComputeMaterialsObjectThread.h.

Referenced by onBoundary(), onInterface(), and onInternalSide().

_has_neighbor_stateful_props

const bool ComputeMaterialsObjectThread::_has_neighbor_stateful_props

protected

Definition at line 71 of file ComputeMaterialsObjectThread.h.

Referenced by onInterface(), and onInternalSide().

_has_stateful_props

const bool ComputeMaterialsObjectThread::_has_stateful_props

protected

Definition at line 69 of file ComputeMaterialsObjectThread.h.

Referenced by onElement().

_interface_materials

const MaterialWarehouse& ComputeMaterialsObjectThread::_interface_materials

protected

This is populated using _fe_problem.getResidualInterfaceMaterialsWarehouse because it has the union of traditional interface materials and the residual version of AD interface materials.

We don't need the Jacobian version of the ADInterfaceMaterial for doing stateful stuff

Definition at line 62 of file ComputeMaterialsObjectThread.h.

Referenced by onInterface().

_material_props

MaterialPropertyStorage& ComputeMaterialsObjectThread::_material_props

protected

Definition at line 49 of file ComputeMaterialsObjectThread.h.

Referenced by onElement().

_materials

const MaterialWarehouse& ComputeMaterialsObjectThread::_materials

protected

This is populated using _fe_problem.getResidualMaterialsWarehouse because it has the union of traditional materials and the residual version of AD materials.

We don't need the Jacobian version of the ADMaterial for doing stateful stuff

Definition at line 56 of file ComputeMaterialsObjectThread.h.

Referenced by onBoundary(), onElement(), onInterface(), onInternalSide(), and subdomainChanged().

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

_need_internal_side_material

bool ComputeMaterialsObjectThread::_need_internal_side_material

protected

Definition at line 67 of file ComputeMaterialsObjectThread.h.

Referenced by onInternalSide(), and subdomainChanged().

_neighbor_material_props

MaterialPropertyStorage& ComputeMaterialsObjectThread::_neighbor_material_props

protected

Definition at line 51 of file ComputeMaterialsObjectThread.h.

Referenced by onInterface(), and onInternalSide().

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

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

_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(), onBoundary(), ComputeDiracThread::onElement(), ComputeIndicatorThread::onElement(), ComputeMarkerThread::onElement(), onElement(), ComputeUserObjectsThread::onElement(), onInterface(), onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeJacobianBlocksThread::postInternalSide(), ComputeDiracThread::printBlockExecutionInformation(), ComputeIndicatorThread::printBlockExecutionInformation(), ComputeMarkerThread::printBlockExecutionInformation(), ComputeUserObjectsThread::printBlockExecutionInformation(), NonlinearThread::printBlockExecutionInformation(), ComputeUserObjectsThread::querySubdomain(), ComputeDiracThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeMarkerThread::subdomainChanged(), subdomainChanged(), ComputeUserObjectsThread::subdomainChanged(), NonlinearThread::subdomainChanged(), and ProjectMaterialProperties::subdomainChanged().

_tid

template<typename RangeType >

THREAD_ID ThreadedElementLoopBase< RangeType >::_tid

protectedinherited

Definition at line 166 of file ThreadedElementLoopBase.h.

Referenced by ComputeResidualAndJacobianThread::accumulate(), ComputeResidualThread::accumulate(), ComputeJacobianThread::accumulateLower(), ComputeResidualAndJacobianThread::accumulateLower(), ComputeResidualThread::accumulateLower(), ComputeJacobianThread::accumulateNeighbor(), ComputeResidualAndJacobianThread::accumulateNeighbor(), ComputeResidualThread::accumulateNeighbor(), ComputeJacobianThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::accumulateNeighborLower(), ComputeResidualThread::accumulateNeighborLower(), ComputeResidualAndJacobianThread::compute(), NonlinearThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnBoundary(), NonlinearThread::computeOnElement(), ComputeFullJacobianThread::computeOnElement(), NonlinearThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::computeOnInternalFace(), ComputeResidualAndJacobianThread::computeOnInternalFace(), ComputeResidualThread::computeOnInternalFace(), NonlinearThread::computeOnInternalFace(), ComputeFullJacobianThread::computeOnInternalFace(), ComputeJacobianThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), ComputeResidualThread::determineObjectWarehouses(), onBoundary(), ComputeUserObjectsThread::onBoundary(), NonlinearThread::onBoundary(), ProjectMaterialProperties::onBoundary(), ComputeDiracThread::onElement(), ComputeElemDampingThread::onElement(), ComputeIndicatorThread::onElement(), ComputeMarkerThread::onElement(), onElement(), ComputeUserObjectsThread::onElement(), NonlinearThread::onElement(), ProjectMaterialProperties::onElement(), UpdateErrorVectorsThread::onElement(), NonlinearThread::onExternalSide(), onInterface(), ComputeUserObjectsThread::onInterface(), NonlinearThread::onInterface(), ComputeIndicatorThread::onInternalSide(), onInternalSide(), ComputeUserObjectsThread::onInternalSide(), NonlinearThread::onInternalSide(), ProjectMaterialProperties::onInternalSide(), ComputeJacobianForScalingThread::operator()(), ComputeDiracThread::post(), ComputeIndicatorThread::post(), ComputeMarkerThread::post(), 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(), subdomainChanged(), ComputeUserObjectsThread::subdomainChanged(), NonlinearThread::subdomainChanged(), and ProjectMaterialProperties::subdomainChanged().

---

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

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