AverageGrainVolume.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 "AverageGrainVolume.h"
#include "FeatureFloodCount.h"
#include "MooseMesh.h"
#include "Assembly.h"
#include "MooseVariable.h"
#include "SystemBase.h"

#include "libmesh/quadrature.h"

registerMooseObject("PhaseFieldApp", AverageGrainVolume);

InputParameters
AverageGrainVolume::validParams()
{
  InputParameters params = GeneralPostprocessor::validParams();
  params.addClassDescription("Calculate average grain area in a polycrystal");

  // Mode 1: Use the GrainTracker
  params.addParam<UserObjectName>("feature_counter",
                                  "The FeatureFloodCount UserObject to get values from.");

  // Mode 2: Calculate grain volumes adirectly
  params.addCoupledVarWithAutoBuild(
      "variable", "var_name_base", "op_num", "Array of coupled variables");
  params.addParam<unsigned int>("grain_num", "number of grains to create");
  return params;
}

AverageGrainVolume::AverageGrainVolume(const InputParameters & parameters)
  : GeneralPostprocessor(parameters),
    Coupleable(this, false),
    MooseVariableDependencyInterface(this),
    _mesh(_subproblem.mesh()),
    _assembly(_subproblem.assembly(0, _sys.number())),
    _q_point(_assembly.qPoints()),
    _qrule(_assembly.qRule()),
    _JxW(_assembly.JxW()),
    _coord(_assembly.coordTransformation()),
    _feature_counter(isParamValid("feature_counter")
                         ? &getUserObject<FeatureFloodCount>("feature_counter")
                         : nullptr)
{
  if (!_feature_counter)
  {
    if (isParamValid("variable") && isParamValid("grain_num"))
    {
      auto num_coupled_vars = coupledComponents("variable");
      if (num_coupled_vars != getParam<unsigned int>("grain_num"))
        mooseError("The number of grains must match the number of OPs if a feature_counter is not "
                   "supplied");

      _vals = coupledValues("variable");

      _feature_volumes.resize(num_coupled_vars);

      // Build a reflexive map (ops map to grains directly)
      _static_var_to_feature.resize(num_coupled_vars);
      for (MooseIndex(_static_var_to_feature) i = 0; i < num_coupled_vars; ++i)
        _static_var_to_feature[i] = i;
    }
    else
      mooseError("Must supply either a feature_counter object or coupled variables and grain_num");
  }
  else
  {
    const auto & coupled_vars = _feature_counter->getCoupledVars();
    _vals.reserve(coupled_vars.size());

    for (auto & coupled_var : coupled_vars)
      _vals.emplace_back(&coupled_var->sln());

    addMooseVariableDependency(_feature_counter->getFECoupledVars());
  }
}

void
AverageGrainVolume::initialize()
{
  auto num_features = _feature_volumes.size();

  // When using FeatureFloodCount, the number of grains may not be fixed. Resize as appropriate
  if (_feature_counter)
    num_features = _feature_counter->getTotalFeatureCount();

  _feature_volumes.assign(num_features, 0);
}

void
AverageGrainVolume::execute()
{
  auto num_features = _feature_volumes.size();
  for (const auto & elem : _mesh.getMesh().active_local_element_ptr_range())
  {
    _fe_problem.prepare(elem, 0);
    _fe_problem.reinitElem(elem, 0);

    const std::vector<unsigned int> & var_to_feature_ptr =
        _feature_counter ? _feature_counter->getVarToFeatureVector(elem->id())
                         : _static_var_to_feature;

    accumulateVolumes(var_to_feature_ptr, num_features);
  }
}

void
AverageGrainVolume::accumulateVolumes(const std::vector<unsigned int> & var_to_features,
                                      std::size_t libmesh_dbg_var(num_features))
{
  for (MooseIndex(var_to_features) var_index = 0; var_index < var_to_features.size(); ++var_index)
  {
    // Only sample "active" variables
    if (var_to_features[var_index] != FeatureFloodCount::invalid_id)
    {
      auto feature_id = var_to_features[var_index];
      mooseAssert(feature_id < num_features, "Feature ID out of range");
      auto integral_value = computeIntegral(var_index);

      _feature_volumes[feature_id] += integral_value;
    }
  }
}

Real
AverageGrainVolume::computeIntegral(std::size_t var_index) const
{
  Real sum = 0;

  for (unsigned int qp = 0; qp < _qrule->n_points(); ++qp)
    sum += _JxW[qp] * _coord[qp] * (*_vals[var_index])[qp];

  return sum;
}

void
AverageGrainVolume::finalize()
{
  gatherSum(_feature_volumes);
}

Real
AverageGrainVolume::getValue() const
{
  Real total_volume = 0;
  for (auto & volume : _feature_volumes)
    total_volume += volume;

  unsigned int active_features =
      _feature_counter ? _feature_counter->getNumberActiveFeatures() : _feature_volumes.size();

  return total_volume / active_features;
}