SamplerBase.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 "SamplerBase.h"
#include "IndirectSort.h"
#include "InputParameters.h"
#include "MooseEnum.h"
#include "MooseError.h"
#include "VectorPostprocessor.h"
#include "MooseVariableFieldBase.h"
#include "FEProblemBase.h"
#include "MooseApp.h"
#include "TransientBase.h"

#include "libmesh/point.h"

InputParameters
SamplerBase::validParams()
{
  InputParameters params = emptyInputParameters();

  params.addRequiredParam<std::string>(
      "sort_by",
      "What to sort the samples by. Options include 'x', 'y', 'z', 'id', and the name of any of "
      "the sampled quantities (which each create a vector of the same name).");

  // The value from this VPP is naturally already on every processor
  // TODO: Make this not the case!  See #11415
  params.set<bool>("_auto_broadcast") = false;

  return params;
}

SamplerBase::SamplerBase(const InputParameters & parameters,
                         VectorPostprocessor * vpp,
                         const libMesh::Parallel::Communicator & comm)
  : _sampler_params(parameters),
    _vpp(vpp),
    _comm(comm),
    _sampler_transient(dynamic_cast<TransientBase *>(
        parameters.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")
            ->getMooseApp()
            .getExecutioner())),
    _sort_by_index(libMesh::invalid_uint),
    _x(vpp->declareVector("x")),
    _y(vpp->declareVector("y")),
    _z(vpp->declareVector("z")),
    _id(vpp->declareVector("id")),
    _sort_by(parameters.get<std::string>("sort_by"))
{
  if (_sort_by == "x")
    _sort_by_index = 0;
  else if (_sort_by == "y")
    _sort_by_index = 1;
  else if (_sort_by == "z")
    _sort_by_index = 2;
  else if (_sort_by == "id")
    _sort_by_index = 3;
  // Sort by index for variables determined in setupVariables()
}

void
SamplerBase::setupVariables(const std::vector<std::string> & variable_names)
{
  _variable_names = variable_names;
  _values.reserve(variable_names.size());

  for (const auto & variable_name : variable_names)
    _values.push_back(&_vpp->declareVector(variable_name));

  // Find the index of the column to sort by for variables
  if (_sort_by_index == libMesh::invalid_uint)
  {
    const auto it = std::find(_variable_names.begin(), _variable_names.end(), _sort_by);
    if (it != _variable_names.end())
      _sort_by_index = 4 + it - _variable_names.begin();
    else
      mooseError(
          "The 'sort_by' parameter must be one of x/y/z/id or one of the sampled variable names: " +
          Moose::stringify(_variable_names));
  }
}

void
SamplerBase::addSample(const Point & p, const Real & id, const std::vector<Real> & values)
{
  _x.push_back(p(0));
  _y.push_back(p(1));
  _z.push_back(p(2));

  _id.push_back(id);

  mooseAssert(values.size() == _variable_names.size(), "Mismatch of variable names to vector size");
  for (MooseIndex(values) i = 0; i < values.size(); ++i)
    _values[i]->emplace_back(values[i]);

  _curr_num_samples++;
}

void
SamplerBase::initialize()
{
  // Don't reset the vectors if we want to retain history
  if (_vpp->containsCompleteHistory() && _comm.rank() == 0)
  {
    // If we are repeating the timestep due to an aborted solve, we want to throw away the last
    // values
    if (_sampler_transient && !_sampler_transient->lastSolveConverged())
    {
      // Convenient to allocate a single variable for all the vpp values
      std::vector<VectorPostprocessorValue *> vec_ptrs = {{&_x, &_y, &_z, &_id}};
      vec_ptrs.insert(vec_ptrs.end(), _values.begin(), _values.end());
      // Erase the elements from the last execution
      for (auto vec_ptr : vec_ptrs)
      {
        // Vector may have already been restored, if so, skip the erasure
        if (_curr_total_samples > vec_ptr->size())
        {
          mooseAssert(vec_ptr->size() == (_curr_total_samples - _curr_num_samples),
                      "Number of samples is not what is expected.");
          continue;
        }
        for (auto ind : _curr_indices)
        {
          mooseAssert(ind < vec_ptr->size(), "Trying to remove a sample that doesn't exist.");
          vec_ptr->erase(vec_ptr->begin() + ind);
        }
      }
    }
    _curr_indices.clear();
  }
  else
  {
    _x.clear();
    _y.clear();
    _z.clear();
    _id.clear();

    std::for_each(
        _values.begin(), _values.end(), [](VectorPostprocessorValue * vec) { vec->clear(); });
  }

  _curr_num_samples = 0;
}

void
SamplerBase::checkForStandardFieldVariableType(const MooseVariableFieldBase * const var_ptr,
                                               const std::string & var_param_name) const
{
  // A pointer to a MooseVariableFieldBase should never be SCALAR
  mooseAssert(var_ptr->feType().family != SCALAR,
              "Scalar variable '" + var_ptr->name() + "' cannot be sampled.");
  mooseAssert(dynamic_cast<const MooseObject *>(_vpp), "Should have succeeded");
  if (var_ptr->isVector())
    dynamic_cast<const MooseObject *>(_vpp)->paramError(
        var_param_name,
        "The variable '",
        var_ptr->name(),
        "' is a vector variable. Sampling those is not currently supported in the "
        "framework. It may be supported using a dedicated object in your application. Use "
        "'VectorVariableComponentAux' auxkernel to copy those values into a regular field "
        "variable");
  if (var_ptr->isArray())
    dynamic_cast<const MooseObject *>(_vpp)->paramError(
        var_param_name,
        "The variable '",
        var_ptr->name(),
        "' is an array variable. Sampling those is not currently supported in the "
        "framework. It may be supported using a dedicated object in your application. Use "
        "'ArrayVariableComponent' auxkernel to copy those values into a regular field variable");
}

void
SamplerBase::finalize()
{
  constexpr auto NUM_ID_VECTORS = 4;

  std::vector<VectorPostprocessorValue *> vec_ptrs;
  vec_ptrs.reserve(_values.size() + NUM_ID_VECTORS);
  // Initialize the pointer vector with the position and ID vectors
  vec_ptrs = {{&_x, &_y, &_z, &_id}};
  // Now extend the vector by all the remaining values vector before processing
  vec_ptrs.insert(vec_ptrs.end(), _values.begin(), _values.end());

  // Gather up each of the partial vectors
  for (auto vec_ptr : vec_ptrs)
    _comm.allgather(*vec_ptr, /* identical buffer lengths = */ false);

  // Now create an index vector by using an indirect sort
  std::vector<std::size_t> sorted_indices;
  Moose::indirectSort(
      vec_ptrs[_sort_by_index]->begin(), vec_ptrs[_sort_by_index]->end(), sorted_indices);

  // This vector is used as temp storage to sort each of the remaining vectors according to the
  // first
  auto vector_length = sorted_indices.size();
  VectorPostprocessorValue tmp_vector(vector_length);

#ifndef NDEBUG
  for (const auto vec_ptr : vec_ptrs)
    if (vec_ptr->size() != vector_length)
      mooseError("Vector length mismatch");
#endif

  // Sort each of the vectors using the same sorted indices
  for (auto & vec_ptr : vec_ptrs)
  {
    for (MooseIndex(sorted_indices) j = 0; j < sorted_indices.size(); ++j)
      tmp_vector[j] = (*vec_ptr)[sorted_indices[j]];

    // Swap vector storage with sorted vector
    vec_ptr->swap(tmp_vector);
  }

  // Gather the indices of samples from the last execution
  // Used to determine which parts of the vector need to be erased if a solve fails
  if (_vpp->containsCompleteHistory())
  {
    _comm.sum(_curr_num_samples);
    if (_comm.rank() == 0)
    {
      _curr_indices.insert(sorted_indices.end() - _curr_num_samples, sorted_indices.end());
      _curr_total_samples = vec_ptrs[0]->size();
    }
  }
}

void
SamplerBase::threadJoin(const SamplerBase & y)
{
  _x.insert(_x.end(), y._x.begin(), y._x.end());
  _y.insert(_y.end(), y._y.begin(), y._y.end());
  _z.insert(_z.end(), y._z.begin(), y._z.end());

  _id.insert(_id.end(), y._id.begin(), y._id.end());

  for (MooseIndex(_variable_names) i = 0; i < _variable_names.size(); i++)
    _values[i]->insert(_values[i]->end(), y._values[i]->begin(), y._values[i]->end());

  _curr_num_samples += y._curr_num_samples;
}