ExtremeValueBase< T > Class Template Reference

#include <ExtremeValueBase.h>

Inheritance diagram for ExtremeValueBase< T >:

Public Member Functions
	ExtremeValueBase (const InputParameters &parameters)
virtual void	initialize () override
virtual libMesh::Real	getValue () const override
virtual void	finalize () override
virtual void	threadJoin (const UserObject &y) override

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 Member Functions
virtual std::pair< libMesh::Real, libMesh::Real >	getProxyValuePair ()=0
virtual void	computeExtremeValue ()
	Get the extreme value with a functor element argument.

Protected Attributes
enum ExtremeValueBase::ExtremeType	_type
std::pair< libMesh::Real, libMesh::Real >	_proxy_value
	Extreme value and proxy value at the same point.

Detailed Description

template<class T>
class ExtremeValueBase< T >

Definition at line 19 of file ExtremeValueBase.h.

Member Enumeration Documentation

ExtremeType

template<class T >

enum class ExtremeValueBase::ExtremeType

strongprotected

Type of extreme value we are going to compute.

Enumerator
MAX
MIN
MAX_ABS

Definition at line 38 of file ExtremeValueBase.h.

  {
    MAX,
    MIN,
    MAX_ABS
  } _type;

Constructor & Destructor Documentation

ExtremeValueBase()

template<class T >

ExtremeValueBase< T >::ExtremeValueBase

(

const InputParameters &

parameters

)

Definition at line 34 of file ExtremeValueBase.C.

  : T(parameters), _type(parameters.get<MooseEnum>("value_type").getEnum<ExtremeType>())
{
}

Member Function Documentation

computeExtremeValue()

template<class T >

void ExtremeValueBase< T >::computeExtremeValue ( )

protectedvirtual

Get the extreme value with a functor element argument.

Definition at line 53 of file ExtremeValueBase.C.

{
  const auto pv = getProxyValuePair();
 
  if ((_type == ExtremeType::MAX && pv > _proxy_value) ||
      (_type == ExtremeType::MIN && pv < _proxy_value))
    _proxy_value = pv;
  else if (_type == ExtremeType::MAX_ABS && std::abs(pv.first) > _proxy_value.first)
    _proxy_value = std::make_pair(std::abs(pv.first), pv.second);
}

finalize()

template<class T >

void ExtremeValueBase< T >::finalize ( )

overridevirtual

Definition at line 73 of file ExtremeValueBase.C.

{
  if (_type == ExtremeType::MAX || _type == ExtremeType::MAX_ABS)
    this->gatherProxyValueMax(_proxy_value.first, _proxy_value.second);
  else if (_type == ExtremeType::MIN)
    this->gatherProxyValueMin(_proxy_value.first, _proxy_value.second);
}

getProxyValuePair()

template<class T >

virtual std::pair< libMesh::Real, libMesh::Real > ExtremeValueBase< T >::getProxyValuePair ( )

protectedpure virtual

Implemented in ElementExtremeFunctorValueTempl< is_ad >, ElementExtremeValue, NodalExtremeValue, and SideExtremeValue.

getValue()

template<class T >

Real ExtremeValueBase< T >::getValue ( ) const

overridevirtual

Definition at line 66 of file ExtremeValueBase.C.

{
  return _proxy_value.second;
}

initialize()

template<class T >

void ExtremeValueBase< T >::initialize ( )

overridevirtual

Definition at line 41 of file ExtremeValueBase.C.

{
  if (_type == ExtremeType::MAX || _type == ExtremeType::MAX_ABS)
    _proxy_value =
        std::make_pair(-std::numeric_limits<Real>::max(), -std::numeric_limits<Real>::max());
  else if (_type == ExtremeType::MIN)
    _proxy_value =
        std::make_pair(std::numeric_limits<Real>::max(), std::numeric_limits<Real>::max());
}

threadJoin()

template<class T >

void ExtremeValueBase< T >::threadJoin ( const UserObject &  y )

overridevirtual

Definition at line 83 of file ExtremeValueBase.C.

{
  const auto & pps = static_cast<const ExtremeValueBase<T> &>(y);
 
  if (((_type == ExtremeType::MAX || _type == ExtremeType::MAX_ABS) &&
       pps._proxy_value > _proxy_value) ||
      (_type == ExtremeType::MIN && pps._proxy_value < _proxy_value))
    _proxy_value = pps._proxy_value;
}

validParams()

template<class T >

InputParameters ExtremeValueBase< T >::validParams ( )

static

Definition at line 21 of file ExtremeValueBase.C.

{
  InputParameters params = T::validParams();
  params.addParam<MooseEnum>(
      "value_type",
      MooseEnum("max=0 min=1 max_abs=2", "max"),
      "Type of extreme value to return. 'max' "
      "returns the maximum value. 'min' returns "
      "the minimum value. 'max_abs' returns the maximum of the absolute value.");
  return params;
}

Referenced by ElementExtremeFunctorValueTempl< is_ad >::validParams(), ElementExtremeValue::validParams(), NodalExtremeValue::validParams(), and SideExtremeValue::validParams().

Member Data Documentation

_proxy_value

template<class T >

std::pair<libMesh::Real, libMesh::Real> ExtremeValueBase< T >::_proxy_value

protected

Extreme value and proxy value at the same point.

Definition at line 46 of file ExtremeValueBase.h.

Referenced by ExtremeValueBase< T >::threadJoin().

_type

template<class T >

enum ExtremeValueBase::ExtremeType ExtremeValueBase< T >::_type

protected

---

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

• include/postprocessors/ExtremeValueBase.h
• src/postprocessors/ExtremeValueBase.C