LayeredExtremumMaterialProperty.C

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

#include "LayeredExtremumMaterialProperty.h"

#include "libmesh/mesh_tools.h"

registerMooseObject("MooseApp", LayeredExtremumMaterialProperty);

InputParameters
LayeredExtremumMaterialProperty::validParams()
{
  InputParameters params = ElementExtremeMaterialProperty::validParams();
  params += LayeredBase::validParams();
  params.addClassDescription("Compute material property extrema over layers.");
  params.registerBase("UserObject");

  return params;
}

LayeredExtremumMaterialProperty::LayeredExtremumMaterialProperty(const InputParameters & parameters)
  : ElementExtremeMaterialProperty(parameters), LayeredBase(parameters)
{
}

void
LayeredExtremumMaterialProperty::initialize()
{
  ElementExtremeMaterialProperty::initialize();
  LayeredBase::initialize();

  // Initialize layer values
  for (const auto layer : make_range(_num_layers))
    setLayerValue(
        layer, _type == MIN ? std::numeric_limits<Real>::max() : -std::numeric_limits<Real>::max());
}

void
LayeredExtremumMaterialProperty::execute()
{
  // Do not keep track of the layer extremum with _value
  ElementExtremeMaterialProperty::initialize();
  ElementExtremeMaterialProperty::execute();
  const auto layer = getLayer(_current_elem->vertex_average());

  setLayerValue(layer, extreme_value(getLayerValue(layer), _value));
}

Real
LayeredExtremumMaterialProperty::extreme_value(const Real a, const Real b) const
{
  if (_type == MIN)
    return std::min(a, b);
  else
    return std::max(a, b);
}

void
LayeredExtremumMaterialProperty::finalize()
{
  if (_type == MIN)
    comm().min(_layer_values);
  else
    comm().max(_layer_values);
  comm().max(_layer_has_value);

  if (_cumulative)
  {
    Real value =
        _type == MIN ? std::numeric_limits<Real>::max() : -std::numeric_limits<Real>::max();

    if (_positive_cumulative_direction)
      for (unsigned i = 0; i < _num_layers; i++)
      {
        value = extreme_value(value, getLayerValue(i));
        setLayerValue(i, value);
      }
    else
      for (int i = _num_layers - 1; i >= 0; i--)
      {
        value = extreme_value(value, getLayerValue(i));
        setLayerValue(i, value);
      }
  }
}

void
LayeredExtremumMaterialProperty::threadJoin(const UserObject & y)
{
  const auto & lb = static_cast<const LayeredExtremumMaterialProperty &>(y);
  for (const auto i : make_range(_num_layers))
    if (lb.layerHasValue(i))
      setLayerValue(i, extreme_value(getLayerValue(i), lb.getLayerValue(i)));
}

const std::vector<Point>
LayeredExtremumMaterialProperty::spatialPoints() const
{
  std::vector<Point> points;

  for (const auto & l : _layer_centers)
  {
    Point pt(0.0, 0.0, 0.0);
    pt(_direction) = l;
    points.push_back(pt);
  }

  return points;
}