MultiAppPostprocessorTransfer.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 "MultiAppPostprocessorTransfer.h"

// MOOSE includes
#include "MooseTypes.h"
#include "FEProblem.h"
#include "MultiApp.h"

// libMesh
#include "libmesh/meshfree_interpolation.h"
#include "libmesh/system.h"

registerMooseObject("MooseApp", MultiAppPostprocessorTransfer);

InputParameters
MultiAppPostprocessorTransfer::validParams()
{
  InputParameters params = MultiAppTransfer::validParams();
  params.addClassDescription(
      "Transfers postprocessor data between the master application and sub-application(s).");
  params.addRequiredParam<PostprocessorName>(
      "from_postprocessor",
      "The name of the Postprocessor in the Master to transfer the value from.");
  params.addRequiredParam<PostprocessorName>(
      "to_postprocessor",
      "The name of the Postprocessor in the MultiApp to transfer the value to. "
      " This should most likely be a Reporter Postprocessor.");
  MooseEnum reduction_type("average sum maximum minimum");
  params.addParam<MooseEnum>("reduction_type",
                             reduction_type,
                             "The type of reduction to perform to reduce postprocessor "
                             "values from multiple SubApps to a single value");
  MultiAppTransfer::addUserObjectExecutionCheckParam(params);

  return params;
}

MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(const InputParameters & parameters)
  : MultiAppTransfer(parameters),
    _from_pp_name(getParam<PostprocessorName>("from_postprocessor")),
    _to_pp_name(getParam<PostprocessorName>("to_postprocessor")),
    _reduction_type(getParam<MooseEnum>("reduction_type"))
{
  if (_directions.size() != 1)
    paramError("direction", "This transfer is only unidirectional");

  if (isParamValid("from_multi_app") && !isParamValid("to_multi_app") &&
      !isParamValid("reduction_type"))
    paramError("reduction_type",
               "In MultiAppPostprocessorTransfer, must specify 'reduction_type' if "
               "'from_multi_app' is set");

  if (isParamValid("to_multi_app") && !isParamValid("from_multi_app") &&
      isParamValid("reduction_type"))
    paramError("reduction_type", "Reduction is not supported for transfer from parent application");

  if (isParamValid("to_multi_app") && isParamValid("from_multi_app") &&
      isParamValid("reduction_type"))
    paramError("reduction_type", "Reductions are not supported for multiapp sibling transfers");
}

void
MultiAppPostprocessorTransfer::execute()
{
  TIME_SECTION("MultiAppPostprocessorTransfer::execute()", 5, "Transferring a postprocessor");

  // Execute the postprocessor if it was specified to execute on TRANSFER
  switch (_current_direction)
  {
    case TO_MULTIAPP:
    {
      checkParentAppUserObjectExecuteOn(_from_pp_name);
      _fe_problem.computeUserObjectByName(EXEC_TRANSFER, Moose::PRE_AUX, _from_pp_name);
      _fe_problem.computeUserObjectByName(EXEC_TRANSFER, Moose::POST_AUX, _from_pp_name);
      break;
    }
    case FROM_MULTIAPP:
    case BETWEEN_MULTIAPP:
      errorIfObjectExecutesOnTransferInSourceApp(_from_pp_name);
  }

  switch (_current_direction)
  {
    case BETWEEN_MULTIAPP:
      for (unsigned int i = 0; i < getFromMultiApp()->numGlobalApps(); i++)
      {
        // Get source postprocessor value
        Real pp_value = std::numeric_limits<Real>::max();
        if (getFromMultiApp()->hasLocalApp(i))
        {
          FEProblemBase & from_problem = getFromMultiApp()->appProblemBase(i);
          pp_value = from_problem.getPostprocessorValueByName(_from_pp_name);
        }

        // Find the postprocessor value from another process
        if (getFromMultiApp()->numGlobalApps() == 1)
          _communicator.min(pp_value);
        else
          mooseAssert(pp_value != std::numeric_limits<Real>::max() ||
                          !getToMultiApp()->hasLocalApp(i),
                      "Source and target app parallel distribution must be the same");

        // Case 1: a single source app, multiple target apps
        // All target apps must be local
        if (getFromMultiApp()->numGlobalApps() == 1)
          for (const auto j : make_range(getToMultiApp()->numGlobalApps()))
          {
            if (getToMultiApp()->hasLocalApp(j))
              getToMultiApp()->appProblemBase(j).setPostprocessorValueByName(_to_pp_name, pp_value);
          }

        // Case 2: same number of source and target apps
        // The allocation of the child apps on the processors must be the same
        else if (getToMultiApp()->hasLocalApp(i))
          getToMultiApp()->appProblemBase(i).setPostprocessorValueByName(_to_pp_name, pp_value);
      }
      break;
    case TO_MULTIAPP:
    {
      FEProblemBase & from_problem = getToMultiApp()->problemBase();

      const Real & pp_value = from_problem.getPostprocessorValueByName(_from_pp_name);

      for (unsigned int i = 0; i < getToMultiApp()->numGlobalApps(); i++)
        if (getToMultiApp()->hasLocalApp(i))
          getToMultiApp()->appProblemBase(i).setPostprocessorValueByName(_to_pp_name, pp_value);
      break;
    }
    case FROM_MULTIAPP:
    {
      FEProblemBase & to_problem = getFromMultiApp()->problemBase();

      Real reduced_pp_value;
      switch (_reduction_type)
      {
        case AVERAGE:
        case SUM:
          reduced_pp_value = 0;
          break;
        case MAXIMUM:
          reduced_pp_value = -std::numeric_limits<Real>::max();
          break;
        case MINIMUM:
          reduced_pp_value = std::numeric_limits<Real>::max();
          break;
        default:
          mooseError(
              "Can't get here unless someone adds a new enum and fails to add it to this switch");
      }

      const auto multi_app = hasFromMultiApp() ? getFromMultiApp() : getToMultiApp();

      for (unsigned int i = 0; i < multi_app->numGlobalApps(); i++)
      {
        if (multi_app->hasLocalApp(i) && multi_app->isRootProcessor())
        {
          const Real & curr_pp_value =
              multi_app->appProblemBase(i).getPostprocessorValueByName(_from_pp_name);
          switch (_reduction_type)
          {
            case AVERAGE:
            case SUM:
              reduced_pp_value += curr_pp_value;
              break;
            case MAXIMUM:
              reduced_pp_value = std::max(curr_pp_value, reduced_pp_value);
              break;
            case MINIMUM:
              reduced_pp_value = std::min(curr_pp_value, reduced_pp_value);
              break;
            default:
              mooseError("Can't get here unless someone adds a new enum and fails to add it to "
                         "this switch");
          }
        }
      }

      switch (_reduction_type)
      {
        case AVERAGE:
          _communicator.sum(reduced_pp_value);
          reduced_pp_value /= static_cast<Real>(multi_app->numGlobalApps());
          break;
        case SUM:
          _communicator.sum(reduced_pp_value);
          break;
        case MAXIMUM:
          _communicator.max(reduced_pp_value);
          break;
        case MINIMUM:
          _communicator.min(reduced_pp_value);
          break;
        default:
          mooseError(
              "Can't get here unless someone adds a new enum and fails to add it to this switch");
      }

      to_problem.setPostprocessorValueByName(_to_pp_name, reduced_pp_value);
      break;
    }
  }
}

void
MultiAppPostprocessorTransfer::checkSiblingsTransferSupported() const
{
  // Check that we are in one of the supported configurations
  // Case 2: same number of source and target apps
  // The allocation of the child apps on the processors must be the same
  if (getFromMultiApp()->numGlobalApps() == getToMultiApp()->numGlobalApps())
  {
    for (const auto i : make_range(getToMultiApp()->numGlobalApps()))
      if (getFromMultiApp()->hasLocalApp(i) + getToMultiApp()->hasLocalApp(i) == 1)
        mooseError("Child application allocation on parallel processes must be the same to support "
                   "siblings postprocessor transfer");
  }
  // Unsupported, we dont know how to choose a postprocessor value
  // We could default to 'any' value is good enough in the future, but it would not be reproducible
  // in parallel. Also every process will not necessarily have a 'source' value
  else if (getFromMultiApp()->numGlobalApps() != 1)
    mooseError("Number of source and target child apps must either match or only a single source "
               "app may be used");
}