https://mooseframework.inl.gov
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
KokkosIntegralMaterialProperty< Base > Class Template Reference

#include <KokkosIntegralMaterialProperty.h>

Inheritance diagram for KokkosIntegralMaterialProperty< Base >:
[legend]

Public Member Functions

 KokkosIntegralMaterialProperty (const InputParameters &parameters)
 
KOKKOS_FUNCTION Real computeQpIntegral (const unsigned int qp, Datum &datum) const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

const Moose::Kokkos::MaterialProperty< Real_scalar
 

Detailed Description

template<typename Base>
class KokkosIntegralMaterialProperty< Base >

Definition at line 15 of file KokkosIntegralMaterialProperty.h.

Constructor & Destructor Documentation

◆ KokkosIntegralMaterialProperty()

template<typename Base >
KokkosIntegralMaterialProperty< Base >::KokkosIntegralMaterialProperty ( const InputParameters parameters)

Definition at line 39 of file KokkosIntegralMaterialProperty.h.

41  : Base(parameters), _scalar(Base::template getKokkosMaterialProperty<Real>("mat_prop"))
42 {
43 }
const Moose::Kokkos::MaterialProperty< Real > _scalar

Member Function Documentation

◆ computeQpIntegral()

template<typename Base >
KOKKOS_FUNCTION Real KokkosIntegralMaterialProperty< Base >::computeQpIntegral ( const unsigned int  qp,
Datum datum 
) const

Definition at line 47 of file KokkosIntegralMaterialProperty.h.

48 {
49  return _scalar(datum, qp);
50 }
const Moose::Kokkos::MaterialProperty< Real > _scalar

◆ validParams()

template<typename Base >
InputParameters KokkosIntegralMaterialProperty< Base >::validParams ( )
static

Definition at line 30 of file KokkosIntegralMaterialProperty.h.

31 {
33  params.addRequiredParam<MaterialPropertyName>("mat_prop", "The name of the material property");
34  params.addClassDescription("Compute the integral of the material property over the domain");
35  return params;
36 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
InputParameters validParams()

Member Data Documentation

◆ _scalar

template<typename Base>
const Moose::Kokkos::MaterialProperty<Real> KokkosIntegralMaterialProperty< Base >::_scalar
protected

Definition at line 25 of file KokkosIntegralMaterialProperty.h.


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