Moose::Kokkos::ReducerBase Class Reference

#include <KokkosReducerBase.h>

Inheritance diagram for Moose::Kokkos::ReducerBase:

Classes
struct	ReducerLoop
	Kokkos function tag. More...

Public Member Functions
	ReducerBase (const MooseObject *object)
	ReducerBase (const ReducerBase &reducer)
	Copy constructor for parallel dispatch. 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...
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
template<typename Derived >
static auto	defaultReduce ()
	Function used to check if users have overriden the hook method. More...

Protected Member Functions
virtual void	computeReducer ()
	Dispatch reduction operation. More...
virtual ThreadID	numReducerThreads () const =0
	Get the number of threads. More...
void	allocateReductionBuffer (const unsigned int size)
	Allocate reduction buffer. More...

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

Detailed Description

Definition at line 24 of file KokkosReducerBase.h.

Constructor & Destructor Documentation

ReducerBase() [1/2]

Moose::Kokkos::ReducerBase::ReducerBase

(

const MooseObject *

object

)

ReducerBase() [2/2]

Moose::Kokkos::ReducerBase::ReducerBase

(

const ReducerBase &

reducer

)

Copy constructor for parallel dispatch.

Member Function Documentation

allocateReductionBuffer()

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

inlineprotected

Allocate reduction buffer.

Definition at line 89 of file KokkosReducerBase.h.

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

computeReducer()

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

protectedvirtual

Dispatch reduction operation.

defaultReduce()

template<typename Derived >

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

inlinestatic

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

Returns

The function pointer of the default hook method

Definition at line 71 of file KokkosReducerBase.h.

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

init()

template<typename Derived >

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

inline

Definition at line 59 of file KokkosReducerBase.h.

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

join()

template<typename Derived >

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

inline

Definition at line 53 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 634 of file KokkosAssembly.h.

Referenced by Moose::Kokkos::FESystem::getVectorQpADGrad(), Moose::Kokkos::FESystem::getVectorQpADGradFace(), Moose::Kokkos::FESystem::getVectorQpADValue(), Moose::Kokkos::FESystem::getVectorQpADValueFace(), Moose::Kokkos::FESystem::getVectorQpGradFace(), Moose::Kokkos::FESystem::getVectorQpValueFace(), Moose::Kokkos::FESystem::getVectorQpVectorGradFace(), Moose::Kokkos::FESystem::getVectorQpVectorValueFace(), Moose::Kokkos::ElementReducer::operator()(), Moose::Kokkos::SideReducer::operator()(), Moose::Kokkos::NodalReducer::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::VectorNodalBC::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::VectorIntegratedBC::operator()(), Moose::Kokkos::VectorKernel::operator()(), Moose::Kokkos::Material::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::Kernel::operator()(), and Moose::Kokkos::IntegratedBC::operator()().

  {
    KOKKOS_IF_ON_HOST(return _assembly_host;)

    return _assembly_device;
  }

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 651 of file KokkosMesh.h.

Referenced by Moose::Kokkos::Assembly::computePhysicalMap(), Moose::Kokkos::LinearFVElementalKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::VectorIntegratedBC::operator()(), Moose::Kokkos::VectorKernel::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::LinearFVBoundaryCondition::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;
  }

numReducerThreads()

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

protectedpure virtual

Get the number of threads.

Implemented in Moose::Kokkos::NodalReducer, Moose::Kokkos::ElementReducer, and Moose::Kokkos::SideReducer.

reduce()

template<typename Derived >

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

inline

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

Definition at line 47 of file KokkosReducerBase.h.

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

Member Data Documentation

_reducer_dispatcher

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

protected

Kokkos functor dispatcher.

Definition at line 101 of file KokkosReducerBase.h.

_reducer_object

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

protected

MOOSE object.

Definition at line 97 of file KokkosReducerBase.h.

_reduction_buffer

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

protected

Reduction buffer.

Definition at line 105 of file KokkosReducerBase.h.

Referenced by allocateReductionBuffer().

---

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

• include/kokkos/userobjects/KokkosReducerBase.h