General context that is called by all Reporter values to manage the old values. More...

#include <ReporterContext.h>

Inheritance diagram for ReporterContext< T >:

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

Public Member Functions
	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 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	finalize () override
	Perform automatic parallel communication based on the producer/consumer modes.

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.

virtual void	declareClone (ReporterData &r_data, const ReporterName &r_name, const ReporterMode &mode, const MooseObject &producer) const =0
	Helper for declaring new reporter values based on this context.

virtual void	declareVectorClone (ReporterData &r_data, const ReporterName &r_name, const ReporterMode &mode, const MooseObject &producer) const =0
	Helper for declaring new vector reporter values based on this context.

virtual void	resize (dof_id_type local_size)=0
	Helper for resizing vector data.

virtual void	clear ()=0
	Helper for clearing vector data.

virtual void	vectorSum ()=0
	Helper for summing reporter value.

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 std::string	contextType () const override=0

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

Detailed Description

template<typename T>
class ReporterContext< T >

General context that is called by all Reporter values to manage the old values.

This is the default context object, the communication aspect includes inspecting the produced mode against the consumed mode to be sure that the data is compatible or if automatic communication can be done to make them compatible.

Definition at line 228 of file ReporterContext.h.

Member Enumeration Documentation

◆ AutoOperation

template<typename T >

enum class ReporterContext::AutoOperation

strong

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

◆ ReporterContext() [1/2]

template<typename T >

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

Definition at line 330 of file ReporterContext.h.

  : ReporterContextBase(other, producer), _state(state)
{
  _producer_enum.insert(REPORTER_MODE_ROOT, REPORTER_MODE_REPLICATED, REPORTER_MODE_DISTRIBUTED);
}

◆ ReporterContext() [2/2]

template<typename T >

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

Definition at line 339 of file ReporterContext.h.

  : ReporterContext(other, producer, state)
{
  _state.value() = default_value;
}

Member Function Documentation

◆ broadcast()

template<typename T >

void ReporterContext< T >::broadcast ( )

inlineprotected

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()

virtual void ReporterContextBase::clear ( )

pure virtualinherited

Helper for clearing vector data.

Implemented in ReporterGeneralContext< T >, and ReporterVectorContext< T >.

Referenced by ReporterTransferInterface::clearVectorReporter().

◆ contextType()

template<typename T >

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

overrideprotectedpure virtual

Returns: The derived context type for this context.

This must be overridden in every class.

Implements ReporterContextBase.

Implemented in ReporterGeneralContext< T >, ReporterBroadcastContext< T >, ReporterScatterContext< T >, ReporterGatherContext< T >, and ReporterVectorContext< T >.

◆ copyValuesBack()

template<typename T >

void ReporterContext< T >::copyValuesBack ( )

overrideprotectedvirtual

Called by FEProblemBase::advanceState via ReporterData.

Implements ReporterContextBase.

Reimplemented in VectorPostprocessorContext< T >.

Definition at line 412 of file ReporterContext.h.

{
  _state.copyValuesBack();
}

◆ declareClone()

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

pure virtualinherited

Helper for declaring new reporter values based on this context.

Parameters

r_data	The ReporterData on the app that this value is being declared
r_name	The name of the Reporter value being declared
mode	Reporter mode to declare with

See also: ReporterTransferInterface

Implemented in ReporterVectorContext< T >, and ReporterGeneralContext< T >.

Referenced by ReporterTransferInterface::declareClone().

◆ declareVectorClone()

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

pure virtualinherited

Helper for declaring new vector reporter values based on this context.

Parameters

r_data	The ReporterData on the app that this value is being declared
r_name	The name of the Reporter value being declared
mode	Reporter mode to declare with

See also: ReporterTransferInterface

Implemented in ReporterVectorContext< T >, and ReporterGeneralContext< T >.

Referenced by ReporterTransferInterface::declareVectorClone().

◆ finalize()

template<typename T >

void ReporterContext< T >::finalize ( )

overridevirtual

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

Implements ReporterContextBase.

Reimplemented in ReporterBroadcastContext< T >, ReporterScatterContext< T >, ReporterGatherContext< T >, and VectorPostprocessorContext< T >.

Definition at line 350 of file ReporterContext.h.

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

◆ getProducer()

const MooseObject & ReporterContextBase::getProducer ( ) const

inlineinherited

Return the MooseObject that produces this Reporter.

Definition at line 118 of file ReporterContext.h.

118{ return _producer; }

ReporterContextBase::_producer

const MooseObject & _producer

The MooseObject that is producing this Reporter.

Definition ReporterContext.h:214

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

inlinefinaloverridevirtual

Return the name of the Reporter value.

Implements ReporterContextBase.

Definition at line 251 of file ReporterContext.h.

251{ 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()

virtual void ReporterContextBase::resize ( dof_id_type local_size )

pure virtualinherited

Helper for resizing vector data.

Parameters

local_size Number of elements to resize vector to

Implemented in ReporterGeneralContext< T >, and ReporterVectorContext< T >.

Referenced by ReporterTransferInterface::resizeReporter().

◆ restoreState()

template<typename T >

virtual bool ReporterContext< T >::restoreState ( )

inlineoverrideprotectedvirtual

Restore state to its old values.

See also: ReporterState::restoreState

Implements ReporterContextBase.

Definition at line 323 of file ReporterContext.h.

323{ return _state.restoreState(); }

◆ state()

template<typename T >

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

inline

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

Definition at line 256 of file ReporterContext.h.

256{ return _state; }

◆ store()

template<typename T >

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

overrideprotectedvirtual

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

overrideprotectedvirtual

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

overridevirtual

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

overridevirtual

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

overridevirtual

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

inlineoverridevirtual

Return the type being stored by the associated ReporterState object.

See also: ReporterContext::storeInfo

Implements ReporterContextBase.

Definition at line 263 of file ReporterContext.h.

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

◆ vectorSum()

virtual void ReporterContextBase::vectorSum ( )

pure virtualinherited

Helper for summing reporter value.

Implemented in ReporterGeneralContext< T >, and ReporterVectorContext< T >.

Referenced by ReporterTransferInterface::sumVectorReporter().

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

protected

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().

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

include/reporters/ReporterContext.h
include/reporters/ReporterData.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ AutoOperation

Constructor & Destructor Documentation

◆ ReporterContext() [1/2]

◆ ReporterContext() [2/2]

Member Function Documentation

◆ broadcast()

◆ clear()

◆ contextType()

◆ copyValuesBack()

◆ declareClone()

◆ declareVectorClone()

◆ finalize()

◆ getProducer()

◆ getProducerModeEnum()

◆ init()

◆ name()

◆ requiresConsumerModes()

◆ resize()

◆ restoreState()

◆ state()

◆ store()

◆ storeInfo()

◆ transfer()

◆ transferFromVector()

◆ transferToVector()

◆ type()

◆ vectorSum()

Member Data Documentation

◆ _producer

◆ _producer_enum

◆ _state