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.

note:Reporter names

The reporter names created by the ConstantReporter match the names passed in each of the _names parameters.

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'
  
    dof_id_type_names = 'dofid_1 dofid_2 dofid_3'
    dof_id_type_values = '1     2     3'
  
    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'
  
    dof_id_type_vector_names = 'dofid_vec'
    dof_id_type_vector_values = '7 3'
  []
[]

Input Parameters

dof_id_type_namesNames for each dof_id_type value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each dof_id_type value.
dof_id_type_valuesValues for dof_id_types.
C++ Type:std::vector<unsigned long>
Controllable:No
Description:Values for dof_id_types.
dof_id_type_vector_namesNames for each vector of dof_id_types value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each vector of dof_id_types value.
dof_id_type_vector_valuesValues for vectors of dof_id_types.
C++ Type:std::vector<std::vector<unsigned long>>
Controllable:No
Description:Values for vectors of dof_id_types.
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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, 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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
integer_namesNames for each integer value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each integer value.
integer_valuesValues for integers.
C++ Type:std::vector<int>
Controllable:No
Description:Values for integers.
integer_vector_namesNames for each vector of integers value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each vector of integers value.
integer_vector_valuesValues for vectors of integers.
C++ Type:std::vector<std::vector<int>>
Controllable:No
Description:Values for vectors of integers.
point_namesNames for each point value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each point value.
point_valuesValues for points.
C++ Type:std::vector<libMesh::Point>
Controllable:No
Description:Values for points.
point_vector_namesNames for each vector of points value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each vector of points value.
point_vector_valuesValues for vectors of points.
C++ Type:std::vector<std::vector<libMesh::Point>>
Controllable:No
Description:Values for vectors of points.
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.
real_namesNames for each real value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each real value.
real_valuesValues for reals.
C++ Type:std::vector<double>
Controllable:No
Description:Values for reals.
real_vector_namesNames for each vector of reals value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each vector of reals value.
real_vector_valuesValues for vectors of reals.
C++ Type:std::vector<std::vector<double>>
Controllable:No
Description:Values for vectors of reals.
string_namesNames for each string value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each string value.
string_valuesValues for strings.
C++ Type:std::vector<std::string>
Controllable:No
Description:Values for strings.
string_vector_namesNames for each vector of strings value.
C++ Type:std::vector<ReporterValueName>
Controllable:No
Description:Names for each vector of strings value.
string_vector_valuesValues for vectors of strings.
C++ Type:std::vector<std::vector<std::string>>
Controllable:No
Description:Values for vectors of strings.

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.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
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 where 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 where 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

(../moose/test/tests/reporters/constant_reporter/constant_reporter.i)

[Mesh/mesh]
  type = GeneratedMeshGenerator
  dim = 1
[]

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Reporters]
  active = constant
  [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'

    dof_id_type_names  = 'dofid_1 dofid_2 dofid_3'
    dof_id_type_values = '1     2     3'

    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'

    dof_id_type_vector_names  = 'dofid_vec'
    dof_id_type_vector_values = '7 3'
  []
  [error]
    type = ConstantReporter
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  execute_on = 'timestep_end'
  [out]
    type = JSON
  []
[]