This loops over a set of mesh faces (i.e. More...

#include <ComputeFVFluxThread.h>

Inheritance diagram for ThreadedFaceLoop< RangeType >:

Public Member Functions
	ThreadedFaceLoop (FEProblemBase &fe_problem, const unsigned int nl_system_num, const std::set< TagID > &tags, bool on_displaced)

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

virtual	~ThreadedFaceLoop ()

virtual void	operator() (const RangeType &range, bool bypass_threading=false)

void	join (const ThreadedFaceLoop &y)

virtual void	onFace (const FaceInfo &fi)=0

virtual void	postFace (const FaceInfo &)
	This is called once for each face after all face and boundary callbacks have been finished for that face. More...

virtual void	pre ()
	This is called once before all face-looping. More...

virtual void	post ()
	This is called once after all face-looping is finished. More...

virtual void	onBoundary (const FaceInfo &fi, BoundaryID boundary)=0
	This is called once for every face that is on a boundary after onFace is called for the face. More...

virtual void	subdomainChanged ()
	Called every time the current subdomain changes (i.e. More...

virtual void	neighborSubdomainChanged ()
	Called every time the neighbor subdomain changes (i.e. More...

void	caughtMooseException (MooseException &e)
	Called if a MooseException is caught anywhere during the computation. More...

Protected Member Functions
virtual void	printGeneralExecutionInformation () const
	Print list of object types executed and in which order. More...

virtual void	printBlockExecutionInformation () const
	Print ordering of objects executed on each block. More...

virtual void	printBoundaryExecutionInformation (const BoundaryID) const
	Print ordering of objects exected on each boundary. More...

void	resetExecutionPrinting ()
	Reset lists of blocks and boundaries for which execution printing has been done. More...

Protected Attributes
FEProblemBase &	_fe_problem

MooseMesh &	_mesh

const std::set< TagID > &	_tags

THREAD_ID	_tid

const unsigned int	_nl_system_num

const bool	_on_displaced
	Whether this loop is operating on the displaced mesh. More...

SubProblem &	_subproblem
	FEProblemBase or DisplacedProblem depending on `_on_displaced`. More...

SubdomainID	_subdomain
	The subdomain for the current element. More...

SubdomainID	_old_subdomain
	The subdomain for the last element. More...

SubdomainID	_neighbor_subdomain
	The subdomain for the current neighbor. More...

SubdomainID	_old_neighbor_subdomain
	The subdomain for the last neighbor. More...

std::set< std::pair< const SubdomainID, const SubdomainID > >	_blocks_exec_printed
	Set to keep track of blocks for which we have printed the execution pattern. More...

std::set< BoundaryID >	_boundaries_exec_printed
	Set to keep track of boundaries for which we have printed the execution pattern. More...

std::string	_error_message
	Holds caught runtime error messages. More...

Private Attributes
const bool	_zeroth_copy
	Whether this is the zeroth threaded copy of this body. More...

const bool	_incoming_throw_on_error
	The value of `Moose::_throw_on_error` at the time of construction. More...

Detailed Description

template<typename RangeType>
class ThreadedFaceLoop< RangeType >

This loops over a set of mesh faces (i.e.

FaceInfo objects). Callback routines are provided for visiting each face, for visiting boundary faces, for sudomain changes, and pre/post many of these events.

Definition at line 73 of file ComputeFVFluxThread.h.

Constructor & Destructor Documentation

◆ ThreadedFaceLoop() [1/2]

template<typename RangeType >

ThreadedFaceLoop< RangeType >::ThreadedFaceLoop	(	FEProblemBase &	fe_problem,
		const unsigned int	nl_system_num,
		const std::set< TagID > &	tags,
		bool	on_displaced
	)

Definition at line 181 of file ComputeFVFluxThread.h.

   : _fe_problem(fe_problem),
     _mesh(fe_problem.mesh()),
     _tags(tags),
     _nl_system_num(nl_system_num),
     _on_displaced(on_displaced),
     _subproblem(_on_displaced ? static_cast<SubProblem &>(*_fe_problem.getDisplacedProblem())
                               : static_cast<SubProblem &>(_fe_problem)),
     _zeroth_copy(true),
     _incoming_throw_on_error(Moose::_throw_on_error)
 {
   Moose::_throw_on_error = true;
 }

◆ ThreadedFaceLoop() [2/2]

template<typename RangeType >

ThreadedFaceLoop< RangeType >::ThreadedFaceLoop	(	ThreadedFaceLoop< RangeType > &	x,
		Threads::split	split
	)

Definition at line 199 of file ComputeFVFluxThread.h.

   : _fe_problem(x._fe_problem),
     _mesh(x._mesh),
     _tags(x._tags),
     _nl_system_num(x._nl_system_num),
     _on_displaced(x._on_displaced),
     _subproblem(x._subproblem),
     _zeroth_copy(false),
     _incoming_throw_on_error(false)
 {
 }

◆ ~ThreadedFaceLoop()

template<typename RangeType >

ThreadedFaceLoop< RangeType >::~ThreadedFaceLoop ( )

virtual

Definition at line 212 of file ComputeFVFluxThread.h.

 {
   if (_zeroth_copy)
   {
     Moose::_throw_on_error = _incoming_throw_on_error;
 
     if (!_error_message.empty())
       mooseError(_error_message);
   }
 }

Member Function Documentation

◆ caughtMooseException()

template<typename RangeType>

void ThreadedFaceLoop< RangeType >::caughtMooseException ( MooseException & e )

inline

Called if a MooseException is caught anywhere during the computation.

Definition at line 114 of file ComputeFVFluxThread.h.

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

◆ join()

template<typename RangeType >

void ThreadedFaceLoop< RangeType >::join ( const ThreadedFaceLoop< RangeType > & y )

Definition at line 225 of file ComputeFVFluxThread.h.

 {
   if (_error_message.empty() && !y._error_message.empty())
     _error_message = y._error_message;
 }

◆ neighborSubdomainChanged()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::neighborSubdomainChanged ( )

inlinevirtual

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

the subdomain of this face's neighbor element is not the same as the subdomain of the last face's neighbor element).

Reimplemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

Definition at line 108 of file ComputeFVFluxThread.h.

Referenced by ComputeFVFluxThread< RangeType, AttribMatrixTags >::neighborSubdomainChanged().

   {
     _fe_problem.neighborSubdomainSetup(_neighbor_subdomain, _tid);
   }

◆ onBoundary()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::onBoundary	(	const FaceInfo &	fi,
		BoundaryID	boundary
	)

pure virtual

This is called once for every face that is on a boundary after onFace is called for the face.

Implemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

◆ onFace()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::onFace ( const FaceInfo & fi )

pure virtual

Implemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

◆ operator()()

template<typename RangeType >

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

virtual

Definition at line 239 of file ComputeFVFluxThread.h.

 {
   // TODO: make this query fv flux kernel specific or somehow integrate the
   // fv source kernels into this loop. Also this check will need to increase
   // in generality if/when other systems and objects besides FV stuff get
   // added to this loop.
   std::vector<FVKernel *> kernels;
   _fe_problem.theWarehouse()
       .query()
       .template condition<AttribSysNum>(_nl_system_num)
       .template condition<AttribSystem>("FVFluxKernel")
       .template condition<AttribDisplaced>(_on_displaced)
       .queryInto(kernels);
   if (kernels.size() == 0)
     return;
 
   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 faceinfo = range.begin();
       for (faceinfo = range.begin(); faceinfo != range.end(); ++faceinfo)
       {
         const Elem & elem = (*faceinfo)->elem();
 
         _fe_problem.setCurrentSubdomainID(&elem, _tid);
 
         _old_subdomain = _subdomain;
         _subdomain = elem.subdomain_id();
         if (_subdomain != _old_subdomain)
         {
           subdomainChanged();
           printBlockExecutionInformation();
         }
 
         _old_neighbor_subdomain = _neighbor_subdomain;
         if (const Elem * const neighbor = (*faceinfo)->neighborPtr())
         {
           _fe_problem.setNeighborSubdomainID(neighbor, _tid);
           _neighbor_subdomain = neighbor->subdomain_id();
         }
         else
           _neighbor_subdomain = Moose::INVALID_BLOCK_ID;
 
         if (_neighbor_subdomain != _old_neighbor_subdomain)
         {
           neighborSubdomainChanged();
           // This is going to cause a lot more printing
           printBlockExecutionInformation();
         }
 
         onFace(**faceinfo);
         // Cache data now because onBoundary may clear it. E.g. there was a nasty bug for two
         // variable FV systems where if one variable was executing an FVFluxKernel on a boundary
         // while the other was executing an FVFluxBC, the FVFluxKernel data would get lost because
         // onBoundary would clear the residual/Jacobian data before it was cached
         postFace(**faceinfo);
 
         const std::set<BoundaryID> boundary_ids = (*faceinfo)->boundaryIDs();
         for (auto & it : boundary_ids)
         {
           printBoundaryExecutionInformation(it);
           onBoundary(**faceinfo, it);
         }
 
         postFace(**faceinfo);
 
       } // range
       post();
 
       // Clear execution printing sets to start printing on every block and boundary again
       resetExecutionPrinting();
     }
     catch (libMesh::LogicError & e)
     {
       mooseException("We caught a libMesh error: ", e.what());
     }
     catch (MetaPhysicL::LogicError & e)
     {
       moose::translateMetaPhysicLError(e);
     }
   }
   catch (MooseException & e)
   {
     caughtMooseException(e);
   }
   catch (std::runtime_error & e)
   {
     _error_message = e.what();
   }
 }

◆ post()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::post ( )

inlinevirtual

This is called once after all face-looping is finished.

Reimplemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

Definition at line 96 of file ComputeFVFluxThread.h.

96 {}

◆ postFace()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::postFace ( const FaceInfo & )

inlinevirtual

This is called once for each face after all face and boundary callbacks have been finished for that face.

Reimplemented in ComputeFVFluxRJThread< RangeType >, ComputeFVFluxJacobianThread< RangeType >, and ComputeFVFluxResidualThread< RangeType >.

Definition at line 92 of file ComputeFVFluxThread.h.

92 {}

◆ pre()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::pre ( )

inlinevirtual

This is called once before all face-looping.

Reimplemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

Definition at line 94 of file ComputeFVFluxThread.h.

94 {}

◆ printBlockExecutionInformation()

template<typename RangeType>

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

inlineprotectedvirtual

Print ordering of objects executed on each block.

Reimplemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

Definition at line 126 of file ComputeFVFluxThread.h.

126 {}

◆ printBoundaryExecutionInformation()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::printBoundaryExecutionInformation ( const BoundaryID ) const

inlineprotectedvirtual

Print ordering of objects exected on each boundary.

Reimplemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

Definition at line 129 of file ComputeFVFluxThread.h.

129 {}

◆ printGeneralExecutionInformation()

template<typename RangeType>

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

inlineprotectedvirtual

Print list of object types executed and in which order.

Reimplemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

Definition at line 123 of file ComputeFVFluxThread.h.

123 {}

◆ resetExecutionPrinting()

template<typename RangeType>

void ThreadedFaceLoop< RangeType >::resetExecutionPrinting ( )

inlineprotected

Reset lists of blocks and boundaries for which execution printing has been done.

Definition at line 132 of file ComputeFVFluxThread.h.

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

◆ subdomainChanged()

template<typename RangeType>

virtual void ThreadedFaceLoop< RangeType >::subdomainChanged ( )

inlinevirtual

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

the subdomain of this face's elem element is not the same as the subdomain of the last face's elem element).

Reimplemented in ComputeFVFluxThread< RangeType, AttributeTagType >, ComputeFVFluxThread< RangeType, AttribVectorTags >, and ComputeFVFluxThread< RangeType, AttribMatrixTags >.

Definition at line 104 of file ComputeFVFluxThread.h.

Referenced by ComputeFVFluxThread< RangeType, AttribMatrixTags >::subdomainChanged().

104 { _fe_problem.subdomainSetup(_subdomain, _tid); }

ThreadedFaceLoop::_fe_problem

FEProblemBase & _fe_problem

Definition: ComputeFVFluxThread.h:138

ThreadedFaceLoop::_subdomain

SubdomainID _subdomain

The subdomain for the current element.

Definition: ComputeFVFluxThread.h:151

ThreadedFaceLoop::_tid

THREAD_ID _tid

Definition: ComputeFVFluxThread.h:141

FEProblemBase::subdomainSetup

virtual void subdomainSetup(SubdomainID subdomain, const THREAD_ID tid)

Definition: FEProblemBase.C:2462

Member Data Documentation

◆ _blocks_exec_printed

template<typename RangeType>

std::set<std::pair<const SubdomainID, const SubdomainID> > ThreadedFaceLoop< RangeType >::_blocks_exec_printed

mutableprotected

Set to keep track of blocks for which we have printed the execution pattern.

Definition at line 163 of file ComputeFVFluxThread.h.

Referenced by ThreadedFaceLoop< RangeType >::resetExecutionPrinting().

◆ _boundaries_exec_printed

template<typename RangeType>

std::set<BoundaryID> ThreadedFaceLoop< RangeType >::_boundaries_exec_printed

mutableprotected

Set to keep track of boundaries for which we have printed the execution pattern.

Definition at line 166 of file ComputeFVFluxThread.h.

Referenced by ThreadedFaceLoop< RangeType >::resetExecutionPrinting().

◆ _error_message

template<typename RangeType>

std::string ThreadedFaceLoop< RangeType >::_error_message

protected

Holds caught runtime error messages.

Definition at line 169 of file ComputeFVFluxThread.h.

Referenced by ThreadedFaceLoop< RangeType >::join().

◆ _fe_problem

template<typename RangeType>

FEProblemBase& ThreadedFaceLoop< RangeType >::_fe_problem

protected

Definition at line 138 of file ComputeFVFluxThread.h.

Referenced by ThreadedFaceLoop< RangeType >::caughtMooseException(), ThreadedFaceLoop< RangeType >::neighborSubdomainChanged(), and ThreadedFaceLoop< RangeType >::subdomainChanged().

◆ _incoming_throw_on_error

template<typename RangeType>

const bool ThreadedFaceLoop< RangeType >::_incoming_throw_on_error

private

The value of Moose::_throw_on_error at the time of construction.

This data member only has meaning and will only be read if this is the thread 0 copy of the class

Definition at line 177 of file ComputeFVFluxThread.h.

◆ _mesh

template<typename RangeType>

MooseMesh& ThreadedFaceLoop< RangeType >::_mesh

protected

Definition at line 139 of file ComputeFVFluxThread.h.

◆ _neighbor_subdomain

template<typename RangeType>

SubdomainID ThreadedFaceLoop< RangeType >::_neighbor_subdomain

protected

The subdomain for the current neighbor.

Definition at line 157 of file ComputeFVFluxThread.h.

Referenced by ThreadedFaceLoop< RangeType >::neighborSubdomainChanged().

◆ _nl_system_num

template<typename RangeType>

const unsigned int ThreadedFaceLoop< RangeType >::_nl_system_num

protected

Definition at line 142 of file ComputeFVFluxThread.h.

◆ _old_neighbor_subdomain

template<typename RangeType>

SubdomainID ThreadedFaceLoop< RangeType >::_old_neighbor_subdomain

protected

The subdomain for the last neighbor.

Definition at line 160 of file ComputeFVFluxThread.h.

◆ _old_subdomain

template<typename RangeType>

SubdomainID ThreadedFaceLoop< RangeType >::_old_subdomain

protected

The subdomain for the last element.

Definition at line 154 of file ComputeFVFluxThread.h.

◆ _on_displaced

template<typename RangeType>

const bool ThreadedFaceLoop< RangeType >::_on_displaced

protected

Whether this loop is operating on the displaced mesh.

Definition at line 145 of file ComputeFVFluxThread.h.

◆ _subdomain

template<typename RangeType>

SubdomainID ThreadedFaceLoop< RangeType >::_subdomain

protected

The subdomain for the current element.

Definition at line 151 of file ComputeFVFluxThread.h.

Referenced by ThreadedFaceLoop< RangeType >::subdomainChanged().

◆ _subproblem

template<typename RangeType>

SubProblem& ThreadedFaceLoop< RangeType >::_subproblem

protected

FEProblemBase or DisplacedProblem depending on _on_displaced.

Definition at line 148 of file ComputeFVFluxThread.h.

Referenced by ComputeFVFluxResidualThread< RangeType >::addCached(), ComputeFVFluxJacobianThread< RangeType >::addCached(), and ComputeFVFluxRJThread< RangeType >::addCached().

◆ _tags

template<typename RangeType>

const std::set<TagID>& ThreadedFaceLoop< RangeType >::_tags

protected

Definition at line 140 of file ComputeFVFluxThread.h.

◆ _tid

template<typename RangeType>

THREAD_ID ThreadedFaceLoop< RangeType >::_tid

protected

Definition at line 141 of file ComputeFVFluxThread.h.

Referenced by ComputeFVFluxResidualThread< RangeType >::addCached(), ComputeFVFluxJacobianThread< RangeType >::addCached(), ComputeFVFluxRJThread< RangeType >::addCached(), ThreadedFaceLoop< RangeType >::neighborSubdomainChanged(), and ThreadedFaceLoop< RangeType >::subdomainChanged().

◆ _zeroth_copy

template<typename RangeType>

const bool ThreadedFaceLoop< RangeType >::_zeroth_copy

private

Whether this is the zeroth threaded copy of this body.

Definition at line 173 of file ComputeFVFluxThread.h.

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

include/loops/ComputeFVFluxThread.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<typename RangeType> class ThreadedFaceLoop< RangeType >

Constructor & Destructor Documentation

◆ ThreadedFaceLoop() [1/2]

◆ ThreadedFaceLoop() [2/2]

◆ ~ThreadedFaceLoop()

Member Function Documentation

◆ caughtMooseException()

◆ join()

◆ neighborSubdomainChanged()

◆ onBoundary()

◆ onFace()

◆ operator()()

◆ post()

◆ postFace()

◆ pre()

◆ printBlockExecutionInformation()

◆ printBoundaryExecutionInformation()

◆ printGeneralExecutionInformation()

◆ resetExecutionPrinting()

◆ subdomainChanged()

Member Data Documentation

◆ _blocks_exec_printed

◆ _boundaries_exec_printed

◆ _error_message

◆ _fe_problem

◆ _incoming_throw_on_error

◆ _mesh

◆ _neighbor_subdomain

◆ _nl_system_num

◆ _old_neighbor_subdomain

◆ _old_subdomain

◆ _on_displaced

◆ _subdomain

◆ _subproblem

◆ _tags

◆ _tid

◆ _zeroth_copy

template<typename RangeType>
class ThreadedFaceLoop< RangeType >