ReporterScatterContext< T > Class Template Reference

A context that scatters the Reporter value from the root processor. More...

#include <ReporterContext.h>

Inheritance diagram for ReporterScatterContext< T >:

Public Types
enum class	AutoOperation { NONE , BROADCAST }
	Options for automatic parallel operations to perform by the default context. More...

Public Member Functions
	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
	Perform automatic parallel communication based on the producer/consumer modes.
virtual std::string	contextType () const override
virtual void	declareClone (ReporterData &r_data, const ReporterName &r_name, const ReporterMode &mode, const MooseObject &producer) const override
	Declare a reporter value of same type as this context.
virtual void	declareVectorClone (ReporterData &r_data, const ReporterName &r_name, const ReporterMode &mode, const MooseObject &producer) const override
	Declare a reporter value that is a vector of the same type as this context.
virtual void	resize (dof_id_type local_size) final
	Helper for resizing vector data.
virtual void	clear () final
	Helper for clearing vector data.
virtual void	vectorSum () final
	Helper for summing reporter value.
const ReporterName &	name () const override final
	Return the name of the Reporter value.
const ReporterState< T > &	state () const
	Return a reference to the ReporterState object that is storing the Reporter value.
virtual std::string	type () const override
	Return the type being stored by the associated ReporterState object.
virtual void	transfer (ReporterData &r_data, const ReporterName &r_name, unsigned int time_index=0) const override
	Perform type specific transfer.
virtual void	transferToVector (ReporterData &r_data, const ReporterName &r_name, dof_id_type index, unsigned int time_index=0) const override
	Perform type specific transfer to a vector.
virtual void	transferFromVector (ReporterData &r_data, const ReporterName &r_name, dof_id_type index, unsigned int time_index=0) const override
	Perform type specific transfer from a vector.
void	init (const ReporterMode &mode)
	Initialize the producer mode.
const MooseObject &	getProducer () const
	Return the MooseObject that produces this Reporter.
const ReporterProducerEnum &	getProducerModeEnum () const
	Return the Reporter value produced mode.
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const

Protected Member Functions
void	broadcast ()
virtual void	storeInfo (nlohmann::json &json) const override
	Output meta data to JSON, see JSONOutput.
virtual void	store (nlohmann::json &json) const override
	Output data to JSON, see JSONOutput.
virtual void	copyValuesBack () override
	Called by FEProblemBase::advanceState via ReporterData.
virtual bool	restoreState () override
	Restore state to its old values.
void	requiresConsumerModes (const ReporterStateBase &state, const std::set< ReporterMode > &modes) const
	Helper for checking whether or not the state state has only the modes modes.

Protected Attributes
ReporterState< T > &	_state
	The state on which this context object operates.
const MooseObject &	_producer
	The MooseObject that is producing this Reporter.
ReporterProducerEnum	_producer_enum
	Defines how the Reporter value can be produced and how it is being produced.
const Parallel::Communicator &	_communicator

Private Attributes
const std::vector< T > &	_values
	The values to scatter.

Detailed Description

template<typename T>
class ReporterScatterContext< T >

A context that scatters the Reporter value from the root processor.

Definition at line 622 of file ReporterContext.h.

Member Enumeration Documentation

AutoOperation

template<typename T >

enum class ReporterContext::AutoOperation

stronginherited

Options for automatic parallel operations to perform by the default context.

Enumerator
NONE
BROADCAST

Definition at line 234 of file ReporterContext.h.

  {
    NONE,
    BROADCAST
  };

Constructor & Destructor Documentation

ReporterScatterContext() [1/2]

template<typename T >

ReporterScatterContext< T >::ReporterScatterContext	(	const libMesh::ParallelObject &	other,
		const MooseObject &	producer,
		ReporterState< T > &	state,
		const std::vector< T > &	values
	)

Definition at line 644 of file ReporterContext.h.

  : ReporterGeneralContext<T>(other, producer, state), _values(values)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_ROOT);
}

ReporterScatterContext() [2/2]

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
	)

Definition at line 655 of file ReporterContext.h.

  : ReporterGeneralContext<T>(other, producer, state, default_value), _values(values)
{
  this->_producer_enum.clear();
  this->_producer_enum.insert(REPORTER_MODE_ROOT);
}

Member Function Documentation

broadcast()

template<typename T >

void ReporterContext< T >::broadcast ( )

inlineprotectedinherited

Definition at line 303 of file ReporterContext.h.

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

clear()

template<typename T >

void ReporterGeneralContext< T >::clear ( )

finalvirtualinherited

Helper for clearing vector data.

Implements ReporterContextBase.

Definition at line 502 of file ReporterContext.h.

{
  if constexpr (is_std_vector<T>::value)
    this->_state.value().clear();
  else
    mooseError("Cannot clear non vector-type reporter values.");
}

contextType()

template<typename T >

virtual std::string ReporterScatterContext< T >::contextType ( ) const

inlineoverridevirtual

Returns

The derived context type for this context.

This must be overridden in every class.

Reimplemented from ReporterGeneralContext< T >.

Definition at line 636 of file ReporterContext.h.

{ return MooseUtils::prettyCppType(this); }

copyValuesBack()

template<typename T >

void ReporterContext< T >::copyValuesBack ( )

overrideprotectedvirtualinherited

Called by FEProblemBase::advanceState via ReporterData.

Implements ReporterContextBase.

Reimplemented in VectorPostprocessorContext< T >.

Definition at line 412 of file ReporterContext.h.

{
  _state.copyValuesBack();
}

declareClone()

template<typename T >

void ReporterGeneralContext< T >::declareClone ( ReporterData &  r_data, const ReporterName &  r_name, const ReporterMode &  mode, const MooseObject &  producer  ) const

overridevirtualinherited

Declare a reporter value of same type as this context.

NOTE: This is defined in ReporterData.h to avoid cyclic includes that would arise. I don't know of a better solution, if you have one please implement it.

Implements ReporterContextBase.

Definition at line 572 of file ReporterData.h.

{
  r_data.declareReporterValue<T, ReporterGeneralContext<T>>(r_name, mode, producer);
}

declareVectorClone()

template<typename T >

void ReporterGeneralContext< T >::declareVectorClone ( ReporterData &  r_data, const ReporterName &  r_name, const ReporterMode &  mode, const MooseObject &  producer  ) const

overridevirtualinherited

Declare a reporter value that is a vector of the same type as this context.

NOTE: This is defined in ReporterData.h to avoid cyclic includes that would arise. I don't know of a better solution, if you have one please implement it.

Implements ReporterContextBase.

Definition at line 583 of file ReporterData.h.

{
  r_data.declareReporterValue<std::vector<T>, ReporterVectorContext<T>>(r_name, mode, producer);
}

finalize()

template<typename T >

void ReporterScatterContext< T >::finalize ( )

overridevirtual

Perform automatic parallel communication based on the producer/consumer modes.

Reimplemented from ReporterContext< T >.

Definition at line 668 of file ReporterContext.h.

{
  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());
}

getProducer()

const MooseObject & ReporterContextBase::getProducer ( ) const

inlineinherited

Return the MooseObject that produces this Reporter.

Definition at line 118 of file ReporterContext.h.

{ return _producer; }

Referenced by ReporterData::getReporterInfo().

getProducerModeEnum()

const ReporterProducerEnum & ReporterContextBase::getProducerModeEnum ( ) const

inherited

Return the Reporter value produced mode.

Definition at line 28 of file ReporterContext.C.

{
  return _producer_enum;
}

Referenced by ReporterData::getReporterMode().

init()

void ReporterContextBase::init ( const ReporterMode &  mode )

inherited

Initialize the producer mode.

This done after construction to allow the constructor to define the available values in the ReporterProducerEnum.

See also

ReporterData::declareReporterValue

Definition at line 21 of file ReporterContext.C.

{
  if (mode != REPORTER_MODE_UNSET)
    _producer_enum.assign(mode);
}

name()

template<typename T >

const ReporterName & ReporterContext< T >::name ( ) const

inlinefinaloverridevirtualinherited

Return the name of the Reporter value.

Implements ReporterContextBase.

Definition at line 251 of file ReporterContext.h.

{ return _state.getReporterName(); }

requiresConsumerModes()

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

protectedinherited

Helper for checking whether or not the state state has only the modes modes.

Definition at line 34 of file ReporterContext.C.

{
  for (const auto & mode_object_pair : state.getConsumers())
    if (!modes.count(mode_object_pair.first))
    {
      std::stringstream oss;
      std::copy(modes.begin(), modes.end(), std::ostream_iterator<ReporterMode>(oss, " "));
 
      mooseError("The Reporter value '",
                 name(),
                 "' is being produced in ",
                 _producer_enum,
                 " mode, but ",
                 mode_object_pair.second->typeAndName(),
                 " is requesting to consume it in ",
                 mode_object_pair.first,
                 " mode, which is not supported.\n\nThe mode must be { ",
                 oss.str(),
                 " }.\n\n",
                 ReporterData::getReporterInfo(state, this));
    }
}

resize()

template<typename T >

void ReporterGeneralContext< T >::resize ( dof_id_type  local_size )

finalvirtualinherited

Helper for resizing vector data.

Parameters

local_size

Number of elements to resize vector to

Implements ReporterContextBase.

Definition at line 490 of file ReporterContext.h.

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

restoreState()

template<typename T >

virtual bool ReporterContext< T >::restoreState ( )

inlineoverrideprotectedvirtualinherited

Restore state to its old values.

See also

ReporterState::restoreState

Implements ReporterContextBase.

Definition at line 323 of file ReporterContext.h.

{ return _state.restoreState(); }

state()

template<typename T >

const ReporterState< T > & ReporterContext< T >::state ( ) const

inlineinherited

Return a reference to the ReporterState object that is storing the Reporter value.

Definition at line 256 of file ReporterContext.h.

{ return _state; }

store()

template<typename T >

void ReporterContext< T >::store ( nlohmann::json &  json ) const

overrideprotectedvirtualinherited

Output data to JSON, see JSONOutput.

Implements ReporterContextBase.

Definition at line 426 of file ReporterContext.h.

{
  nlohmann::to_json(json, this->_state.value());
}

storeInfo()

template<typename T >

void ReporterContext< T >::storeInfo ( nlohmann::json &  json ) const

overrideprotectedvirtualinherited

Output meta data to JSON, see JSONOutput.

Implements ReporterContextBase.

Definition at line 419 of file ReporterContext.h.

{
  json["type"] = this->type();
}

transfer()

template<typename T >

void ReporterContext< T >::transfer ( ReporterData &  r_data, const ReporterName &  r_name, unsigned int  time_index = 0  ) const

overridevirtualinherited

Perform type specific transfer.

NOTE: This is defined in ReporterData.h to avoid cyclic includes that would arise. I don't know of a better solution, if you have one please implement it.

Implements ReporterContextBase.

Definition at line 515 of file ReporterData.h.

{
  r_data.setReporterValue<T>(r_name, _state.value(), time_index);
}

transferFromVector()

template<typename T >

void ReporterContext< T >::transferFromVector ( ReporterData &  r_data, const ReporterName &  r_name, dof_id_type  index, unsigned int  time_index = 0  ) const

overridevirtualinherited

Perform type specific transfer from a vector.

NOTE: This is defined in ReporterData.h to avoid cyclic includes that would arise. I don't know of a better solution, if you have one please implement it.

Implements ReporterContextBase.

Definition at line 542 of file ReporterData.h.

{
  if constexpr (is_std_vector<T>::value)
  {
    if (index >= _state.value().size())
      mooseError("Requested index ",
                 index,
                 " is outside the bounds of the vector reporter value ",
                 r_name);
 
    using R = typename T::value_type;
    r_data.setReporterValue<R>(r_name, _state.value()[index], time_index);
  }
  else
  {
    libmesh_ignore(r_data);
    libmesh_ignore(r_name);
    libmesh_ignore(index);
    libmesh_ignore(time_index);
    mooseError("transferFromVector can only be used for reporter types that are specializatons of "
               "std::vector.");
  }
}

transferToVector()

template<typename T >

void ReporterContext< T >::transferToVector ( ReporterData &  r_data, const ReporterName &  r_name, dof_id_type  index, unsigned int  time_index = 0  ) const

overridevirtualinherited

Perform type specific transfer to a vector.

NOTE: This is defined in ReporterData.h to avoid cyclic includes that would arise. I don't know of a better solution, if you have one please implement it.

Implements ReporterContextBase.

Definition at line 525 of file ReporterData.h.

{
  std::vector<T> & vec =
      const_cast<std::vector<T> &>(r_data.getReporterValue<std::vector<T>>(r_name, time_index));
 
  if (index >= vec.size())
    mooseError(
        "Requested index ", index, " is outside the bounds of the vector reporter value ", r_name);
  vec[index] = _state.value();
}

type()

template<typename T >

virtual std::string ReporterContext< T >::type ( ) const

inlineoverridevirtualinherited

Return the type being stored by the associated ReporterState object.

See also

ReporterContext::storeInfo

Implements ReporterContextBase.

Definition at line 263 of file ReporterContext.h.

{ return MooseUtils::prettyCppType<T>(); }

vectorSum()

template<typename T >

void ReporterGeneralContext< T >::vectorSum ( )

finalvirtualinherited

Helper for summing reporter value.

Implements ReporterContextBase.

Definition at line 512 of file ReporterContext.h.

{
  // 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.");
}

Member Data Documentation

_producer

const MooseObject& ReporterContextBase::_producer

protectedinherited

The MooseObject that is producing this Reporter.

Definition at line 214 of file ReporterContext.h.

Referenced by ReporterContextBase::getProducer().

_producer_enum

ReporterProducerEnum ReporterContextBase::_producer_enum

protectedinherited

Defines how the Reporter value can be produced and how it is being produced.

Definition at line 217 of file ReporterContext.h.

Referenced by ReporterContextBase::getProducerModeEnum(), ReporterContextBase::init(), ReporterBroadcastContext< T >::ReporterBroadcastContext(), ReporterBroadcastContext< T >::ReporterBroadcastContext(), ReporterContext< T >::ReporterContext(), ReporterGatherContext< T >::ReporterGatherContext(), ReporterGatherContext< T >::ReporterGatherContext(), ReporterScatterContext< T >::ReporterScatterContext(), ReporterScatterContext< T >::ReporterScatterContext(), and ReporterContextBase::requiresConsumerModes().

_state

template<typename T >

ReporterState<T>& ReporterContext< T >::_state

protectedinherited

The state on which this context object operates.

Definition at line 326 of file ReporterContext.h.

Referenced by ReporterContext< T >::broadcast(), ReporterContext< T >::name(), ReporterContext< T >::ReporterContext(), ReporterContext< T >::restoreState(), and ReporterContext< T >::state().

_values

template<typename T >

const std::vector<T>& ReporterScatterContext< T >::_values

private

The values to scatter.

Definition at line 640 of file ReporterContext.h.

---

The documentation for this class was generated from the following file:

• include/reporters/ReporterContext.h