ConstantVectorPostprocessor

Populate constant VectorPostprocessorValue directly from input file.

The constant data is specified with a vector names, and a vector of vectors of values for each name. The vectors of values are separated by semicolons.

A constant vector postprocessor is not generally used for output or postprocessing, but more to isolate part of the system using constant inputs. For example, if a subapp communicates with the main app by transferring a vector postprocessor, a ConstantVectorPostprocessor may be used to replace that transfer for debugging or parametric study purposes.

Example input syntax

In this example, two ConstantVectorPostprocessor are used to specify three vectors a b c. They are tied to each vector postprocessor, so the two do not conflict despite their similar name.

[VectorPostprocessors]
  [from_main_vpp]
    type = ConstantVectorPostprocessor
    vector_names = 'a b c'
    value = '1 1 1; 2 2 2; 3 3 3'
    execute_on = initial
    #outputs = none
  []
  [to_main_vpp]
    type = ConstantVectorPostprocessor
    vector_names = 'a b c'
    value = '4 4 4; 5 5 5; 6 6 6'
    #outputs = none
  []
[]

Input Parameters

valueVector values this object will have. Leading dimension must be equal to leading dimension of vector_names parameter.
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:Vector values this object will have. Leading dimension must be equal to leading dimension of vector_names parameter.

Required Parameters

contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
Default:REPLICATED
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:DISTRIBUTED, REPLICATED
Controllable:No
Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
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
Unit:(no unit assumed)
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.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
vector_namesvalue Names of the column vectors in this object
Default:value
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Names of the column vectors in this object

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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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/transfers/multiapp_reporter_transfer/main.i)

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[VectorPostprocessors]
  [from_main_vpp]
    type = ConstantVectorPostprocessor
    vector_names = 'a b c'
    value = '1 1 1; 2 2 2; 3 3 3'
    execute_on = initial
    #outputs = none
  []
  [to_main_vpp]
    type = ConstantVectorPostprocessor
    vector_names = 'a b c'
    value = '4 4 4; 5 5 5; 6 6 6'
    #outputs = none
  []
[]

[Reporters]
  [from_main_rep]
    type = ConstantReporter
    integer_names = int
    integer_values = 1
    real_names = num
    real_values = 2.0
    real_vector_names = vec
    real_vector_values = '3 4'
    string_names = str
    string_values = 'five'
  []
  [to_main_rep]
    type = ConstantReporter
    integer_names = int
    integer_values = 0
    real_names = num
    real_values = 0.0
    real_vector_names = vec
    real_vector_values = '0'
    string_names = str
    string_values = 'foo'
  []
[]

[MultiApps/sub]
  type = TransientMultiApp
  input_files = 'sub0.i sub1.i'
  positions = '0 0 0 0 0 0'
[]

[Transfers]
  # VPP transfers
  [vpp_to_vpp]
    type = MultiAppReporterTransfer
    to_reporters = 'to_sub_vpp/a to_sub_vpp/b'
    from_reporters = 'from_main_vpp/a from_main_vpp/b'
    to_multi_app = sub
  []
  [vpp_from_vpp]
    type = MultiAppReporterTransfer
    to_reporters = 'to_main_vpp/a to_main_vpp/b'
    from_reporters = 'from_sub_vpp/a from_sub_vpp/b'
    from_multi_app = sub
    subapp_index = 0
  []

  # Vector-VPP transfers
  [vector_to_vpp]
    type = MultiAppReporterTransfer
    to_reporters = 'to_sub_vpp/a'
    from_reporters = 'from_main_rep/vec'
    to_multi_app = sub
    subapp_index = 0
  []
  [vector_from_vpp]
    type = MultiAppReporterTransfer
    to_reporters = 'to_main_rep/vec'
    from_reporters = 'from_sub_vpp/a'
    from_multi_app = sub
    subapp_index = 0
  []

  # Real-PP transfers
  [real_to_pp]
    type = MultiAppReporterTransfer
    to_reporters = 'to_sub_pp/value'
    from_reporters = 'from_main_rep/num'
    to_multi_app = sub
    subapp_index = 0
  []
  [real_from_pp]
    type = MultiAppReporterTransfer
    to_reporters = 'to_main_rep/num'
    from_reporters = 'from_sub_pp/value'
    from_multi_app = sub
    subapp_index = 0
  []

  # Int-Int transfers
  [int_to_int]
    type = MultiAppReporterTransfer
    to_reporters = 'to_sub_rep/int'
    from_reporters = 'from_main_rep/int'
    to_multi_app = sub
    subapp_index = 0
  []
  [int_from_int]
    type = MultiAppReporterTransfer
    to_reporters = 'to_main_rep/int'
    from_reporters = 'from_sub_rep/int'
    from_multi_app = sub
    subapp_index = 0
  []

  # String-String transfers
  [string_to_string]
    type = MultiAppReporterTransfer
    to_reporters = 'to_sub_rep/str'
    from_reporters = 'from_main_rep/str'
    to_multi_app = sub
    subapp_index = 0
  []
  [string_from_string]
    type = MultiAppReporterTransfer
    to_reporters = 'to_main_rep/str'
    from_reporters = 'from_sub_rep/str'
    from_multi_app = sub
    subapp_index = 0
  []
[]

[Executioner]
  type = Transient
  num_steps = 1
[]

[Outputs]
  [out]
    type = JSON
    vectorpostprocessors_as_reporters = true
  []
  execute_on = timestep_end
[]

Example input syntax
Input Parameters