ParsedScalarReporter

Applies parsed functions to scalar entries held in reporters.

Overview

ParsedScalarReporter operates on scalars contained from a series of scalar reporters using a parsed function expression as shown in Listing 1. This reporter allows several scalar reporters to be combined into a single scalar. Variables in the parsed function expression are given by the "scalar_reporter_symbols". There is one "scalar_reporter_names" for each "scalar_reporter_symbols". This is a scalar version of the ParsedVectorReporter reporter.

Listing 1: 

[Mesh<<<{"href": "../../syntax/Mesh/index.html"}>>>]
  [gmg]
    type = GeneratedMeshGenerator<<<{"description": "Create a line, square, or cube mesh with uniformly spaced or biased elements.", "href": "../meshgenerators/GeneratedMeshGenerator.html"}>>>
    dim<<<{"description": "The dimension of the mesh to be generated"}>>> = 1
  []
[]

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  solve = false
[]

[Executioner<<<{"href": "../../syntax/Executioner/index.html"}>>>]
  type = Steady
[]

[Reporters<<<{"href": "../../syntax/Reporters/index.html"}>>>]
  [dataFromVofV]
    type = VectorOfVectorTestReporter
    name = v_of_v
    vector_of_vectors = '101 201; 102 202; 103 203'
    outputs = none
  []
  [vecvec_sum]
    type = ParsedVectorVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a rows of a vector of vector and reduce it to a vector.", "href": "ParsedVectorVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = sum
    vector_of_vector_reporter_name<<<{"description": "Reporter name with vector of vectors to reduce."}>>> = 'dataFromVofV/v_of_v'
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = 0
    expression<<<{"description": "function expression"}>>> = 'reduction_value+indexed_value'
  []
  [vecvec_sqsum]
    type = ParsedVectorVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a rows of a vector of vector and reduce it to a vector.", "href": "ParsedVectorVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = sqsum
    vector_of_vector_reporter_name<<<{"description": "Reporter name with vector of vectors to reduce."}>>> = 'dataFromVofV/v_of_v'
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = 0
    expression<<<{"description": "function expression"}>>> = 'reduction_value+indexed_value*indexed_value'
  []
  [vecvec_multiply]
    type = ParsedVectorVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a rows of a vector of vector and reduce it to a vector.", "href": "ParsedVectorVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = multiply
    vector_of_vector_reporter_name<<<{"description": "Reporter name with vector of vectors to reduce."}>>> = 'dataFromVofV/v_of_v'
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = 1
    expression<<<{"description": "function expression"}>>> = 'reduction_value*indexed_value'
  []
  [vecvec_max]
    type = ParsedVectorVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a rows of a vector of vector and reduce it to a vector.", "href": "ParsedVectorVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = max
    vector_of_vector_reporter_name<<<{"description": "Reporter name with vector of vectors to reduce."}>>> = 'dataFromVofV/v_of_v'
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = -100000
    expression<<<{"description": "function expression"}>>> = 'max(reduction_value,indexed_value)'
  []

  [vecs]
    type = ConstantReporter<<<{"description": "Reporter with constant values to be accessed by other objects, can be modified using transfers.", "href": "ConstantReporter.html"}>>>
    real_vector_names<<<{"description": "Names for each vector of reals value."}>>> = 'vec_a vec_b vec_c vec_d'
    real_vector_values<<<{"description": "Values for vectors of reals."}>>> = '1 2 3; 10 20 30; 100 10 1; 1 2 3 4'
    real_names<<<{"description": "Names for each real value."}>>> = 'a b c'
    real_values<<<{"description": "Values for reals."}>>> = '1 10 100'
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = none
  []
  [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"}>>> = 'a b c'
    scalar_reporter_names<<<{"description": "Scalar reporter names to apply function to."}>>> = 'scalar_pp/value'
    scalar_reporter_symbols<<<{"description": "Expression symbol for each scalar reporter, i.e. postprocessors"}>>> = 'scalar_pp'
    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"}>>> = '(a+b)*c+constant1+constant2+scalar_pp'
  []
  [scalarOperation]
    type = ParsedScalarReporter<<<{"description": "Applies parsed functions to scalar entries held in reporters.", "href": "ParsedScalarReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = inner
    scalar_reporter_names<<<{"description": "Scalar reporter names to apply function to."}>>> = 'vecs/a vecs/b vecs/c'
    scalar_reporter_symbols<<<{"description": "Expression symbol for each scalar reporter, i.e. postprocessors"}>>> = 'a b c'
    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"}>>> = '(a+b)*c+constant1+constant2'
  []

  [vec_d]
    type = ConstantReporter<<<{"description": "Reporter with constant values to be accessed by other objects, can be modified using transfers.", "href": "ConstantReporter.html"}>>>
    real_vector_names<<<{"description": "Names for each vector of reals value."}>>> = 'vec_d'
    real_vector_values<<<{"description": "Values for vectors of reals."}>>> = '1 2 3 4'
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = none
  []
  [vector_sum]
    type = ParsedVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a vector and reduce it to a scalar.", "href": "ParsedVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = sum
    vector_reporter_name<<<{"description": "Reporter name with vector to reduce."}>>> = vec_d/vec_d
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = 0
    expression<<<{"description": "function expression"}>>> = 'reduction_value+indexed_value'
  []
  [vector_sqsum]
    type = ParsedVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a vector and reduce it to a scalar.", "href": "ParsedVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = sqsum
    vector_reporter_name<<<{"description": "Reporter name with vector to reduce."}>>> = vec_d/vec_d
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = 0
    expression<<<{"description": "function expression"}>>> = 'reduction_value+indexed_value*indexed_value'
  []
  [vector_multiply]
    type = ParsedVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a vector and reduce it to a scalar.", "href": "ParsedVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = multiply
    vector_reporter_name<<<{"description": "Reporter name with vector to reduce."}>>> = vec_d/vec_d
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = 1
    expression<<<{"description": "function expression"}>>> = 'reduction_value*indexed_value'
  []
  [vector_max]
    type = ParsedVectorRealReductionReporter<<<{"description": "Use a parsed function to iterate through a vector and reduce it to a scalar.", "href": "ParsedVectorRealReductionReporter.html"}>>>
    name<<<{"description": "Name of output reporter."}>>> = max
    vector_reporter_name<<<{"description": "Reporter name with vector to reduce."}>>> = vec_d/vec_d
    initial_reduction_value<<<{"description": "Value to intialize the reduction with."}>>> = -100000
    expression<<<{"description": "function expression"}>>> = 'max(reduction_value,indexed_value)'
  []
[]

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [scalar_pp]
    type = ConstantPostprocessor<<<{"description": "Postprocessor that holds a constant value", "href": "../postprocessors/ConstantPostprocessor.html"}>>>
    value<<<{"description": "The value"}>>> = 5
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = none
  []
[]

[Outputs<<<{"href": "../../syntax/Outputs/index.html"}>>>]
  csv<<<{"description": "Output the scalar variable and postprocessors to a *.csv file using the default CSV output."}>>> = true
[]
(../moose/test/tests/reporters/parsed_reporters/vectorMath.i)

Optimization use case

This reporter was created to compute the objective function from the misfit reporter vector created by OptimizationData. The scalar reporter created can then be transferred as the objective value into GeneralOptimization.

Input Parameters

  • expressionfunction expression

    C++ Type:FunctionExpression

    Unit:(no unit assumed)

    Controllable:No

    Description:function expression

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.

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