Receiver

Reports the value stored in this processor, which is usually filled in by another object. The Receiver does not compute its own value.

Overview

The Receiver Postprocessor is useful for reporting scalar values created in other parts of the system such as in a MultiApp, and moved to the Receiver using a MultiAppPostprocessorTransfer for example. It does not compute its own value. Note that the user may set a default value with the "default" parameter.

Example Input File Syntax

In this example, the value of the Receiver 'pp' in the subapp 'quad' is being populated by the value of a variable 'parent_aux' in the main appplication.

'Snippet from the subapp showing the Receiver'

[Postprocessors]
  [./from_parent]
    type = Receiver
  [../]
[]
(../../../SoftwareDownloads/moose/test/tests/transfers/multiapp_variable_value_sample_transfer/pp_sub.i)

'Snippet from the main app, populating the Receiver with a transfer of the variable value at different points'

[Transfers]
  [./sample_pp_transfer]
    source_variable = u
    postprocessor = from_parent
    type = MultiAppVariableValueSamplePostprocessorTransfer
    to_multi_app = pp_sub
  [../]
[]
(../../../SoftwareDownloads/moose/test/tests/transfers/multiapp_variable_value_sample_transfer/pp_parent.i)

Input Parameters

  • default0The default value

    Default:0

    C++ Type:double

    Controllable:No

    Description:The default value

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, TRANSFER, ALWAYS

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.

  • initialize_oldTrueInitialize the old postprocessor value with the default value

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Initialize the old postprocessor value with the default value

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters