ReporterContext.h

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
#pragma once

#include <iostream>
#include <typeinfo>

#include "MooseError.h"
#include "libmesh/id_types.h"
#include "libmesh/parallel.h"
#include "libmesh/parallel_object.h"

#include "ReporterName.h"
#include "ReporterMode.h"
#include "ReporterState.h"
#include "JsonIO.h"
#include "JsonSyntaxTree.h"
#include "MooseObject.h"
#include <type_traits>

class ReporterData;

class ReporterContextBase : public libMesh::ParallelObject
{
public:
  ReporterContextBase(const libMesh::ParallelObject & other, const MooseObject & producer);
  virtual ~ReporterContextBase() = default;

  virtual const ReporterName & name() const = 0;

  // This is a helper for ReporterContext::storeInfo
  virtual std::string type() const = 0;

  virtual std::string contextType() const = 0;

  virtual void copyValuesBack() = 0;

  virtual bool restoreState() = 0;

  virtual void storeInfo(nlohmann::json & json) const = 0;

  virtual void store(nlohmann::json & json) const = 0;

  virtual void finalize() = 0; // new ReporterContext objects should override

  void init(const ReporterMode & mode);

  const MooseObject & getProducer() const { return _producer; }

  const ReporterProducerEnum & getProducerModeEnum() const;

  virtual void transfer(ReporterData & r_data,
                        const ReporterName & r_name,
                        unsigned int time_index = 0) const = 0;

  virtual void transferToVector(ReporterData & r_data,
                                const ReporterName & r_name,
                                dof_id_type index,
                                unsigned int time_index = 0) const = 0;

  virtual void transferFromVector(ReporterData & r_data,
                                  const ReporterName & r_name,
                                  dof_id_type index,
                                  unsigned int time_index = 0) const = 0;

  virtual void declareClone(ReporterData & r_data,
                            const ReporterName & r_name,
                            const ReporterMode & mode,
                            const MooseObject & producer) const = 0;

  virtual void declareVectorClone(ReporterData & r_data,
                                  const ReporterName & r_name,
                                  const ReporterMode & mode,
                                  const MooseObject & producer) const = 0;

  virtual void resize(dof_id_type local_size) = 0;

  virtual void clear() = 0;

  virtual void vectorSum() = 0;

protected:
  void requiresConsumerModes(const ReporterStateBase & state,
                             const std::set<ReporterMode> & modes) const;

  const MooseObject & _producer;

  ReporterProducerEnum _producer_enum;
};

template <typename T>
class ReporterContext : public ReporterContextBase
{
public:
  enum class AutoOperation
  {
    NONE,
    BROADCAST
  };

  ReporterContext(const libMesh::ParallelObject & other,
                  const MooseObject & producer,
                  ReporterState<T> & state);
  ReporterContext(const libMesh::ParallelObject & other,
                  const MooseObject & producer,
                  ReporterState<T> & state,
                  const T & default_value);

  const ReporterName & name() const override final { return _state.getReporterName(); }

  const ReporterState<T> & state() const { return _state; }

  virtual std::string type() const override { return MooseUtils::prettyCppType<T>(); }

  virtual void finalize() override;

  virtual void transfer(ReporterData & r_data,
                        const ReporterName & r_name,
                        unsigned int time_index = 0) const override;

  virtual void transferToVector(ReporterData & r_data,
                                const ReporterName & r_name,
                                dof_id_type index,
                                unsigned int time_index = 0) const override;

  virtual void transferFromVector(ReporterData & r_data,
                                  const ReporterName & r_name,
                                  dof_id_type index,
                                  unsigned int time_index = 0) const override;

protected:
  void broadcast()
  {
    if constexpr (MooseUtils::canBroadcast<T>::value)
      this->comm().broadcast(this->_state.value());
    else
      mooseError("Cannot broadcast Reporter type '", MooseUtils::prettyCppType<T>(), "'");
  }

  virtual void storeInfo(nlohmann::json & json) const override;

  virtual void store(nlohmann::json & json) const override;

  virtual std::string contextType() const override = 0;

  // The following are called by the ReporterData and are not indented for external use
  virtual void copyValuesBack() override;

  virtual bool restoreState() override { return _state.restoreState(); }

  ReporterState<T> & _state;
};

template <typename T>
ReporterContext<T>::ReporterContext(const libMesh::ParallelObject & other,
                                    const MooseObject & producer,
                                    ReporterState<T> & state)
  : ReporterContextBase(other, producer), _state(state)
{
  _producer_enum.insert(REPORTER_MODE_ROOT, REPORTER_MODE_REPLICATED, REPORTER_MODE_DISTRIBUTED);
}

template <typename T>
ReporterContext<T>::ReporterContext(const libMesh::ParallelObject & other,
                                    const MooseObject & producer,
                                    ReporterState<T> & state,
                                    const T & default_value)
  : ReporterContext(other, producer, state)
{
  _state.value() = default_value;
}

template <typename T>
void
ReporterContext<T>::finalize()
{
  // Automatic parallel operation to perform
  ReporterContext::AutoOperation auto_operation = ReporterContext::AutoOperation::NONE;

  // Set the default producer mode to ROOT
  if (!_producer_enum.isValid())
    _producer_enum.assign(REPORTER_MODE_ROOT);

  // Determine auto parallel operation to perform
  const auto & producer = _producer_enum; // convenience
  for (const auto & pair : _state.getConsumers())
  {
    const ReporterMode consumer = pair.first;
    const MooseObject * moose_object = pair.second;

    // The following sets up the automatic operations and performs error checking for the various
    // modes for the producer and consumer
    //
    // The data is correct and requires no operation for the following conditions (PRODUCER ->
    // CONSUMER)
    //            ROOT -> ROOT
    //      REPLICATED -> REPLICATED
    //     DISTRIBUTED -> DISTRIBUTED
    //      REPLICATED -> ROOT

    // Perform broadcast in the case
    //            ROOT -> REPLICATED
    if (static_cast<int>(producer) == REPORTER_MODE_ROOT && consumer == REPORTER_MODE_REPLICATED)
      auto_operation = ReporterContext::AutoOperation::BROADCAST;

    // The following are not support and create an error
    //            ROOT -> DISTRIBUTED
    //      REPLICATED -> DISTRIBUTED
    //     DISTRIBUTED -> ROOT
    //     DISTRIBUTED -> REPLICATED
    else if ((static_cast<int>(producer) == REPORTER_MODE_ROOT &&
              consumer == REPORTER_MODE_DISTRIBUTED) ||
             (static_cast<int>(producer) == REPORTER_MODE_REPLICATED &&
              consumer == REPORTER_MODE_DISTRIBUTED) ||
             (static_cast<int>(producer) == REPORTER_MODE_DISTRIBUTED &&
              consumer == REPORTER_MODE_ROOT) ||
             (static_cast<int>(producer) == REPORTER_MODE_DISTRIBUTED &&
              consumer == REPORTER_MODE_REPLICATED))
      mooseError("The Reporter value \"",
                 name(),
                 "\" is being produced in ",
                 producer,
                 " mode, but the ",
                 moose_object->typeAndName(),
                 " is requesting to consume it in ",
                 consumer,
                 " mode, which is not supported.");
  }

  // Perform desired auto parallel operation
  if (auto_operation == ReporterContext::AutoOperation::BROADCAST)
    this->broadcast();
}

template <typename T>
void
ReporterContext<T>::copyValuesBack()
{
  _state.copyValuesBack();
}

template <typename T>
void
ReporterContext<T>::storeInfo(nlohmann::json & json) const
{
  json["type"] = this->type();
}

template <typename T>
void
ReporterContext<T>::store(nlohmann::json & json) const
{
  nlohmann::to_json(json, this->_state.value());
}

template <typename T>
class ReporterGeneralContext : public ReporterContext<T>
{
public:
  ReporterGeneralContext(const libMesh::ParallelObject & other,
                         const MooseObject & producer,
                         ReporterState<T> & state)
    : ReporterContext<T>(other, producer, state)
  {
  }
  ReporterGeneralContext(const libMesh::ParallelObject & other,
                         const MooseObject & producer,
                         ReporterState<T> & state,
                         const T & default_value)
    : ReporterContext<T>(other, producer, state, default_value)
  {
  }

  virtual void declareClone(ReporterData & r_data,
                            const ReporterName & r_name,
                            const ReporterMode & mode,
                            const MooseObject & producer) const override;
  virtual void declareVectorClone(ReporterData & r_data,
                                  const ReporterName & r_name,
                                  const ReporterMode & mode,
                                  const MooseObject & producer) const override;

  virtual void resize(dof_id_type local_size) final;
  virtual void clear() final;
  virtual void vectorSum() final;

  virtual std::string contextType() const override { return MooseUtils::prettyCppType(this); }
};

//  Needed for compile-time checking if T is a vector.
template <typename>
struct is_std_vector : std::false_type
{
};

template <typename T, typename A>
struct is_std_vector<std::vector<T, A>> : std::true_type
{
};

template <typename T>
void
ReporterGeneralContext<T>::resize(dof_id_type size)
{
  if constexpr (is_std_vector<T>::value)
    this->_state.value().resize(size);
  else
  {
    libmesh_ignore(size);
    mooseError("Cannot resize non vector-type reporter values.");
  }
}
template <typename T>
void
ReporterGeneralContext<T>::clear()
{
  if constexpr (is_std_vector<T>::value)
    this->_state.value().clear();
  else
    mooseError("Cannot clear non vector-type reporter values.");
}

template <typename T>
void
ReporterGeneralContext<T>::vectorSum()
{
  // Case 1: T is a numeric type that we can sum (excluding bool)
  if constexpr (std::is_arithmetic<T>::value && !std::is_same<T, bool>::value)
  {
    // Perform summation of the scalar value across all processors
    this->comm().sum(this->_state.value());
    return;
  }
  // Case 2: T is a vector type
  else if constexpr (is_std_vector<T>::value)
  {
    using VectorValueType = typename T::value_type;

    // Check if the vector elements are of a numeric type
    if constexpr (std::is_arithmetic<VectorValueType>::value &&
                  !std::is_same<VectorValueType, bool>::value)
    {
      // Perform summation of the vector elements across all processors
      this->comm().sum(this->_state.value());
      return;
    }
    // Check if the vector elements are also vectors
    else if constexpr (is_std_vector<VectorValueType>::value)
    {
      using InnerValueType = typename VectorValueType::value_type;

      // Check if the inner vector elements are of a numeric type
      if constexpr (std::is_arithmetic<InnerValueType>::value &&
                    !std::is_same<InnerValueType, bool>::value)
      {
#ifdef DEBUG
        auto vec_size = this->_state.value().size();
        this->comm().max(vec_size);
        // Assert only passes on all ranks if they are all the same size.
        mooseAssert(this->_state.value().size() == vec_size,
                    "Reporter vector have different sizes on different ranks.");
#endif
        // Iterate over each inner vector in the outer vector
        for (auto & innerVector : this->_state.value())
        {
          // Get the maximum size of the inner vector across all processors
          dof_id_type maxInnerSize = innerVector.size();
          this->comm().max(maxInnerSize);

          // Resize the inner vector to the maximum size
          innerVector.resize(maxInnerSize);

          // Perform summation of the inner vector elements across all processors
          this->comm().sum(innerVector);
        }
        return;
      }
    }
  }

  mooseError("Cannot perform sum operation on non-numeric or unsupported vector types.");
}

template <typename T>
class ReporterBroadcastContext : public ReporterGeneralContext<T>
{
public:
  ReporterBroadcastContext(const libMesh::ParallelObject & other,
                           const MooseObject & producer,
                           ReporterState<T> & state);
  ReporterBroadcastContext(const libMesh::ParallelObject & other,
                           const MooseObject & producer,
                           ReporterState<T> & state,
                           const T & default_value);
  virtual void finalize() override;
  virtual std::string contextType() const override { return MooseUtils::prettyCppType(this); }
};

template <typename T>
ReporterBroadcastContext<T>::ReporterBroadcastContext(const libMesh::ParallelObject & other,
                                                      const MooseObject & producer,
                                                      ReporterState<T> & state)
  : ReporterGeneralContext<T>(other, producer, state)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_ROOT);
}

template <typename T>
ReporterBroadcastContext<T>::ReporterBroadcastContext(const libMesh::ParallelObject & other,
                                                      const MooseObject & producer,
                                                      ReporterState<T> & state,
                                                      const T & default_value)
  : ReporterGeneralContext<T>(other, producer, state, default_value)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_ROOT);
}

template <typename T>
void
ReporterBroadcastContext<T>::finalize()
{
  this->requiresConsumerModes(this->_state, {REPORTER_MODE_UNSET, REPORTER_MODE_REPLICATED});
  this->broadcast();
}

template <typename T>
class ReporterScatterContext : public ReporterGeneralContext<T>
{
public:
  ReporterScatterContext(const libMesh::ParallelObject & other,
                         const MooseObject & producer,
                         ReporterState<T> & state,
                         const std::vector<T> & values);
  ReporterScatterContext(const libMesh::ParallelObject & other,
                         const MooseObject & producer,
                         ReporterState<T> & state,
                         const T & default_value,
                         const std::vector<T> & values);

  virtual void finalize() override;
  virtual std::string contextType() const override { return MooseUtils::prettyCppType(this); }

private:
  const std::vector<T> & _values;
};

template <typename T>
ReporterScatterContext<T>::ReporterScatterContext(const libMesh::ParallelObject & other,
                                                  const MooseObject & producer,
                                                  ReporterState<T> & state,
                                                  const std::vector<T> & values)
  : ReporterGeneralContext<T>(other, producer, state), _values(values)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_ROOT);
}

template <typename T>
ReporterScatterContext<T>::ReporterScatterContext(const libMesh::ParallelObject & other,
                                                  const MooseObject & producer,
                                                  ReporterState<T> & state,
                                                  const T & default_value,
                                                  const std::vector<T> & values)
  : ReporterGeneralContext<T>(other, producer, state, default_value), _values(values)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_ROOT);
}

template <typename T>
void
ReporterScatterContext<T>::finalize()
{
  this->requiresConsumerModes(this->_state, {REPORTER_MODE_UNSET, REPORTER_MODE_REPLICATED});

  mooseAssert(this->processor_id() == 0 ? _values.size() == this->n_processors() : true,
              "Vector to be scattered must be sized to match the number of processors");
  mooseAssert(
      this->processor_id() > 0 ? _values.size() == 0 : true,
      "Vector to be scattered must be sized to zero on processors except for the root processor");
  this->comm().scatter(_values, this->_state.value());
}

template <typename T>
class ReporterGatherContext : public ReporterGeneralContext<T>
{
public:
  ReporterGatherContext(const libMesh::ParallelObject & other,
                        const MooseObject & producer,
                        ReporterState<T> & state);
  ReporterGatherContext(const libMesh::ParallelObject & other,
                        const MooseObject & producer,
                        ReporterState<T> & state,
                        const T & default_value);

  virtual void finalize() override;
  virtual std::string contextType() const override { return MooseUtils::prettyCppType(this); }
};

template <typename T>
ReporterGatherContext<T>::ReporterGatherContext(const libMesh::ParallelObject & other,
                                                const MooseObject & producer,
                                                ReporterState<T> & state)
  : ReporterGeneralContext<T>(other, producer, state)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_DISTRIBUTED);
}

template <typename T>
ReporterGatherContext<T>::ReporterGatherContext(const libMesh::ParallelObject & other,
                                                const MooseObject & producer,
                                                ReporterState<T> & state,
                                                const T & default_value)
  : ReporterGeneralContext<T>(other, producer, state, default_value)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_DISTRIBUTED);
}

template <typename T>
void
ReporterGatherContext<T>::finalize()
{
  this->requiresConsumerModes(this->_state, {REPORTER_MODE_UNSET, REPORTER_MODE_ROOT});
  this->comm().gather(0, this->_state.value());
}

template <typename T>
class ReporterVectorContext : public ReporterContext<std::vector<T>>
{
public:
  ReporterVectorContext(const libMesh::ParallelObject & other,
                        const MooseObject & producer,
                        ReporterState<std::vector<T>> & state);
  ReporterVectorContext(const libMesh::ParallelObject & other,
                        const MooseObject & producer,
                        ReporterState<std::vector<T>> & state,
                        const std::vector<T> & default_value);

  virtual void declareClone(ReporterData & r_data,
                            const ReporterName & r_name,
                            const ReporterMode & mode,
                            const MooseObject & producer) const final;

  virtual void declareVectorClone(ReporterData & r_data,
                                  const ReporterName & r_name,
                                  const ReporterMode & mode,
                                  const MooseObject & producer) const final;

  virtual void resize(dof_id_type local_size) override { this->_state.value().resize(local_size); }

  virtual void clear() override { this->_state.value().clear(); }

  virtual void vectorSum() override
  {
    // Case 1: T is type that we can sum
    if constexpr (std::is_arithmetic<T>::value &&
                  !std::is_same<T, bool>::value) // We can't sum bools.
    {
      // Resize vector to max size
      dof_id_type vec_size = this->_state.value().size();
      this->comm().max(vec_size);
      this->_state.value().resize(vec_size);

      this->comm().sum(this->_state.value());
      return;
    }
    // Case 2: T is a vector
    else if constexpr (is_std_vector<T>::value)
    {
      // Resize vector to max size
      dof_id_type vec_size = this->_state.value().size();
      this->comm().max(vec_size);
      this->_state.value().resize(vec_size);

      using ValueType = typename T::value_type;
      // Check if the ValueType is a vector
      if constexpr (std::is_arithmetic<ValueType>::value && !std::is_same<ValueType, bool>::value)
      {
#ifdef DEBUG
        auto vec_size = this->_state.value().size();
        this->comm().max(vec_size);
        // Assert only passes on all ranks if they are all the same size.
        mooseAssert(this->_state.value().size() == vec_size,
                    "Reporter vector have different sizes on different ranks.");
#endif
        for (auto & val_vec : this->_state.value())
        {
          // Resize vector to max size
          dof_id_type val_vec_size = val_vec.size();
          this->comm().max(val_vec_size);
          val_vec.resize(val_vec_size);

          this->comm().sum(val_vec);
        }
        return;
      }
    }
    // If we don't perform a summing operation, error out.
    mooseError("Cannot perform sum operation on non-numeric or unsupported vector types.");
  }

  virtual std::string contextType() const override { return MooseUtils::prettyCppType(this); }
};

template <typename T>
ReporterVectorContext<T>::ReporterVectorContext(const libMesh::ParallelObject & other,
                                                const MooseObject & producer,
                                                ReporterState<std::vector<T>> & state)
  : ReporterContext<std::vector<T>>(other, producer, state)
{
}

template <typename T>
ReporterVectorContext<T>::ReporterVectorContext(const libMesh::ParallelObject & other,
                                                const MooseObject & producer,
                                                ReporterState<std::vector<T>> & state,
                                                const std::vector<T> & default_value)
  : ReporterContext<std::vector<T>>(other, producer, state, default_value)
{
}