ParsedVectorReporter

Apply parsed functions to vector entries held in reporters.

Overview

ParsedVectorReporter operates on the elements contained in series of vector reporters using a parsed function expression as shown in Listing 1. This reporter allows several vector reporters to be combined into a single vector. This reporter operates on multiple vectors of the same size and returns a vector of that size. There must be one "vector_reporter_names" for each "vector_reporter_symbols". This reporter can also use postprocessor values in the parsed function using "scalar_reporter_names" and "scalar_reporter_symbols". As shown in Listing 1, this allows the timestep size given by TimestepSize to be included in the parsed function. This is a vector version of the ParsedScalarReporter reporter.

Listing 1:

[Reporters<<<{"href": "../../syntax/Reporters/index.html"}>>>]
  [vectorOperation]
    type = ParsedVectorReporter<<<{"description": "Apply parsed functions to vector entries held in reporters.", "href": "ParsedVectorReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = inner
    vector_reporter_names<<<{"description": "Reporter names to apply function to."}>>> = 'vecs/vec_a vecs/vec_b vecs/vec_c'
    vector_reporter_symbols<<<{"description": "Expression symbol for each reporter"}>>> = 'vec_a vec_b vec_c'
    scalar_reporter_names<<<{"description": "Scalar reporter names to apply function to."}>>> = 'vecs/a dt/value'
    scalar_reporter_symbols<<<{"description": "Expression symbol for each scalar reporter, i.e. postprocessors"}>>> = 'a dt'
    constant_names<<<{"description": "Vector of constants used in the parsed function (use this for kB etc.)"}>>> = 'constant1 constant2'
    constant_expressions<<<{"description": "Vector of values for the constants in constant_names (can be an FParser expression)"}>>> = '10 20'
    expression<<<{"description": "function expression"}>>> = 'vec_a+vec_b+vec_c+constant1+constant2+a+dt'
  []
[]

Input Parameters

expressionfunction expression
C++ Type:FunctionExpression
Unit:(no unit assumed)
Controllable:No
Description:function expression
vector_reporter_namesReporter names to apply function to.
C++ Type:std::vector<ReporterName>
Controllable:No
Description:Reporter names to apply function to.

Required Parameters

constant_expressionsVector of values for the constants in constant_names (can be an FParser expression)
C++ Type:std::vector<std::string>
Controllable:No
Description:Vector of values for the constants in constant_names (can be an FParser expression)
constant_namesVector of constants used in the parsed function (use this for kB etc.)
C++ Type:std::vector<std::string>
Controllable:No
Description:Vector of constants used in the parsed function (use this for kB etc.)
epsilon0Fuzzy comparison tolerance
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Fuzzy comparison tolerance
nameresultName of output reporter.
Default:result
C++ Type:std::string
Controllable:No
Description:Name of output reporter.
scalar_reporter_namesScalar reporter names to apply function to.
C++ Type:std::vector<ReporterName>
Controllable:No
Description:Scalar reporter names to apply function to.
scalar_reporter_symbolsExpression symbol for each scalar reporter, i.e. postprocessors
C++ Type:std::vector<std::string>
Controllable:No
Description:Expression symbol for each scalar reporter, i.e. postprocessors
use_tFalseMake time (t) variables available in the function expression.
Default:False
C++ Type:bool
Controllable:No
Description:Make time (t) variables available in the function expression.
vector_reporter_symbolsExpression symbol for each reporter
C++ Type:std::vector<std::string>
Controllable:No
Description:Expression symbol for each reporter

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).
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
Options:XFEM_MARK, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, TRANSFER
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.
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

Execution Scheduling Parameters

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.
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

disable_fpoptimizerFalseDisable the function parser algebraic optimizer
Default:False
C++ Type:bool
Controllable:No
Description:Disable the function parser algebraic optimizer
enable_ad_cacheTrueEnable caching of function derivatives for faster startup time
Default:True
C++ Type:bool
Controllable:No
Description:Enable caching of function derivatives for faster startup time
enable_auto_optimizeTrueEnable automatic immediate optimization of derivatives
Default:True
C++ Type:bool
Controllable:No
Description:Enable automatic immediate optimization of derivatives
enable_jitTrueEnable just-in-time compilation of function expressions for faster evaluation
Default:True
C++ Type:bool
Controllable:No
Description:Enable just-in-time compilation of function expressions for faster evaluation
evalerror_behaviornanWhat to do if evaluation error occurs. Options are to pass a nan, pass a nan with a warning, throw a error, or throw an exception
Default:nan
C++ Type:MooseEnum
Options:nan, nan_warning, error, exception
Controllable:No
Description:What to do if evaluation error occurs. Options are to pass a nan, pass a nan with a warning, throw a error, or throw an exception

Parsed Expression Advanced Parameters

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
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.

Material Property Retrieval Parameters

(../moose/test/tests/reporters/parsed_reporters/transientParsedVec.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 1
  []
[]

[Problem]
  solve = false
[]
[Functions]
  [dts]
    type = ParsedFunction
    expression = t^2
  []
[]

[Executioner]
  type = Transient
  num_steps = 3
  dt = 1
  [TimeStepper]
    type = FunctionDT
    function = dts
    min_dt = 1
  []
[]

[Reporters]
  [vecs]
    type = ConstantReporter
    real_vector_names = 'vec_a vec_b vec_c vec_d'
    real_vector_values = '1 2 3; 10 20 30; 100 10 1; 1 2 3 4'
    real_names = 'a b c'
    real_values = '1 10 100'
    outputs = none
  []
  [vectorOperation]
    type = ParsedVectorReporter
    name = inner
    vector_reporter_names = 'vecs/vec_a vecs/vec_b vecs/vec_c'
    vector_reporter_symbols = 'vec_a vec_b vec_c'
    scalar_reporter_names = 'vecs/a dt/value'
    scalar_reporter_symbols = 'a dt'
    constant_names = 'constant1 constant2'
    constant_expressions = '10 20'
    expression = 'vec_a+vec_b+vec_c+constant1+constant2+a+dt'
  []
  [transientScalar]
    type = ParsedScalarReporter
    name = inner
    scalar_reporter_names = 'vecs/c dt/value'
    scalar_reporter_symbols = 'c dt'
    expression = 'c+t+dt'
    use_t = true
  []
[]

[Postprocessors]
  [dt]
    type = TimestepSize
  []
[]

[Outputs]
  csv = true
[]

Overview
Input Parameters