KokkosMaterialPropertyValueDecl.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "KokkosArray.h"

#define usingKokkosMaterialPropertyValueBaseMembers(T, dimension)                                  \
  using MaterialPropertyValueBase<T, dimension>::_idx;                                             \
  using MaterialPropertyValueBase<T, dimension>::_data;                                            \
  using MaterialPropertyValueBase<T, dimension>::_value

namespace Moose::Kokkos
{

template <typename T, unsigned int dimension>
class MaterialProperty;

class Datum;

template <typename T, unsigned int dimension>
class MaterialPropertyValueBase
{
public:
  KOKKOS_FUNCTION MaterialPropertyValueBase(const MaterialProperty<T, dimension> & property,
                                            const Datum & datum,
                                            const unsigned int qp);

  KOKKOS_FUNCTION dof_id_type n(unsigned int dim) const { return _data->n(dim); }

protected:
  const dof_id_type _idx;
  Array<T, dimension + 1> const * _data;
  const T & _value;
};

template <typename T, unsigned int dimension>
class MaterialPropertyValue : public MaterialPropertyValueBase<T, dimension>
{
  usingKokkosMaterialPropertyValueBaseMembers(T, dimension);

public:
  KOKKOS_FUNCTION MaterialPropertyValue(const MaterialProperty<T, dimension> & property,
                                        const Datum & datum,
                                        const unsigned int qp);

  template <typename... index_type>
  KOKKOS_FUNCTION T & operator()(index_type... i)
  {
    static_assert(sizeof...(i) == dimension,
                  "Number of arguments should match material property dimension");

    return (*_data)(i..., _idx);
  }
  template <typename... index_type>
  KOKKOS_FUNCTION const T & operator()(index_type... i) const
  {
    static_assert(sizeof...(i) == dimension,
                  "Number of arguments should match material property dimension");

    return _data ? (*_data)(i..., _idx) : _value;
  }
};

template <typename T>
class MaterialPropertyValue<T, 0> : public MaterialPropertyValueBase<T, 0>
{
  usingKokkosMaterialPropertyValueBaseMembers(T, 0);

public:
  KOKKOS_FUNCTION
  MaterialPropertyValue(const MaterialProperty<T, 0> & property,
                        const Datum & datum,
                        const unsigned int qp);

  KOKKOS_FUNCTION operator const T &() const { return _data ? (*_data)(_idx) : _value; }
  KOKKOS_FUNCTION auto & operator=(const T & value);
  KOKKOS_FUNCTION auto & operator=(const MaterialPropertyValue<T, 0> & value);
};

} // namespace Moose::Kokkos