KokkosElementStatistics.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* 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 "KokkosElementReporter.h"

class KokkosElementStatistics : public Moose::Kokkos::ElementReporter
{
public:
  static InputParameters validParams();

  KokkosElementStatistics(const InputParameters & parameters);

  template <typename Derived>
  KOKKOS_FUNCTION void reduce(Datum & datum, Real * result) const;

  template <typename Derived>
  KOKKOS_FUNCTION void join(Real * result, const Real * source) const;
  template <typename Derived>
  KOKKOS_FUNCTION void init(Real * result) const;

protected:
  virtual void initialize() override;
  virtual void finalize() override;

private:
  const std::string _base_name;
  Real & _max;
  Real & _min;
  Real & _average;
  Real & _integral;
  unsigned int & _number_elements;
};

template <typename Derived>
KOKKOS_FUNCTION void
KokkosElementStatistics::reduce(Datum & datum, Real * result) const
{
  // Get value to to update statistics
  auto [value, volume] = static_cast<const Derived *>(this)->computeValue(datum);

  if (result[0] < value)
    result[0] = value;

  if (result[1] > value)
    result[1] = value;

  result[2] += value * volume;

  // Update the total and the number to get the average when "finalizing"
  result[3] += value;
  result[4]++;
}

template <typename Derived>
KOKKOS_FUNCTION void
KokkosElementStatistics::join(Real * result, const Real * source) const
{
  result[0] = Kokkos::max(result[0], source[0]);
  result[1] = Kokkos::min(result[1], source[1]);
  result[2] += source[2];
  result[3] += source[3];
  result[4] += source[4];
}

template <typename Derived>
KOKKOS_FUNCTION void
KokkosElementStatistics::init(Real * result) const
{
  result[0] = Kokkos::Experimental::finite_min_v<Real>;
  result[1] = Kokkos::Experimental::finite_max_v<Real>;
  result[2] = 0;
  result[3] = 0;
  result[4] = 0;
}