ReporterVectorContext< T > Class Template Reference

This context is specific for vector types of reporters, mainly for declaring a vector of the type from another context. More...

#include <ReporterContext.h>

Inheritance diagram for ReporterVectorContext< T >:

Public Types
enum	AutoOperation
	Options for automatic parallel operations to perform by the default context. More...

Public Member Functions
	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
	This simply throws an error to avoid infinite instantiations. More...
virtual void	declareVectorClone (ReporterData &r_data, const ReporterName &r_name, const ReporterMode &mode, const MooseObject &producer) const final
	This simply throws an error to avoid infinite instantiations. More...
virtual void	resize (dof_id_type local_size) override
	Since we know that the _state value is a vector type, we can resize it based on. More...
virtual void	clear () override
	Since we know that the _state value is a vector type, we can clear it. More...
virtual void	vectorSum () override
	Helper for summing reporter value. More...
virtual std::string	contextType () const override
const ReporterName &	name () const override final
	Return the name of the Reporter value. More...
const ReporterState< std::vector< T > > &	state () const
	Return a reference to the ReporterState object that is storing the Reporter value. More...
virtual std::string	type () const override
	Return the type being stored by the associated ReporterState object. More...
virtual void	finalize () override
	Perform automatic parallel communication based on the producer/consumer modes. More...
virtual void	transfer (ReporterData &r_data, const ReporterName &r_name, unsigned int time_index=0) const override
	Perform type specific transfer. More...
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. More...
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. More...
void	init (const ReporterMode &mode)
	Initialize the producer mode. More...
const MooseObject &	getProducer () const
	Return the MooseObject that produces this Reporter. More...
const ReporterProducerEnum &	getProducerModeEnum () const
	Return the Reporter value produced mode. More...
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. More...
virtual void	store (nlohmann::json &json) const override
	Output data to JSON, see JSONOutput. More...
virtual void	copyValuesBack () override
	Called by FEProblemBase::advanceState via ReporterData. More...
virtual bool	restoreState () override
	Restore state to its old values. More...
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. More...

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

Detailed Description

template<typename T>
class ReporterVectorContext< T >

This context is specific for vector types of reporters, mainly for declaring a vector of the type from another context.

As well as resizing the vector of data.

See also

ReporterGeneralContext::declareVectorClone and ReporterTransferInterface

Definition at line 731 of file ReporterContext.h.

Member Enumeration Documentation

AutoOperation

enum ReporterContext::AutoOperation

stronginherited

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

Definition at line 234 of file ReporterContext.h.

  {
    NONE,
    BROADCAST
  };

Constructor & Destructor Documentation

ReporterVectorContext() [1/2]

template<typename T >

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

Definition at line 824 of file ReporterContext.h.

  : ReporterContext<std::vector<T>>(other, producer, state)
{
}

ReporterVectorContext() [2/2]

template<typename T >

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

Definition at line 832 of file ReporterContext.h.

  : ReporterContext<std::vector<T>>(other, producer, state, default_value)
{
}

Member Function Documentation

broadcast()

void ReporterContext< std::vector< 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 >

virtual void ReporterVectorContext< T >::clear ( )

inlineoverridevirtual

Since we know that the _state value is a vector type, we can clear it.

Implements ReporterContextBase.

Definition at line 769 of file ReporterContext.h.

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

contextType()

template<typename T >

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

inlineoverridevirtual

Returns

The derived context type for this context.

This must be overridden in every class.

Implements ReporterContext< std::vector< T > >.

Definition at line 820 of file ReporterContext.h.

{ return MooseUtils::prettyCppType(this); }

copyValuesBack()

void ReporterContext< std::vector< T > >::copyValuesBack ( )

overrideprotectedvirtualinherited

Called by FEProblemBase::advanceState via ReporterData.

Implements ReporterContextBase.

Definition at line 408 of file ReporterContext.h.

{
  _state.copyValuesBack();
}

declareClone()

template<typename T >

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

finalvirtual

This simply throws an error to avoid infinite instantiations.

It is defined in ReporterData.h to avoid cyclic included.

Implements ReporterContextBase.

Definition at line 581 of file ReporterData.h.

{
  mooseError("Cannot create clone with ReporterVectorContext.");
}

declareVectorClone()

template<typename T >

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

finalvirtual

This simply throws an error to avoid infinite instantiations.

It is defined in ReporterData.h to avoid cyclic included.

Implements ReporterContextBase.

Definition at line 592 of file ReporterData.h.

{
  mooseError("Cannot create clone with ReporterVectorContext.");
}

finalize()

void ReporterContext< std::vector< T > >::finalize ( )

overridevirtualinherited

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

Implements ReporterContextBase.

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 (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 ((producer == REPORTER_MODE_ROOT && consumer == REPORTER_MODE_DISTRIBUTED) ||
             (producer == REPORTER_MODE_REPLICATED && consumer == REPORTER_MODE_DISTRIBUTED) ||
             (producer == REPORTER_MODE_DISTRIBUTED && consumer == REPORTER_MODE_ROOT) ||
             (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.

Referenced by ReporterData::getReporterInfo().

{ return _producer; }

getProducerModeEnum()

const ReporterProducerEnum & ReporterContextBase::getProducerModeEnum ( ) const

inherited

Return the Reporter value produced mode.

Definition at line 28 of file ReporterContext.C.

Referenced by ReporterData::getReporterMode().

{
  return _producer_enum;
}

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

const ReporterName& ReporterContext< std::vector< 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 >

virtual void ReporterVectorContext< T >::resize ( dof_id_type  local_size )

inlineoverridevirtual

Since we know that the _state value is a vector type, we can resize it based on.

Parameters

local_size

Implements ReporterContextBase.

Definition at line 764 of file ReporterContext.h.

{ this->_state.value().resize(local_size); }

restoreState()

virtual bool ReporterContext< std::vector< 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()

const ReporterState<std::vector< T > >& ReporterContext< std::vector< 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()

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

overrideprotectedvirtualinherited

Output data to JSON, see JSONOutput.

Implements ReporterContextBase.

Definition at line 422 of file ReporterContext.h.

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

storeInfo()

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

overrideprotectedvirtualinherited

Output meta data to JSON, see JSONOutput.

Implements ReporterContextBase.

Definition at line 415 of file ReporterContext.h.

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

transfer()

void ReporterContext< std::vector< 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 502 of file ReporterData.h.

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

transferFromVector()

void ReporterContext< std::vector< 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 529 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()

void ReporterContext< std::vector< 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 512 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()

virtual std::string ReporterContext< std::vector< 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 >

virtual void ReporterVectorContext< T >::vectorSum ( )

inlineoverridevirtual

Helper for summing reporter value.

Implements ReporterContextBase.

Definition at line 771 of file ReporterContext.h.

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

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(), ReporterContext< std::vector< T > >::ReporterContext(), ReporterGatherContext< T >::ReporterGatherContext(), ReporterScatterContext< T >::ReporterScatterContext(), and ReporterContextBase::requiresConsumerModes().

_state

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

protectedinherited

The state on which this context object operates.

Definition at line 326 of file ReporterContext.h.

Referenced by ReporterVectorContext< T >::clear(), ReporterVectorContext< T >::resize(), and ReporterVectorContext< T >::vectorSum().

---

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

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