- 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.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
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.
- integer_namesNames for each integer value.
C++ Type:std::vector<ReporterValueName>
Description:Names for each integer value.
- integer_valuesValues for integers.
C++ Type:std::vector<int>
Description:Values for integers.
- integer_vector_namesNames for each vector of integers value.
C++ Type:std::vector<ReporterValueName>
Description:Names for each vector of integers value.
- integer_vector_valuesValues for vectors of integers.
C++ Type:std::vector<std::vector<int>>
Description:Values for vectors of integers.
- 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
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.
- real_namesNames for each real value.
C++ Type:std::vector<ReporterValueName>
Description:Names for each real value.
- real_valuesValues for reals.
C++ Type:std::vector<double>
Description:Values for reals.
- real_vector_namesNames for each vector of reals value.
C++ Type:std::vector<ReporterValueName>
Description:Names for each vector of reals value.
- real_vector_valuesValues for vectors of reals.
C++ Type:std::vector<std::vector<double>>
Description:Values for vectors of reals.
- string_namesNames for each string value.
C++ Type:std::vector<ReporterValueName>
Description:Names for each string value.
- string_valuesValues for strings.
C++ Type:std::vector<std::string>
Description:Values for strings.
- string_vector_namesNames for each vector of strings value.
C++ Type:std::vector<ReporterValueName>
Description:Names for each vector of strings value.
- string_vector_valuesValues for vectors of strings.
C++ Type:std::vector<std::vector<std::string>>
Description:Values for vectors of strings.
ConstantReporter
Reporter with constant values to be accessed by other objects, can be modified using transfers.
Overview
ConstantReporter gives the ability to produce integer, real number, and string reporter data along with vectors of each type. The user must specify the following parameters for each type:
int
: "integer_names" and "integer_values"Real
: "real_names" and "real_values"std::string
: "string_names" and "string_values"std::vector<int>
: "integer_vector_names" and "integer_vector_values"std::vector<Real>
: "real_vector_names" and "real_vector_values"std::vector<std::string>
: "string_vector_names" and "string_vector_values"
The user may specify more than one value of the same type, which will create multiple reporter values of that type.
Example Input File Syntax
[Reporters]
[constant]
type = ConstantReporter
integer_names = 'int_1 int_2 int_3'
integer_values = '1 2 -3'
real_names = 'num_1 num_2'
real_values = '4.0 5.0'
string_names = 'str'
string_values = 'six'
integer_vector_names = 'int_vec'
integer_vector_values = '7 8'
real_vector_names = 'vec_1 vec_2'
real_vector_values = '8.0 80.0 800.0; 9.0 90.0'
string_vector_names = 'str_vec'
string_vector_values = 'ten eleven twelve thirteen'
[]
[]
(test/tests/reporters/constant_reporter/constant_reporter.i)Input 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
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>
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
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
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>
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
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
Input Files
- (test/tests/transfers/reporter_transfer/sub0.i)
- (test/tests/dirackernels/reporter_point_source/2d_vpp.i)
- (test/tests/reporters/constant_reporter/constant_reporter.i)
- (modules/stochastic_tools/test/tests/transfers/sampler_reporter/sub.i)
- (modules/stochastic_tools/test/tests/reporters/statistics/constant_sub.i)
- (modules/stochastic_tools/test/tests/reporters/basic/statistics_reporter_error.i)
- (modules/stochastic_tools/test/tests/reporters/basic/statistics_reporter_ci.i)
- (test/tests/transfers/reporter_transfer/clone.i)
- (modules/stochastic_tools/test/tests/reporters/basic/statistics_reporter.i)
- (test/tests/outputs/json/one_file_per_timestep/json.i)
- (modules/stochastic_tools/test/tests/reporters/stochastic_reporter/sub.i)
- (test/tests/outputs/reporters/reporter.i)
- (test/tests/transfers/reporter_transfer/main.i)
- (test/tests/reporters/accumulated_reporter/accumulate_reporter.i)
- (test/tests/actions/debug_show_reporters/debug_show_reporters.i)
- (test/tests/outputs/hide_via_reporters_block/reporter.i)
- (test/tests/transfers/reporter_transfer/clone_type.i)