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

#include "SolutionInvalidity.h"

registerMooseObject("MooseApp", SolutionInvalidityReporter);

InputParameters
SolutionInvalidityReporter::validParams()
{
  InputParameters params = GeneralReporter::validParams();
  params.addClassDescription("Reports the Summary Table of Solution Invalid Counts.");
  // This reporter is simply executed on JSON output
  params.suppressParameter<ExecFlagEnum>("execute_on");
  return params;
}

SolutionInvalidityReporter::SolutionInvalidityReporter(const InputParameters & parameters)
  : GeneralReporter(parameters)
{
  declareValueByName<const SolutionInvalidity *>(
      "solution_invalidity", REPORTER_MODE_ROOT, &_app.solutionInvalidity());
}

void
to_json(nlohmann::json & json, const SolutionInvalidity * const & solution_invalidity)
{
  mooseAssert(solution_invalidity->processor_id() == 0, "should only be called on rank 0");

  const auto & solution_registry = moose::internal::getSolutionInvalidityRegistry();
  const auto & counts = solution_invalidity->counts();
  if (counts.size() == 0)
    // Create an empty array
    json = nlohmann::json::array();
  else
    // Output data to json
    for (const auto id : index_range(solution_invalidity->counts()))
    {
      nlohmann::json entry;
      entry["object_type"] = solution_registry.item(id).object_type;
      entry["message"] = solution_registry.item(id).message;
      entry["timestep_counts"] = counts[id].current_timestep_counts;
      entry["total_counts"] = counts[id].total_counts;
      json.push_back(entry);
    }
}