SamplerReceiver Class Reference

A Control object for receiving data from a master application Sampler object. More...

#include <SamplerReceiver.h>

Inheritance diagram for SamplerReceiver:

Public Member Functions
	SamplerReceiver (const InputParameters &parameters)
virtual void	execute () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	transfer (const std::vector< std::string > &names, const std::vector< Real > &values)
	Update the parameter names and associated values. More...

Protected Attributes
std::vector< std::string >	_parameters
	Parameter names to modify. More...
std::vector< Real >	_values
	Values to use when modifying parameters. More...

Friends
class	SamplerParameterTransfer
	Allows the SamplerParameterTransfer to call the transfer method, which should only be called by that object so making it public is dangerous. More...

Detailed Description

A Control object for receiving data from a master application Sampler object.

Definition at line 25 of file SamplerReceiver.h.

Constructor & Destructor Documentation

SamplerReceiver()

SamplerReceiver::SamplerReceiver

(

const InputParameters &

parameters

)

Definition at line 28 of file SamplerReceiver.C.

: Control(parameters) {}

Member Function Documentation

execute()

void SamplerReceiver::execute ( )

overridevirtual

Definition at line 31 of file SamplerReceiver.C.

{
  std::size_t value_position = 0;
 
  // Loop through all the parameters and set the controllable values for each parameter.
  for (const std::string & param_name : _parameters)
  {
    ControllableParameter control_param = getControllableParameterByName(param_name);
 
    // Real
    if (control_param.check<Real>())
    {
      // There must be enough data to populate the controlled parameter
      if (value_position >= _values.size())
        mooseError("The supplied vector of Real values is not sized correctly, the "
                   "Real parameter '",
                   param_name,
                   " requires a value but no more values are available in "
                   "the supplied values which have a size of ",
                   _values.size(),
                   ".");
      control_param.set<Real>(_values[value_position++]);
    }
 
    else if (control_param.check<std::vector<Real>>())
    {
      std::vector<std::vector<Real>> values = control_param.get<std::vector<Real>>();
      mooseAssert(values.size() != 0,
                  "ControllableParameter must not be empty."); // should not be possible
      std::size_t n = values[0].size();                        // size of vector to changed
 
      // All vectors being controlled must be the same size
      for (const std::vector<Real> & value : values)
        if (value.size() != n)
          mooseError(
              "The std::vector<Real> parameters being controlled must all be the same size:\n",
              control_param.dump());
 
      // There must be enough data to populate the controlled parameter
      if (value_position + n > _values.size())
        mooseError("The supplied vector of Real values is not sized correctly, the "
                   "std::vector<Real> parameter '",
                   param_name,
                   " requires ",
                   n,
                   " values but only ",
                   _values.size() - value_position,
                   " are available in the supplied vector.");
 
      // Set the value
      std::vector<Real> value(_values.begin() + value_position,
                              _values.begin() + value_position + n);
      value_position += n;
      control_param.set<std::vector<Real>>(value);
    }
 
    else
 
      // If the loop gets here it failed to find what it was looking for
      mooseError("Unable to locate a Real or std::vector<Real> parameter with the name '",
                 param_name,
                 ".'");
  }
 
  // Error if there is un-used values
  if (value_position != _values.size())
    mooseError("The number of values supplied (",
               _values.size(),
               ") does not match the number of values consumed by setting parameter values (",
               value_position,
               ").");
}

transfer()

void SamplerReceiver::transfer ( const std::vector< std::string > &  names, const std::vector< Real > &  values  )

protected

Update the parameter names and associated values.

Definition at line 105 of file SamplerReceiver.C.

{
  _parameters = names;
  _values = values;
}

Referenced by SamplerParameterTransfer::executeToMultiapp().

validParams()

InputParameters SamplerReceiver::validParams ( )

static

Definition at line 19 of file SamplerReceiver.C.

{
  InputParameters params = Control::validParams();
  params.addClassDescription(
      "Control for receiving data from a Sampler via SamplerParameterTransfer.");
  params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_BEGIN;
  return params;
}

Friends And Related Function Documentation

SamplerParameterTransfer

friend class SamplerParameterTransfer

friend

Allows the SamplerParameterTransfer to call the transfer method, which should only be called by that object so making it public is dangerous.

Definition at line 47 of file SamplerReceiver.h.

Member Data Documentation

_parameters

std::vector<std::string> SamplerReceiver::_parameters

protected

Parameter names to modify.

Definition at line 40 of file SamplerReceiver.h.

Referenced by execute(), and transfer().

_values

std::vector<Real> SamplerReceiver::_values

protected

Values to use when modifying parameters.

Definition at line 43 of file SamplerReceiver.h.

Referenced by execute(), and transfer().

---

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

• stochastic_tools/include/controls/SamplerReceiver.h
• stochastic_tools/src/controls/SamplerReceiver.C