KokkosExtremeValueBase< Base > Class Template Reference

#include <KokkosExtremeValueBase.h>

Inheritance diagram for KokkosExtremeValueBase< Base >:

Public Member Functions
	KokkosExtremeValueBase (const InputParameters &parameters)
virtual void	initialize () override
virtual void	finalize () override
virtual Real	getValue () const override
template<typename Derived >
KOKKOS_FUNCTION void	computeExtremeValue (const unsigned int qp, 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

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum class	ExtremeType { MAX , MIN , MAX_ABS }
	Type of extreme value we are going to compute. More...

Protected Attributes
enum KokkosExtremeValueBase::ExtremeType	_type

Detailed Description

template<typename Base>
class KokkosExtremeValueBase< Base >

Definition at line 18 of file KokkosExtremeValueBase.h.

Member Enumeration Documentation

ExtremeType

template<typename Base >

enum class KokkosExtremeValueBase::ExtremeType

strongprotected

Type of extreme value we are going to compute.

Enumerator
MAX
MIN
MAX_ABS

Definition at line 41 of file KokkosExtremeValueBase.h.

  {
    MAX,
    MIN,
    MAX_ABS
  } _type;

Constructor & Destructor Documentation

KokkosExtremeValueBase()

template<typename Base >

KokkosExtremeValueBase< Base >::KokkosExtremeValueBase

(

const InputParameters &

parameters

)

Member Function Documentation

computeExtremeValue()

template<typename Base >

template<typename Derived >

KOKKOS_FUNCTION void KokkosExtremeValueBase< Base >::computeExtremeValue	(	const unsigned int	qp,
		Datum &	datum,
		Real *	result
	)		const

Definition at line 52 of file KokkosExtremeValueBase.h.

{
  auto pv = static_cast<const Derived *>(this)->getProxyValuePair(qp, datum);
  auto rpv = Kokkos::make_pair(result[0], result[1]);
 
  if ((_type == ExtremeType::MAX && pv > rpv) || (_type == ExtremeType::MIN && pv < rpv))
  {
    result[0] = pv.first;
    result[1] = pv.second;
  }
  else if (_type == ExtremeType::MAX_ABS && Kokkos::abs(pv.first) > rpv.first)
  {
    result[0] = Kokkos::abs(pv.first);
    result[1] = pv.second;
  }
}

finalize()

template<typename Base >

virtual void KokkosExtremeValueBase< Base >::finalize ( )

overridevirtual

getValue()

template<typename Base >

virtual Real KokkosExtremeValueBase< Base >::getValue ( ) const

overridevirtual

init()

template<typename Base >

template<typename Derived >

KOKKOS_FUNCTION void KokkosExtremeValueBase< Base >::init

(

Real *

result

)

const

Definition at line 94 of file KokkosExtremeValueBase.h.

{
  if (_type == ExtremeType::MAX || _type == ExtremeType::MAX_ABS)
  {
    result[0] = Kokkos::Experimental::finite_min_v<Real>;
    result[1] = Kokkos::Experimental::finite_min_v<Real>;
  }
  else if (_type == ExtremeType::MIN)
  {
    result[0] = Kokkos::Experimental::finite_max_v<Real>;
    result[1] = Kokkos::Experimental::finite_max_v<Real>;
  }
}

initialize()

template<typename Base >

virtual void KokkosExtremeValueBase< Base >::initialize ( )

overridevirtual

join()

template<typename Base >

template<typename Derived >

KOKKOS_FUNCTION void KokkosExtremeValueBase< Base >::join	(	Real *	result,
		const Real *	source
	)		const

Definition at line 74 of file KokkosExtremeValueBase.h.

{
  auto rpv = Kokkos::make_pair(result[0], result[1]);
  auto spv = Kokkos::make_pair(source[0], source[1]);
 
  if ((_type == ExtremeType::MAX && spv > rpv) || (_type == ExtremeType::MIN && spv < rpv))
  {
    result[0] = source[0];
    result[1] = source[1];
  }
  else if (_type == ExtremeType::MAX_ABS && Kokkos::abs(spv.first) > rpv.first)
  {
    result[0] = Kokkos::abs(source[0]);
    result[1] = source[1];
  }
}

validParams()

template<typename Base >

static InputParameters KokkosExtremeValueBase< Base >::validParams ( )

static

Member Data Documentation

_type

template<typename Base >

enum KokkosExtremeValueBase::ExtremeType KokkosExtremeValueBase< Base >::_type

protected

---

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

• include/kokkos/postprocessors/KokkosExtremeValueBase.h