Moose::Kokkos::NodalReducer Class Reference

#include <KokkosNodalReducer.h>

Inheritance diagram for Moose::Kokkos::NodalReducer:

Public Types
enum	TEST_TYPE { ALL, ANY }
	A flag changing the behavior of hasBoundary. More...

Public Member Functions
	NodalReducer (const MooseObject *object)
	NodalReducer (const NodalReducer &object)
	Copy constructor for parallel dispatch. More...
virtual ThreadID	numReducerThreads () const override
	Get the number of threads. More...
template<typename Derived >
KOKKOS_FUNCTION void	operator() (ReducerLoop, const ThreadID tid, const Derived &reducer, Real *result) const
	The parallel computation entry function called by Kokkos. More...
KOKKOS_FUNCTION const Mesh &	kokkosMesh () const
	Get the const reference of the Kokkos mesh. More...
KOKKOS_FUNCTION const Assembly &	kokkosAssembly () const
	Get the const reference of the Kokkos assembly. More...
KOKKOS_FUNCTION const Array< System > &	kokkosSystems () const
	Get the const reference of the Kokkos systems. More...
Array< System > &	kokkosSystems ()
	Get the writeable host reference of the Kokkos systems. More...
KOKKOS_FUNCTION const System &	kokkosSystem (unsigned int sys) const
	Get the const reference of a Kokkos system. More...
System &	kokkosSystem (unsigned int sys)
	Get the writeable reference of a Kokkos system. More...
const std::vector< SubdomainName > &	blocks () const
	Return the block names for this object. More...
unsigned int	numBlocks () const
	Return the number of blocks for this object. More...
virtual const std::set< SubdomainID > &	blockIDs () const
	Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids. More...
unsigned int	blocksMaxDimension () const
	Return the largest mesh dimension of the elements in the blocks for this object. More...
bool	hasBlocks (const SubdomainName &name) const
	Test if the supplied block name is valid for this object. More...
bool	hasBlocks (const std::vector< SubdomainName > &names) const
	Test if the supplied vector of block names are valid for this object. More...
bool	hasBlocks (const std::set< SubdomainName > &names) const
	Test if the supplied set of block names are valid for this object. More...
bool	hasBlocks (SubdomainID id) const
	Test if the supplied block ids are valid for this object. More...
bool	hasBlocks (const std::vector< SubdomainID > &ids) const
	Test if the supplied vector block ids are valid for this object. More...
bool	hasBlocks (const std::set< SubdomainID > &ids) const
	Test if the supplied set of block ids are valid for this object. More...
bool	isBlockSubset (const std::set< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...
bool	isBlockSubset (const std::vector< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...
template<typename T , bool is_ad = false>
bool	hasBlockMaterialProperty (const std::string &prop_name)
	Check if a material property is valid for all blocks of this object. More...
const std::set< SubdomainID > &	meshBlockIDs () const
	Return all of the SubdomainIDs for the mesh. More...
virtual bool	blockRestricted () const
	Returns true if this object has been restricted to a block. More...
virtual void	checkVariable (const MooseVariableFieldBase &variable) const
	Helper for checking that the ids for this object are in agreement with the variables on the supplied variable. More...
virtual const std::set< BoundaryID > &	boundaryIDs () const
	Return the boundary IDs for this object. More...
const std::vector< BoundaryName > &	boundaryNames () const
	Return the boundary names for this object. More...
unsigned int	numBoundaryIDs () const
	Return the number of boundaries for this object. More...
bool	hasBoundary (const BoundaryName &name) const
	Test if the supplied boundary name is valid for this object. More...
bool	hasBoundary (const std::vector< BoundaryName > &names) const
	Test if the supplied vector of boundary names are valid for this object. More...
bool	hasBoundary (const BoundaryID &id) const
	Test if the supplied boundary ids are valid for this object. More...
bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied vector boundary ids are valid for this object. More...
bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied set of boundary ids are valid for this object. More...
bool	isBoundarySubset (const std::set< BoundaryID > &ids) const
	Test if the class boundary ids are a subset of the supplied objects. More...
bool	isBoundarySubset (const std::vector< BoundaryID > &ids) const
template<typename T , bool is_ad = false>
bool	hasBoundaryMaterialProperty (const std::string &prop_name) const
	Check if a material property is valid for all boundaries of this object. More...
virtual bool	boundaryRestricted () const
	Returns true if this object has been restricted to a boundary. More...
const std::set< BoundaryID > &	meshBoundaryIDs () const
	Returns the set of all boundary ids for the entire mesh. More...
virtual bool	checkVariableBoundaryIntegrity () const
	Whether integrity/coverage checking should be conducted for moose variables used in this object. More...
template<typename Derived >
KOKKOS_FUNCTION void	reduce (Datum &, Real *) const
	Default methods to prevent compile errors even when these methods were not defined in the derived class. More...
template<typename Derived >
KOKKOS_FUNCTION void	join (Real *, const Real *) const
template<typename Derived >
KOKKOS_FUNCTION void	init (Real *) const

Static Public Member Functions
static InputParameters	validParams ()
template<typename Derived >
static auto	defaultReduce ()
	Function used to check if users have overriden the hook method. More...
static bool	restricted (const std::set< BoundaryID > &ids)
	Helper for determining if the object is boundary restricted. More...

Protected Member Functions
virtual void	computeReducer ()
	Dispatch reduction operation. More...
void	allocateReductionBuffer (const unsigned int size)
	Allocate reduction buffer. More...
virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)
	A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty. More...
void	initializeBlockRestrictable (const MooseObject *moose_object)
	An initialization routine needed for dual constructors. More...
void	initializeKokkosBlockRestrictable ()
Moose::CoordinateSystemType	getBlockCoordSystem ()
	Check if the blocks this object operates on all have the same coordinate system, and if so return it. More...
KOKKOS_FUNCTION dof_id_type	numKokkosBlockElements () const
	Get the number of elements this Kokkos object is operating on. More...
KOKKOS_FUNCTION dof_id_type	numKokkosBlockNodes () const
	Get the number of nodes this Kokkos object is operating on. More...
KOKKOS_FUNCTION dof_id_type	numKokkosBlockSides () const
	Get the number of sides this Kokkos object is operating on. More...
KOKKOS_FUNCTION ContiguousElementID	kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous element ID this Kokkos thread is operating on. More...
KOKKOS_FUNCTION ContiguousElementID	kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous node index this Kokkos thread is operating on. More...
KOKKOS_FUNCTION auto	kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous element ID - side index pair this Kokkos thread is operating on. More...
bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
	A helper method to avoid circular #include problems. More...
KOKKOS_FUNCTION dof_id_type	numKokkosBoundaryNodes () const
	Get the number of nodes this Kokkos object is operating on. More...
KOKKOS_FUNCTION dof_id_type	numKokkosBoundarySides () const
	Get the number of sides this Kokkos object is operating on. More...
KOKKOS_FUNCTION ContiguousNodeID	kokkosBoundaryNodeID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous node ID this Kokkos thread is operating on. More...
KOKKOS_FUNCTION auto	kokkosBoundaryElementSideID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous element ID - side index pair this Kokkos thread is operating on. More...

Protected Attributes
const bool	_bnd
	Flag whether this object is boundary-restricted. More...
const bool	_unique_node_execute
	Flag for enable/disabling multiple execute calls on nodes that share block ids. More...
const MooseObject *	_reducer_object
	MOOSE object. More...
std::unique_ptr< DispatcherBase >	_reducer_dispatcher
	Kokkos functor dispatcher. More...
::Kokkos::View< Real *, ::Kokkos::HostSpace >	_reduction_buffer
	Reduction buffer. More...
const MaterialData *	_blk_material_data
	Pointer to the MaterialData class for this object. More...

Detailed Description

Definition at line 20 of file KokkosNodalReducer.h.

Member Enumeration Documentation

TEST_TYPE

enum BoundaryRestrictable::TEST_TYPE

inherited

A flag changing the behavior of hasBoundary.

Enumerator
ALL
ANY

Definition at line 33 of file BoundaryRestrictable.h.

  {
    ALL,
    ANY
  };

Constructor & Destructor Documentation

NodalReducer() [1/2]

Moose::Kokkos::NodalReducer::NodalReducer

(

const MooseObject *

object

)

NodalReducer() [2/2]

Moose::Kokkos::NodalReducer::NodalReducer

(

const NodalReducer &

object

)

Copy constructor for parallel dispatch.

Member Function Documentation

allocateReductionBuffer()

void Moose::Kokkos::ReducerBase::allocateReductionBuffer ( const unsigned int  size )

inlineprotectedinherited

Allocate reduction buffer.

Definition at line 88 of file KokkosReducerBase.h.

  {
    ::Kokkos::realloc(_reduction_buffer, size);
  }

blockIDs()

const std::set< SubdomainID > & BlockRestrictable::blockIDs ( ) const

virtualinherited

Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids.

Returns

a set of SubdomainIDs that are valid for this object

Definition at line 209 of file BlockRestrictable.C.

Referenced by FunctorMaterial::addFunctorProperty(), DiracKernelBase::addPoint(), DiracKernelBase::addPointWithValidId(), NodalPatchRecoveryAuxBase::blockRestrictElements(), MooseMesh::cacheFaceInfoVariableOwnership(), MooseMesh::cacheFVElementalDoFs(), ComboMarker::ComboMarker(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), BlockRestrictable::getBlockCoordSystem(), MaterialBase::getGenericZeroMaterialPropertyByName(), NEML2FEInterpolation::getMOOSEVariable(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), IndicatorMarker::IndicatorMarker(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), FunctorExtremaPositions::initialize(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux(), MaterialBase::registerPropName(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

{
  if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return _blk_mesh->meshSubdomains();
  else
    return _blk_ids;
}

blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

Returns true if this object has been restricted to a block.

See also

MooseObject

Definition at line 197 of file BlockRestrictable.C.

Referenced by NodalPatchRecoveryAuxBase::blockRestrictElements(), BlockRestrictable::checkVariable(), SubdomainsDivision::divisionIndex(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), BlockRestrictable::getBlockCoordSystem(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), BlockRestrictable::initializeBlockRestrictable(), SolutionIC::initialSetup(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

{
  return _blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end();
}

blocks()

const std::vector< SubdomainName > & BlockRestrictable::blocks ( ) const

inherited

Return the block names for this object.

Note, if the 'blocks' input parameter was not utilized this will return an empty vector.

Returns

vector of SubdomainNames that are valid for this object

Definition at line 203 of file BlockRestrictable.C.

Referenced by MaterialOutputAction::getParams(), SubdomainsDivision::initialize(), and SolutionIC::initialSetup().

{
  return _blocks;
}

blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const

inherited

Return the largest mesh dimension of the elements in the blocks for this object.

Definition at line 386 of file BlockRestrictable.C.

{
  mooseAssert(_blk_dim != libMesh::invalid_uint, "Block restriction not initialized");
  return _blk_dim;
}

boundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::boundaryIDs ( ) const

virtualinherited

Return the boundary IDs for this object.

Returns

A set of all boundary ids for which the object is restricted

Definition at line 198 of file BoundaryRestrictable.C.

Referenced by MaterialBase::getGenericZeroMaterialPropertyByName(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), SidesetInfoVectorPostprocessor::initialize(), BoundaryLinearFVFluxIntegral::initialSetup(), SideFVFluxBCIntegral::initialSetup(), InterfaceQpUserObjectBase::initialSetup(), and MaterialBase::registerPropName().

{
  return _bnd_ids;
}

boundaryNames()

const std::vector< BoundaryName > & BoundaryRestrictable::boundaryNames ( ) const

inherited

Return the boundary names for this object.

Returns

A set of all boundary names for which the object is restricted

Definition at line 204 of file BoundaryRestrictable.C.

Referenced by MaterialOutputAction::getParams(), NearestNodeDistanceAux::NearestNodeDistanceAux(), and NearestNodeValueAux::NearestNodeValueAux().

{
  return _boundary_names;
}

boundaryRestricted()

bool BoundaryRestrictable::boundaryRestricted ( ) const

virtualinherited

Returns true if this object has been restricted to a boundary.

See also

MooseObject

Definition at line 216 of file BoundaryRestrictable.C.

Referenced by Moose::Kokkos::Material::checkMaterialProperty(), Material::checkMaterialProperty(), MaterialOutputAction::getParams(), DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::haveMaterialProperty(), and NodePositions::initialize().

{
  return BoundaryRestrictable::restricted(_bnd_ids);
}

checkVariable()

void BlockRestrictable::checkVariable ( const MooseVariableFieldBase &  variable ) const

virtualinherited

Helper for checking that the ids for this object are in agreement with the variables on the supplied variable.

Parameters

variable

The variable to check against.

Reimplemented in DomainUserObject.

Definition at line 358 of file BlockRestrictable.C.

Referenced by DomainUserObject::checkVariable().

{
  // a variable defined on all internal sides does not need this check because
  // it can be coupled with other variables in DG kernels
  if (!_blk_mesh->interiorLowerDBlocks().empty() &&
      variable.activeOnSubdomains(_blk_mesh->interiorLowerDBlocks()))
    return;

  if (!isBlockSubset(variable.activeSubdomains()))
  {
    std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
    std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
    mooseError("The 'block' parameter of the object '",
               _blk_name,
               "' must be a subset of the 'block' parameter of the variable '",
               variable.name(),
               "':\n    Object '",
               _blk_name,
               "': ",
               obj_ids,
               "\n    Variable '",
               variable.name(),
               "': ",
               var_ids);
  }
}

checkVariableBoundaryIntegrity()

virtual bool BoundaryRestrictable::checkVariableBoundaryIntegrity ( ) const

inlinevirtualinherited

Whether integrity/coverage checking should be conducted for moose variables used in this object.

This should return true if variables are only evaluated locally, e.g. on the current node or element. This should return false if evaluation of this object entails non-local variable evaluations

Definition at line 190 of file BoundaryRestrictable.h.

{ return true; }

computeReducer()

virtual void Moose::Kokkos::ReducerBase::computeReducer ( )

protectedvirtualinherited

Dispatch reduction operation.

defaultReduce()

template<typename Derived >

static auto Moose::Kokkos::ReducerBase::defaultReduce ( )

inlinestaticinherited

Function used to check if users have overriden the hook method.

Returns

The function pointer of the default hook method

Definition at line 70 of file KokkosReducerBase.h.

  {
    return &ReducerBase::reduce<Derived>;
  }

getBlockCoordSystem()

Moose::CoordinateSystemType BlockRestrictable::getBlockCoordSystem ( )

protectedinherited

Check if the blocks this object operates on all have the same coordinate system, and if so return it.

Definition at line 336 of file BlockRestrictable.C.

{
  if (!_blk_mesh)
    mooseError("No mesh available in BlockRestrictable::checkCoordSystem()");
  if (!_blk_feproblem)
    mooseError("No problem available in BlockRestrictable::checkCoordSystem()");

  const auto & subdomains = blockRestricted() ? blockIDs() : meshBlockIDs();

  if (subdomains.empty())
    mooseError("No subdomains found in the problem.");

  // make sure all subdomains are using the same coordinate system
  auto coord_system = _blk_feproblem->getCoordSystem(*subdomains.begin());
  for (auto subdomain : subdomains)
    if (_blk_feproblem->getCoordSystem(subdomain) != coord_system)
      mooseError("This object requires all subdomains to have the same coordinate system.");

  return coord_system;
}

hasBlockMaterialProperty()

template<typename T , bool is_ad>

bool BlockRestrictable::hasBlockMaterialProperty ( const std::string &  prop_name )

inherited

Check if a material property is valid for all blocks of this object.

This method returns true if the supplied property name has been declared in a Material object on the block ids for this object.

Template Parameters

T	The type of material property

Parameters

prop_name

the name of the property to query

Returns

true if the property exists for all block ids of the object, otherwise false

See also

Material::hasBlockMaterialProperty

Definition at line 360 of file BlockRestrictable.h.

{
  mooseAssert(_blk_material_data != NULL, "MaterialData pointer is not defined");
  return hasBlockMaterialPropertyHelper(prop_name) &&
         _blk_material_data->haveGenericProperty<T, is_ad>(prop_name);
}

hasBlockMaterialPropertyHelper()

bool BlockRestrictable::hasBlockMaterialPropertyHelper ( const std::string &  prop_name )

protectedvirtualinherited

A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty.

It also avoid circular #include problems.

See also

hasBlockMaterialProperty

Definition at line 300 of file BlockRestrictable.C.

Referenced by BlockRestrictable::hasBlockMaterialProperty().

{

  // Reference to MaterialWarehouse for testing and retrieving block ids
  const MaterialWarehouse & warehouse = _blk_feproblem->getMaterialWarehouse();

  // Complete set of ids that this object is active
  const std::set<SubdomainID> & ids = blockRestricted() ? blockIDs() : meshBlockIDs();

  // Loop over each id for this object
  for (const auto & id : ids)
  {
    // Storage of material properties that have been DECLARED on this id
    std::set<std::string> declared_props;

    // If block materials exist, populated the set of properties that were declared
    if (warehouse.hasActiveBlockObjects(id))
    {
      const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
      for (const auto & mat : mats)
      {
        const std::set<std::string> & mat_props = mat->getSuppliedItems();
        declared_props.insert(mat_props.begin(), mat_props.end());
      }
    }

    // If the supplied property is not in the list of properties on the current id, return false
    if (declared_props.find(prop_name) == declared_props.end())
      return false;
  }

  // If you get here the supplied property is defined on all blocks
  return true;
}

hasBlocks() [1/6]

bool BlockRestrictable::hasBlocks ( const SubdomainName &  name ) const

inherited

Test if the supplied block name is valid for this object.

Parameters

name	A SubdomainName to check

Returns

True if the given id is valid for this object

Definition at line 224 of file BlockRestrictable.C.

Referenced by LinearFVFluxKernel::addMatrixContribution(), DiracKernelBase::addPoint(), LinearFVFluxKernel::addRightHandSideContribution(), NodalPatchRecoveryBase::addToQuery(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), DomainUserObject::checkVariable(), ComputeJacobianThread::compute(), ComboMarker::computeElementMarker(), GradientJumpIndicator::computeQpIntegral(), ProjectionAux::computeValue(), DomainUserObject::DomainUserObject(), ProjectionAux::elemOnNodeVariableIsDefinedOn(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), NodalPatchRecoveryBase::gatherRequestList(), NodalPatchRecoveryBase::getCoefficients(), MeshDivisionFunctorReductionVectorPostprocessor::hasBlocks(), BlockRestrictable::hasBlocks(), MooseVariableField< Real >::hasBlocks(), FVFluxKernel::hasFaceSide(), IndicatorMarker::IndicatorMarker(), NodePositions::initialize(), ParsedDownSelectionPositions::initialize(), UpdateErrorVectorsThread::onElement(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), and BlockRestrictionDebugOutput::printBlockRestrictionMap().

{
  // Create a vector and utilize the getSubdomainIDs function, which
  // handles the ANY_BLOCK_ID (getSubdomainID does not)
  std::vector<SubdomainName> names(1);
  names[0] = name;
  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
}

hasBlocks() [2/6]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainName > &  names ) const

inherited

Test if the supplied vector of block names are valid for this object.

Parameters

names

A vector of SubdomainNames to check

Returns

True if the given ids are valid for this object

Definition at line 234 of file BlockRestrictable.C.

{
  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
}

hasBlocks() [3/6]

bool BlockRestrictable::hasBlocks ( const std::set< SubdomainName > &  names ) const

inherited

Test if the supplied set of block names are valid for this object.

Parameters

names

A set of SubdomainNames to check

Returns

True if the given ids are valid for this object

Definition at line 240 of file BlockRestrictable.C.

{
  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
}

hasBlocks() [4/6]

bool BlockRestrictable::hasBlocks ( SubdomainID  id ) const

inherited

Test if the supplied block ids are valid for this object.

Parameters

id	A SubdomainID to check

Returns

True if the given id is valid for this object

Definition at line 246 of file BlockRestrictable.C.

{
  if (_blk_ids.empty() || _blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return true;
  else
    return _blk_ids.find(id) != _blk_ids.end();
}

hasBlocks() [5/6]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainID > &  ids ) const

inherited

Test if the supplied vector block ids are valid for this object.

Parameters

ids	A vector of SubdomainIDs ids to check

Returns

True if all of the given ids are found within the ids for this object

Definition at line 255 of file BlockRestrictable.C.

{
  std::set<SubdomainID> ids_set(ids.begin(), ids.end());
  return hasBlocks(ids_set);
}

hasBlocks() [6/6]

bool BlockRestrictable::hasBlocks ( const std::set< SubdomainID > &  ids ) const

inherited

Test if the supplied set of block ids are valid for this object.

Parameters

ids	A std::set of SubdomainIDs to check

Returns

True if all of the given ids are found within the ids for this object

See also

isSubset

Definition at line 262 of file BlockRestrictable.C.

{
  if (_blk_ids.empty() || _blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return true;
  else
    return std::includes(_blk_ids.begin(), _blk_ids.end(), ids.begin(), ids.end());
}

hasBoundary() [1/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryName &  name ) const

inherited

Test if the supplied boundary name is valid for this object.

Parameters

name	A BoundaryName to check

Returns

True if the given id is valid for this object

Definition at line 228 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), NodePositions::initialize(), and AuxKernelBase::initialSetup().

{
  // Create a vector and utilize the getBoundaryIDs function, which
  // handles the ANY_BOUNDARY_ID (getBoundaryID does not)
  return hasBoundary(_bnd_mesh->getBoundaryIDs({name}));
}

hasBoundary() [2/5]

bool BoundaryRestrictable::hasBoundary ( const std::vector< BoundaryName > &  names ) const

inherited

Test if the supplied vector of boundary names are valid for this object.

Parameters

names

A vector of BoundaryNames to check

Returns

True if the given ids are valid for this object

Definition at line 236 of file BoundaryRestrictable.C.

{
  return hasBoundary(_bnd_mesh->getBoundaryIDs(names));
}

hasBoundary() [3/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryID &  id ) const

inherited

Test if the supplied boundary ids are valid for this object.

Parameters

id	A BoundaryID to check

Returns

True if the given id is valid for this object

Definition at line 242 of file BoundaryRestrictable.C.

{
  if (_bnd_ids.empty() || _bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
    return true;
  else
    return _bnd_ids.find(id) != _bnd_ids.end();
}

hasBoundary() [4/5]

bool BoundaryRestrictable::hasBoundary ( const std::vector< BoundaryID > &  ids, TEST_TYPE  type = ALL  ) const

inherited

Test if the supplied vector boundary ids are valid for this object.

Parameters

ids	A vector of BoundaryIDs ids to check
type	A flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object

Returns

True if the all of the given ids are found within the ids for this object

Definition at line 251 of file BoundaryRestrictable.C.

{
  std::set<BoundaryID> ids_set(ids.begin(), ids.end());
  return hasBoundary(ids_set, type);
}

hasBoundary() [5/5]

bool BoundaryRestrictable::hasBoundary ( const std::set< BoundaryID > &  ids, TEST_TYPE  type = ALL  ) const

inherited

Test if the supplied set of boundary ids are valid for this object.

Parameters

ids	A std::set of BoundaryIDs to check
type	A flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object

Returns

True if the all of the given ids are found within the ids for this object

See also

isSubset

Definition at line 258 of file BoundaryRestrictable.C.

{
  // An empty input is assumed to be ANY_BOUNDARY_ID
  if (ids.empty() || ids.find(Moose::ANY_BOUNDARY_ID) != ids.end())
    return true;

  // All supplied IDs must match those of the object
  else if (type == ALL)
  {
    if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
      return true;
    else
      return std::includes(_bnd_ids.begin(), _bnd_ids.end(), ids.begin(), ids.end());
  }
  // Any of the supplied IDs must match those of the object
  else
  {
    // Loop through the supplied ids
    for (const auto & id : ids)
    {
      // Test the current supplied id
      bool test = hasBoundary(id);

      // If the id exists in the stored ids, then return true, otherwise
      if (test)
        return true;
    }
    return false;
  }
}

hasBoundaryMaterialProperty()

template<typename T , bool is_ad>

bool BoundaryRestrictable::hasBoundaryMaterialProperty ( const std::string &  prop_name ) const

inherited

Check if a material property is valid for all boundaries of this object.

This method returns true if the supplied property name has been declared in a Material object on the boundary ids for this object.

Template Parameters

T	The type of material property

Parameters

prop_name

the name of the property to query

Returns

true if the property exists for all boundary ids of the object, otherwise false

Definition at line 295 of file BoundaryRestrictable.h.

{
  // If you get here the supplied property is defined on all boundaries, but is still subject
  // existence in the MateialData class
  return hasBoundaryMaterialPropertyHelper(prop_name) &&
         _bnd_material_data.haveGenericProperty<T, is_ad>(prop_name);
}

hasBoundaryMaterialPropertyHelper()

bool BoundaryRestrictable::hasBoundaryMaterialPropertyHelper ( const std::string &  prop_name ) const

protectedinherited

A helper method to avoid circular #include problems.

See also

hasBoundaryMaterialProperty

Definition at line 319 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable::hasBoundaryMaterialProperty().

{
  // Reference to MaterialWarehouse for testing and retrieving boundary ids
  const MaterialWarehouse & warehouse = _bnd_feproblem->getMaterialWarehouse();

  // Complete set of BoundaryIDs that this object is defined
  const std::set<BoundaryID> & ids =
      hasBoundary(Moose::ANY_BOUNDARY_ID) ? meshBoundaryIDs() : boundaryIDs();

  // Loop over each BoundaryID for this object
  for (const auto & id : ids)
  {
    // Storage of material properties that have been DECLARED on this BoundaryID
    std::set<std::string> declared_props;

    // If boundary materials exist, populated the set of properties that were declared
    if (warehouse.hasActiveBoundaryObjects(id))
    {
      const std::vector<std::shared_ptr<MaterialBase>> & mats =
          warehouse.getActiveBoundaryObjects(id);
      for (const auto & mat : mats)
      {
        const std::set<std::string> & mat_props = mat->getSuppliedItems();
        declared_props.insert(mat_props.begin(), mat_props.end());
      }
    }

    // If the supplied property is not in the list of properties on the current id, return false
    if (declared_props.find(prop_name) == declared_props.end())
      return false;
  }

  // If you get here the supplied property is defined on all boundaries
  return true;
}

init()

template<typename Derived >

KOKKOS_FUNCTION void Moose::Kokkos::ReducerBase::init ( Real *  ) const

inlineinherited

Definition at line 58 of file KokkosReducerBase.h.

  {
    ::Kokkos::abort("Default init() should never be called. Make sure you properly redefined this "
                    "method in your class without typos.");
  }

initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject *  moose_object )

protectedinherited

An initialization routine needed for dual constructors.

Definition at line 76 of file BlockRestrictable.C.

Referenced by BlockRestrictable::BlockRestrictable().

{
  // If the mesh pointer is not defined, but FEProblemBase is, get it from there
  if (_blk_feproblem != NULL && _blk_mesh == NULL)
    _blk_mesh = &_blk_feproblem->mesh();

  // Check that the mesh pointer was defined, it is required for this class to operate
  if (_blk_mesh == NULL)
    mooseError("The input parameters must contain a pointer to FEProblem via '_fe_problem' or a "
               "pointer to the MooseMesh via '_mesh'");

  // Populate the MaterialData pointer
  if (_blk_feproblem != NULL)
  {
#ifdef MOOSE_KOKKOS_ENABLED
    if (_moose_object->isKokkosObject())
      _blk_material_data = &_blk_feproblem->getKokkosMaterialData(Moose::BLOCK_MATERIAL_DATA);
    else
#endif
      _blk_material_data = &_blk_feproblem->getMaterialData(Moose::BLOCK_MATERIAL_DATA, _blk_tid);
  }

  // The 'block' input is defined
  if (moose_object->isParamValid("block"))
  {
    // Extract the blocks from the input
    _blocks = moose_object->getParam<std::vector<SubdomainName>>("block");

    // Store the IDs in a set, handling ANY_BLOCK_ID if supplied
    if (std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end())
      _blk_ids.insert(Moose::ANY_BLOCK_ID);
    else
    {
      // Get the IDs from the supplied names
      _vec_ids = _blk_mesh->getSubdomainIDs(_blocks);
      _blk_ids.insert(_vec_ids.begin(), _vec_ids.end());
    }
  }

  // When 'blocks' is not set and there is a "variable", use the blocks from the variable
  else if (moose_object->isParamValid("variable"))
  {
    std::string variable_name = moose_object->parameters().getMooseType("variable");
    if (!variable_name.empty())
      _blk_ids = _blk_feproblem
                     ->getVariable(_blk_tid,
                                   variable_name,
                                   Moose::VarKindType::VAR_ANY,
                                   Moose::VarFieldType::VAR_FIELD_ANY)
                     .activeSubdomains();
  }

  // Produce error if the object is not allowed to be both block and boundary restricted
  if (!_blk_dual_restrictable && !_boundary_ids.empty() && !_boundary_ids.empty())
    if (!_boundary_ids.empty() && _boundary_ids.find(Moose::ANY_BOUNDARY_ID) == _boundary_ids.end())
      moose_object->paramError("block",
                               "Attempted to restrict the object '",
                               _blk_name,
                               "' to a block, but the object is already restricted by boundary");

  // If no blocks were defined above, specify that it is valid on all blocks
  if (_blk_ids.empty() && !moose_object->isParamValid("boundary"))
  {
    _blk_ids.insert(Moose::ANY_BLOCK_ID);
    _blocks = {"ANY_BLOCK_ID"};
  }

  // If this object is block restricted, check that defined blocks exist on the mesh
  if (_blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end())
  {
    const std::set<SubdomainID> & valid_ids = _blk_mesh->meshSubdomains();
    std::vector<SubdomainID> diff;

    std::set_difference(_blk_ids.begin(),
                        _blk_ids.end(),
                        valid_ids.begin(),
                        valid_ids.end(),
                        std::back_inserter(diff));

    if (!diff.empty())
    {
      std::ostringstream msg;
      auto sep = " ";
      msg << "the following blocks (ids) do not exist on the mesh:";
      for (const auto & id : diff)
      {
        if (_blk_name.size() > 0)
        {
          auto & name =
              _blocks.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) - _vec_ids.begin());
          if (std::to_string(id) != name)
            msg << sep << name << " (" << id << ")";
          else
            msg << sep << id;
        }
        else
          msg << sep << id;
        sep = ", ";
      }
      std::vector<SubdomainID> valid_ids_vec(valid_ids.begin(), valid_ids.end());
      auto valid_names = _blk_mesh->getSubdomainNames(valid_ids_vec);
      msg << "\nBlocks names (resp. ids) that do exist: " << Moose::stringify(valid_names) << " ("
          << Moose::stringify(valid_ids) << ")";
      moose_object->paramError("block", msg.str());
    }
  }

  // Get the mesh dimension for the blocks
  if (blockRestricted())
    _blk_dim = _blk_mesh->getBlocksMaxDimension(_blocks);
  else
    _blk_dim = _blk_mesh->dimension();

#ifdef MOOSE_KOKKOS_ENABLED
  if (moose_object->isKokkosObject())
    _blk_feproblem->addKokkosMeshInitializationHook(
        std::bind(&BlockRestrictable::initializeKokkosBlockRestrictable, this));
#endif
}

initializeKokkosBlockRestrictable()

void BlockRestrictable::initializeKokkosBlockRestrictable ( )

protectedinherited

Referenced by BlockRestrictable::initializeBlockRestrictable().

isBlockSubset() [1/2]

bool BlockRestrictable::isBlockSubset ( const std::set< SubdomainID > &  ids ) const

inherited

Test if the class block ids are a subset of the supplied objects.

Parameters

ids	A std::set of Subdomains to check

Returns

True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)

See also

hasBlocks

Definition at line 271 of file BlockRestrictable.C.

Referenced by BlockRestrictable::checkVariable(), BlockRestrictable::isBlockSubset(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), and ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux().

{
  // An empty input is assumed to be ANY_BLOCK_ID
  if (ids.empty() || ids.find(Moose::ANY_BLOCK_ID) != ids.end())
    return true;

  if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return std::includes(ids.begin(),
                         ids.end(),
                         _blk_mesh->meshSubdomains().begin(),
                         _blk_mesh->meshSubdomains().end());
  else
    return std::includes(ids.begin(), ids.end(), _blk_ids.begin(), _blk_ids.end());
}

isBlockSubset() [2/2]

bool BlockRestrictable::isBlockSubset ( const std::vector< SubdomainID > &  ids ) const

inherited

Test if the class block ids are a subset of the supplied objects.

Parameters

ids	A std::vector of Subdomains to check

Returns

True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)

See also

hasBlocks

Definition at line 287 of file BlockRestrictable.C.

{
  std::set<SubdomainID> ids_set(ids.begin(), ids.end());
  return isBlockSubset(ids_set);
}

isBoundarySubset() [1/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::set< BoundaryID > &  ids ) const

inherited

Test if the class boundary ids are a subset of the supplied objects.

Parameters

ids	A std::set of boundaries to check

Returns

True if all of the boundary ids for this class are found within the given ids (opposite of hasBoundary)

See also

hasBoundary

Definition at line 290 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable::isBoundarySubset().

{
  // An empty input is assumed to be ANY_BOUNDARY_ID
  if (ids.empty() || ids.find(Moose::ANY_BOUNDARY_ID) != ids.end())
    return true;

  if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
    return std::includes(ids.begin(),
                         ids.end(),
                         _bnd_mesh->meshBoundaryIds().begin(),
                         _bnd_mesh->meshBoundaryIds().end());
  else
    return std::includes(ids.begin(), ids.end(), _bnd_ids.begin(), _bnd_ids.end());
}

isBoundarySubset() [2/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::vector< BoundaryID > &  ids ) const

inherited

Definition at line 306 of file BoundaryRestrictable.C.

{
  std::set<BoundaryID> ids_set(ids.begin(), ids.end());
  return isBoundarySubset(ids_set);
}

join()

template<typename Derived >

KOKKOS_FUNCTION void Moose::Kokkos::ReducerBase::join ( Real *  , const Real *    ) const

inlineinherited

Definition at line 52 of file KokkosReducerBase.h.

  {
    ::Kokkos::abort("Default join() should never be called. Make sure you properly redefined this "
                    "method in your class without typos.");
  }

kokkosAssembly()

KOKKOS_FUNCTION const Assembly& Moose::Kokkos::AssemblyHolder::kokkosAssembly ( ) const

inlineinherited

Get the const reference of the Kokkos assembly.

Returns

The const reference of the Kokkos assembly depending on the architecture this function is being called on

Definition at line 569 of file KokkosAssembly.h.

Referenced by Moose::Kokkos::System::getVectorQpADGrad(), Moose::Kokkos::System::getVectorQpADGradFace(), Moose::Kokkos::System::getVectorQpADValue(), Moose::Kokkos::System::getVectorQpADValueFace(), Moose::Kokkos::System::getVectorQpGradFace(), Moose::Kokkos::System::getVectorQpValueFace(), Moose::Kokkos::ElementReducer::operator()(), Moose::Kokkos::SideReducer::operator()(), operator()(), Moose::Kokkos::NodalUserObject::operator()(), Moose::Kokkos::SideUserObject::operator()(), Moose::Kokkos::ElementUserObject::operator()(), Moose::Kokkos::ADNodalBC::operator()(), Moose::Kokkos::ADKernel::operator()(), Moose::Kokkos::ADIntegratedBC::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::Material::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), and Moose::Kokkos::Kernel::operator()().

  {
    KOKKOS_IF_ON_HOST(return _assembly_host;)

    return _assembly_device;
  }

kokkosBlockElementID()

KOKKOS_FUNCTION ContiguousElementID BlockRestrictable::kokkosBlockElementID ( Moose::Kokkos::ThreadID  tid ) const

inlineprotectedinherited

Get the contiguous element ID this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns

The contiguous element ID

Definition at line 280 of file BlockRestrictable.h.

Referenced by Moose::Kokkos::ElementReducer::operator()(), Moose::Kokkos::ElementUserObject::operator()(), Moose::Kokkos::ADKernel::operator()(), Moose::Kokkos::AuxKernel::operator()(), and Moose::Kokkos::Kernel::operator()().

  {
    return _kokkos_element_ids[tid];
  }

kokkosBlockElementSideID()

KOKKOS_FUNCTION auto BlockRestrictable::kokkosBlockElementSideID ( Moose::Kokkos::ThreadID  tid ) const

inlineprotectedinherited

Get the contiguous element ID - side index pair this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns

The contiguous element ID - side index pair

Definition at line 298 of file BlockRestrictable.h.

  {
    return _kokkos_element_side_ids[tid];
  }

kokkosBlockNodeID()

KOKKOS_FUNCTION ContiguousElementID BlockRestrictable::kokkosBlockNodeID ( Moose::Kokkos::ThreadID  tid ) const

inlineprotectedinherited

Get the contiguous node index this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns

the contiguous node ID

Definition at line 289 of file BlockRestrictable.h.

Referenced by operator()(), Moose::Kokkos::NodalUserObject::operator()(), Moose::Kokkos::AuxKernel::operator()(), and Moose::Kokkos::NodalKernel::operator()().

  {
    return _kokkos_node_ids[tid];
  }

kokkosBoundaryElementSideID()

KOKKOS_FUNCTION auto BoundaryRestrictable::kokkosBoundaryElementSideID ( Moose::Kokkos::ThreadID  tid ) const

inlineprotectedinherited

Get the contiguous element ID - side index pair this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns

The contiguous element ID - side index pair

Definition at line 273 of file BoundaryRestrictable.h.

Referenced by Moose::Kokkos::SideReducer::operator()(), Moose::Kokkos::SideUserObject::operator()(), Moose::Kokkos::ADIntegratedBC::operator()(), and Moose::Kokkos::IntegratedBC::operator()().

  {
    return _kokkos_element_side_ids[tid];
  }

kokkosBoundaryNodeID()

KOKKOS_FUNCTION ContiguousNodeID BoundaryRestrictable::kokkosBoundaryNodeID ( Moose::Kokkos::ThreadID  tid ) const

inlineprotectedinherited

Get the contiguous node ID this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns

The contiguous node ID

Definition at line 264 of file BoundaryRestrictable.h.

Referenced by operator()(), Moose::Kokkos::NodalUserObject::operator()(), Moose::Kokkos::ADNodalBC::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::NodalBC::operator()(), and Moose::Kokkos::NodalKernel::operator()().

  {
    return _kokkos_node_ids[tid];
  }

kokkosMesh()

KOKKOS_FUNCTION const Mesh& Moose::Kokkos::MeshHolder::kokkosMesh ( ) const

inlineinherited

Get the const reference of the Kokkos mesh.

Returns

The const reference of the Kokkos mesh depending on the architecture this function is being called on

Definition at line 452 of file KokkosMesh.h.

Referenced by Moose::Kokkos::Assembly::computePhysicalMap(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::Datum::q_point(), and KokkosBoundNodalKernel::skipOnBoundary().

  {
    KOKKOS_IF_ON_HOST(
        if (!_mesh_host.initialized()) mooseError(
            "kokkosMesh() was called too early. Kokkos mesh is available after problem "
            "initialization. Override initialSetup() if you need to setup your object data "
            "using the Kokkos mesh.");

        return _mesh_host;)

    return _mesh_device;
  }

kokkosSystem() [1/2]

KOKKOS_FUNCTION const System& Moose::Kokkos::SystemHolder::kokkosSystem ( unsigned int  sys ) const

inlineinherited

Get the const reference of a Kokkos system.

Parameters

sys	The system number

Returns

The const reference of the Kokkos system depending on the architecture this function is being called on

Definition at line 792 of file KokkosSystem.h.

Referenced by Moose::Kokkos::ResidualObject::accumulateTaggedElementalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedElementalResidual(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalResidual(), KokkosCopyValueAux::computeElementInternal(), KokkosCopyValueAux::computeNodeInternal(), KokkosExtraIDIntegralVectorPostprocessor::execute(), Moose::Kokkos::ADNodalBC::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), KokkosExtraIDIntegralVectorPostprocessor::reduce(), Moose::Kokkos::AuxKernel::setElementSolution(), and Moose::Kokkos::AuxKernel::setNodeSolution().

  {
    KOKKOS_IF_ON_HOST(return _systems_host[sys];)

    return _systems_device[sys];
  }

kokkosSystem() [2/2]

System& Moose::Kokkos::SystemHolder::kokkosSystem ( unsigned int  sys )

inlineinherited

Get the writeable reference of a Kokkos system.

Parameters

sys	The system number

Returns

The writeable host reference of the Kokkos system

Definition at line 803 of file KokkosSystem.h.

{ return _systems_host[sys]; }

kokkosSystems() [1/2]

KOKKOS_FUNCTION const Array<System>& Moose::Kokkos::SystemHolder::kokkosSystems ( ) const

inlineinherited

Get the const reference of the Kokkos systems.

Returns

The const reference of the Kokkos systems depending on the architecture this function is being called on

Definition at line 775 of file KokkosSystem.h.

Referenced by Moose::Kokkos::ElementReducer::operator()(), Moose::Kokkos::SideReducer::operator()(), operator()(), Moose::Kokkos::NodalUserObject::operator()(), Moose::Kokkos::SideUserObject::operator()(), Moose::Kokkos::ElementUserObject::operator()(), Moose::Kokkos::ADNodalBC::operator()(), Moose::Kokkos::ADKernel::operator()(), Moose::Kokkos::ADIntegratedBC::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::Material::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), and Moose::Kokkos::Kernel::operator()().

  {
    KOKKOS_IF_ON_HOST(return _systems_host;)

    return _systems_device;
  }

kokkosSystems() [2/2]

Array<System>& Moose::Kokkos::SystemHolder::kokkosSystems ( )

inlineinherited

Get the writeable host reference of the Kokkos systems.

Returns

The writeable host reference of the Kokkos systems

Definition at line 785 of file KokkosSystem.h.

{ return _systems_host; }

meshBlockIDs()

const std::set< SubdomainID > & BlockRestrictable::meshBlockIDs ( ) const

inherited

Return all of the SubdomainIDs for the mesh.

Returns

A set of all subdomians for the entire mesh

Definition at line 294 of file BlockRestrictable.C.

Referenced by BlockRestrictable::checkVariable(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), BlockRestrictable::getBlockCoordSystem(), BlockRestrictable::hasBlockMaterialPropertyHelper(), and SolutionIC::initialSetup().

{
  return _blk_mesh->meshSubdomains();
}

meshBoundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::meshBoundaryIDs ( ) const

inherited

Returns the set of all boundary ids for the entire mesh.

Returns

A const reference the the boundary ids for the entire mesh

Definition at line 313 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable::hasBoundaryMaterialPropertyHelper().

{
  return _bnd_mesh->getBoundaryIDs();
}

numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns

The number of subdomains

Definition at line 218 of file BlockRestrictable.C.

Referenced by ElementCentroidPositions::initialize(), and QuadraturePointsPositions::initialize().

{
  return (unsigned int)_blk_ids.size();
}

numBoundaryIDs()

unsigned int BoundaryRestrictable::numBoundaryIDs ( ) const

inherited

Return the number of boundaries for this object.

Returns

The number of boundary ids

Definition at line 210 of file BoundaryRestrictable.C.

Referenced by SidesetInfoVectorPostprocessor::initialize().

{
  return (unsigned int)_bnd_ids.size();
}

numKokkosBlockElements()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockElements ( ) const

inlineprotectedinherited

Get the number of elements this Kokkos object is operating on.

Returns

The number of elements local to this process

Definition at line 261 of file BlockRestrictable.h.

Referenced by Moose::Kokkos::ElementReducer::numReducerThreads(), and Moose::Kokkos::ElementUserObject::numUserObjectThreads().

{ return _kokkos_element_ids.size(); }

numKokkosBlockNodes()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockNodes ( ) const

inlineprotectedinherited

Get the number of nodes this Kokkos object is operating on.

Returns

The number of nodes local to this process

Definition at line 266 of file BlockRestrictable.h.

Referenced by numReducerThreads(), and Moose::Kokkos::NodalUserObject::numUserObjectThreads().

{ return _kokkos_node_ids.size(); }

numKokkosBlockSides()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockSides ( ) const

inlineprotectedinherited

Get the number of sides this Kokkos object is operating on.

Returns

The number of sides local to this process

Definition at line 271 of file BlockRestrictable.h.

  {
    return _kokkos_element_side_ids.size();
  }

numKokkosBoundaryNodes()

KOKKOS_FUNCTION dof_id_type BoundaryRestrictable::numKokkosBoundaryNodes ( ) const

inlineprotectedinherited

Get the number of nodes this Kokkos object is operating on.

Returns

The number of nodes local to this process

Definition at line 250 of file BoundaryRestrictable.h.

Referenced by numReducerThreads(), and Moose::Kokkos::NodalUserObject::numUserObjectThreads().

{ return _kokkos_node_ids.size(); }

numKokkosBoundarySides()

KOKKOS_FUNCTION dof_id_type BoundaryRestrictable::numKokkosBoundarySides ( ) const

inlineprotectedinherited

Get the number of sides this Kokkos object is operating on.

Returns

The number of sides local to this process

Definition at line 255 of file BoundaryRestrictable.h.

Referenced by Moose::Kokkos::SideReducer::numReducerThreads(), and Moose::Kokkos::SideUserObject::numUserObjectThreads().

  {
    return _kokkos_element_side_ids.size();
  }

numReducerThreads()

virtual ThreadID Moose::Kokkos::NodalReducer::numReducerThreads ( ) const

inlineoverridevirtual

Get the number of threads.

Implements Moose::Kokkos::ReducerBase.

Definition at line 32 of file KokkosNodalReducer.h.

  {
    return _bnd ? numKokkosBoundaryNodes() : numKokkosBlockNodes();
  }

operator()()

template<typename Derived >

KOKKOS_FUNCTION void Moose::Kokkos::NodalReducer::operator()	(	ReducerLoop	,
		const ThreadID	tid,
		const Derived &	reducer,
		Real *	result
	)		const

The parallel computation entry function called by Kokkos.

Definition at line 57 of file KokkosNodalReducer.h.

{
  auto node = _bnd ? kokkosBoundaryNodeID(tid) : kokkosBlockNodeID(tid);

  Datum datum(node, kokkosAssembly(), kokkosSystems());

  reducer.template reduce<Derived>(datum, result);
}

reduce()

template<typename Derived >

KOKKOS_FUNCTION void Moose::Kokkos::ReducerBase::reduce ( Datum &  , Real *    ) const

inlineinherited

Default methods to prevent compile errors even when these methods were not defined in the derived class.

Definition at line 46 of file KokkosReducerBase.h.

  {
    ::Kokkos::abort("Default reduce() should never be called. Make sure you properly redefined "
                    "this method in your class without typos.");
  }

restricted()

bool BoundaryRestrictable::restricted ( const std::set< BoundaryID > &  ids )

staticinherited

Helper for determining if the object is boundary restricted.

This is needed for the MaterialPropertyInterface.

Definition at line 222 of file BoundaryRestrictable.C.

Referenced by moose::internal::boundaryRestricted(), and BoundaryRestrictable::boundaryRestricted().

{
  return ids.find(Moose::ANY_BOUNDARY_ID) == ids.end();
}

validParams()

static InputParameters Moose::Kokkos::NodalReducer::validParams ( )

static

Member Data Documentation

_blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data

protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 232 of file BlockRestrictable.h.

Referenced by BlockRestrictable::hasBlockMaterialProperty(), and BlockRestrictable::initializeBlockRestrictable().

_bnd

const bool Moose::Kokkos::NodalReducer::_bnd

protected

Flag whether this object is boundary-restricted.

Definition at line 48 of file KokkosNodalReducer.h.

Referenced by numReducerThreads(), Moose::Kokkos::NodalUserObject::numUserObjectThreads(), operator()(), and Moose::Kokkos::NodalUserObject::operator()().

_reducer_dispatcher

std::unique_ptr<DispatcherBase> Moose::Kokkos::ReducerBase::_reducer_dispatcher

protectedinherited

Kokkos functor dispatcher.

Definition at line 100 of file KokkosReducerBase.h.

_reducer_object

const MooseObject* Moose::Kokkos::ReducerBase::_reducer_object

protectedinherited

MOOSE object.

Definition at line 96 of file KokkosReducerBase.h.

_reduction_buffer

::Kokkos::View<Real *, ::Kokkos::HostSpace> Moose::Kokkos::ReducerBase::_reduction_buffer

protectedinherited

Reduction buffer.

Definition at line 104 of file KokkosReducerBase.h.

Referenced by Moose::Kokkos::ReducerBase::allocateReductionBuffer().

_unique_node_execute

const bool Moose::Kokkos::NodalReducer::_unique_node_execute

protected

Flag for enable/disabling multiple execute calls on nodes that share block ids.

Definition at line 52 of file KokkosNodalReducer.h.

---

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

• include/kokkos/userobjects/KokkosNodalReducer.h