GatherRCDataFaceThread< RangeType > Class Template Reference

A class that gathers 'a' coefficient data from flux kernels, boundary conditions, and interface kernels contributing to the Navier-Stokes momentum residuals. More...

#include <GatherRCDataFaceThread.h>

Inheritance diagram for GatherRCDataFaceThread< RangeType >:

Public Types
using	Parent = ThreadedFaceLoop< RangeType >

Public Member Functions
	GatherRCDataFaceThread (FEProblemBase &fe_problem, const unsigned int nl_sys_number, const std::vector< unsigned int > &vars, bool on_displaced)
	GatherRCDataFaceThread (GatherRCDataFaceThread &x, Threads::split split)
void	onFace (const FaceInfo &fi) override final
void	onBoundary (const FaceInfo &fi, BoundaryID boundary) override final
void	subdomainChanged () override final
void	neighborSubdomainChanged () override final
virtual void	operator() (const RangeType &range, bool bypass_threading=false)
void	join (const ThreadedFaceLoop &y)
virtual void	postFace (const FaceInfo &)
virtual void	pre ()
virtual void	post ()
void	caughtMooseException (MooseException &e)

Protected Member Functions
virtual void	printGeneralExecutionInformation () const
virtual void	printBlockExecutionInformation () const
virtual void	printBoundaryExecutionInformation (const BoundaryID) const
void	resetExecutionPrinting ()

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
SubProblem &	_subproblem
SubdomainID	_subdomain
SubdomainID	_old_subdomain
SubdomainID	_neighbor_subdomain
SubdomainID	_old_neighbor_subdomain
std::set< std::pair< const SubdomainID, const SubdomainID > >	_blocks_exec_printed
std::set< BoundaryID >	_boundaries_exec_printed
std::string	_error_message

Private Member Functions
void	finalizeContainers ()
	Called at the end of either subdomainChanged or neighborSubdomainChanged, this method computes the final _fv_flux_kernels set.
template<typename... Attribs>
void	getVarROs (std::vector< INSFVMomentumResidualObject * > &ros, TheWarehouse::QueryCache< Attribs... > &queries)
	This determines all the momentum residual objects for all the variables.

Private Attributes
const std::vector< unsigned int > &	_vars
	The velocity variable numbers.
std::set< INSFVMomentumResidualObject * >	_fv_flux_kernels
	The collection of flux kernels that contribute to the momentum equation residuals.
std::set< INSFVMomentumResidualObject * >	_elem_sub_fv_flux_kernels
	The subset of flux kernels that contribute to the momentum equation residual from the element side of the face.
std::set< INSFVMomentumResidualObject * >	_neigh_sub_fv_flux_kernels
	The subset of flux kernels that contribute to the momentum equation residual from the neighbor side of the face.
const bool	_zeroth_copy
const bool	_incoming_throw_on_error

Detailed Description

template<typename RangeType>
class GatherRCDataFaceThread< RangeType >

A class that gathers 'a' coefficient data from flux kernels, boundary conditions, and interface kernels contributing to the Navier-Stokes momentum residuals.

We loop over each active, local face and call the gatherRCData method on each kernel with the current face as an argument

Definition at line 23 of file GatherRCDataFaceThread.h.

Member Typedef Documentation

Parent

template<typename RangeType >

using GatherRCDataFaceThread< RangeType >::Parent = ThreadedFaceLoop<RangeType>

Definition at line 26 of file GatherRCDataFaceThread.h.

Constructor & Destructor Documentation

GatherRCDataFaceThread() [1/2]

template<typename RangeType >

GatherRCDataFaceThread< RangeType >::GatherRCDataFaceThread	(	FEProblemBase &	fe_problem,
		const unsigned int	nl_sys_number,
		const std::vector< unsigned int > &	vars,
		bool	on_displaced
	)

Definition at line 75 of file GatherRCDataFaceThread.h.

  : ThreadedFaceLoop<RangeType>(fe_problem, nl_sys_number, {}, on_displaced), _vars(vars)
{
}

GatherRCDataFaceThread() [2/2]

template<typename RangeType >

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

Definition at line 84 of file GatherRCDataFaceThread.h.

  : ThreadedFaceLoop<RangeType>(x, split), _vars(x._vars)
{
}

Member Function Documentation

finalizeContainers()

template<typename RangeType >

void GatherRCDataFaceThread< RangeType >::finalizeContainers ( )

private

Called at the end of either subdomainChanged or neighborSubdomainChanged, this method computes the final _fv_flux_kernels set.

Definition at line 214 of file GatherRCDataFaceThread.h.

{
  const bool same_kernels = _elem_sub_fv_flux_kernels == _neigh_sub_fv_flux_kernels;
  if (same_kernels)
    _fv_flux_kernels = _elem_sub_fv_flux_kernels;
  else
    std::set_union(_elem_sub_fv_flux_kernels.begin(),
                   _elem_sub_fv_flux_kernels.end(),
                   _neigh_sub_fv_flux_kernels.begin(),
                   _neigh_sub_fv_flux_kernels.end(),
                   std::inserter(_fv_flux_kernels, _fv_flux_kernels.begin()));
}

getVarROs()

template<typename RangeType >

template<typename... Attribs>

void GatherRCDataFaceThread< RangeType >::getVarROs ( std::vector< INSFVMomentumResidualObject * > &  ros, TheWarehouse::QueryCache< Attribs... > &  queries  )

private

This determines all the momentum residual objects for all the variables.

Parameters

ros	The output of this method; all the momentum residual objects for all the variables
queries	Candidate MooseObjects for momentum residual object consideration that have been pre-filtered based on attributes such as thread ID, boundary ID, subdomain ID, etc.

Definition at line 93 of file GatherRCDataFaceThread.h.

{
  for (const auto var_num : _vars)
  {
    // We don't want to do cascading var num attributes or else the second time around we won't get
    // any results out of the query (e.g. an object cannot have a variable that simultaneously has
    // both var number 0 and 1)
    auto copied_queries = queries;
    std::vector<INSFVMomentumResidualObject *> var_ros;
    copied_queries.template condition<AttribVar>(static_cast<int>(var_num)).queryInto(var_ros);
    for (auto * const var_ro : var_ros)
      ros.push_back(var_ro);
  }
}

neighborSubdomainChanged()

template<typename RangeType >

void GatherRCDataFaceThread< RangeType >::neighborSubdomainChanged ( )

finaloverridevirtual

Reimplemented from ThreadedFaceLoop< RangeType >.

Definition at line 186 of file GatherRCDataFaceThread.h.

{
  ThreadedFaceLoop<RangeType>::neighborSubdomainChanged();
 
  // Clear kernels
  _fv_flux_kernels.clear();
  _neigh_sub_fv_flux_kernels.clear();
 
  std::vector<INSFVMomentumResidualObject *> kernels;
  // cannot bind to lvalue reference otherwise the temporary is destroyed and we are left with a
  // dangling reference
  auto queries = this->_fe_problem.theWarehouse()
                     .query()
                     .template condition<AttribSysNum>(this->_nl_system_num)
                     .template condition<AttribSystem>("FVFluxKernel")
                     .template condition<AttribDisplaced>(this->_on_displaced)
                     .template condition<AttribSubdomains>(this->_neighbor_subdomain)
                     .template condition<AttribThread>(this->_tid);
  getVarROs(kernels, queries);
 
  _neigh_sub_fv_flux_kernels =
      std::set<INSFVMomentumResidualObject *>(kernels.begin(), kernels.end());
 
  finalizeContainers();
}

onBoundary()

template<typename RangeType >

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

finaloverridevirtual

Implements ThreadedFaceLoop< RangeType >.

Definition at line 119 of file GatherRCDataFaceThread.h.

{
  {
    std::vector<INSFVMomentumResidualObject *> bcs;
    // cannot bind to lvalue reference otherwise the temporary is destroyed and we are left with a
    // dangling reference
    auto queries = this->_fe_problem.theWarehouse()
                       .query()
                       .template condition<AttribSystem>("FVFluxBC")
                       .template condition<AttribSysNum>(this->_nl_system_num)
                       .template condition<AttribDisplaced>(this->_on_displaced)
                       .template condition<AttribThread>(this->_tid)
                       .template condition<AttribBoundaries>(bnd_id);
    getVarROs(bcs, queries);
 
    for (auto * const bc : bcs)
      bc->gatherRCData(fi);
  }
 
  {
    std::vector<INSFVMomentumResidualObject *> iks;
    // cannot bind to lvalue reference otherwise the temporary is destroyed and we are left with a
    // dangling reference
    auto queries = this->_fe_problem.theWarehouse()
                       .query()
                       .template condition<AttribSystem>("FVInterfaceKernel")
                       .template condition<AttribSysNum>(this->_nl_system_num)
                       .template condition<AttribDisplaced>(this->_on_displaced)
                       .template condition<AttribThread>(this->_tid)
                       .template condition<AttribBoundaries>(bnd_id);
    getVarROs(iks, queries);
 
    for (auto * const ik : iks)
      ik->gatherRCData(fi);
  }
}

onFace()

template<typename RangeType >

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

finaloverridevirtual

Implements ThreadedFaceLoop< RangeType >.

Definition at line 111 of file GatherRCDataFaceThread.h.

{
  for (auto * const k : _fv_flux_kernels)
    k->gatherRCData(fi);
}

subdomainChanged()

template<typename RangeType >

void GatherRCDataFaceThread< RangeType >::subdomainChanged ( )

finaloverridevirtual

Reimplemented from ThreadedFaceLoop< RangeType >.

Definition at line 158 of file GatherRCDataFaceThread.h.

{
  ThreadedFaceLoop<RangeType>::subdomainChanged();
 
  // Clear kernels
  _fv_flux_kernels.clear();
  _elem_sub_fv_flux_kernels.clear();
 
  std::vector<INSFVMomentumResidualObject *> kernels;
  // cannot bind to lvalue reference otherwise the temporary is destroyed and we are left with a
  // dangling reference
  auto queries = this->_fe_problem.theWarehouse()
                     .query()
                     .template condition<AttribSysNum>(this->_nl_system_num)
                     .template condition<AttribSystem>("FVFluxKernel")
                     .template condition<AttribDisplaced>(this->_on_displaced)
                     .template condition<AttribSubdomains>(this->_subdomain)
                     .template condition<AttribThread>(this->_tid);
  getVarROs(kernels, queries);
 
  _elem_sub_fv_flux_kernels =
      std::set<INSFVMomentumResidualObject *>(kernels.begin(), kernels.end());
 
  finalizeContainers();
}

Member Data Documentation

_elem_sub_fv_flux_kernels

template<typename RangeType >

std::set<INSFVMomentumResidualObject *> GatherRCDataFaceThread< RangeType >::_elem_sub_fv_flux_kernels

private

The subset of flux kernels that contribute to the momentum equation residual from the element side of the face.

Definition at line 67 of file GatherRCDataFaceThread.h.

_fv_flux_kernels

template<typename RangeType >

std::set<INSFVMomentumResidualObject *> GatherRCDataFaceThread< RangeType >::_fv_flux_kernels

private

The collection of flux kernels that contribute to the momentum equation residuals.

Definition at line 63 of file GatherRCDataFaceThread.h.

_neigh_sub_fv_flux_kernels

template<typename RangeType >

std::set<INSFVMomentumResidualObject *> GatherRCDataFaceThread< RangeType >::_neigh_sub_fv_flux_kernels

private

The subset of flux kernels that contribute to the momentum equation residual from the neighbor side of the face.

Definition at line 71 of file GatherRCDataFaceThread.h.

_vars

template<typename RangeType >

const std::vector<unsigned int>& GatherRCDataFaceThread< RangeType >::_vars

private

The velocity variable numbers.

Definition at line 60 of file GatherRCDataFaceThread.h.

---

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

• navier_stokes/include/loops/GatherRCDataFaceThread.h