DirectPerturbationReporter

Compute local sensitivities using the direct perturbation method.

Overview

This reporter is designed to compute direct perturbation-based sensitivity coefficients using samples obtained by DirectPerturbationSampler. The available methods and settings are discussed in DirectPerturbationSampler in detail.

Example Input Syntax

The following example computes the local sensitivity coefficients of three linear functions that can be described as:

f1(μ1,μ2,μ2)=μ1+2μ2+3μ3 f_1(\mu_1,\mu_2,\mu_2)=\mu_1+2\mu_2+3\mu_3

f2(μ1,μ2,μ2)=4μ1+5μ2+6μ3 f_2(\mu_1,\mu_2,\mu_2)=4\mu_1+5\mu_2+6\mu_3

f3(μ1,μ2,μ2)=7μ1+8μ2+9μ3 f_3(\mu_1,\mu_2,\mu_2)=7\mu_1+8\mu_2+9\mu_3

[Samplers]
  [directperturbation]
    type = DirectPerturbationSampler
    nominal_parameter_values = '0.1 0.2 0.3'
    relative_perturbation_intervals = '0.1 0.2 0.3'
    perturbation_method = central_difference
    execute_on = PRE_MULTIAPP_SETUP
  []
[]
(contrib/moose/modules/stochastic_tools/test/tests/reporters/directperturbation/dp_main.i)
[Reporters]
  [storage]
    type = StochasticReporter
    outputs = NONE
  []
  [sensitivities]
    type = DirectPerturbationReporter
    reporters = 'storage/data:const:f1 storage/data:const:f2 storage/data:const:f3 storage/data:const:f_combined'
    execute_on = FINAL
    sampler = directperturbation
  []
[]
(contrib/moose/modules/stochastic_tools/test/tests/reporters/directperturbation/dp_main.i)

The resulting output is a json file with the sensitivity coefficients:

{
    "reporters": {
        "sensitivities": {
            "type": "DirectPerturbationReporter",
            "values": {
                "storage_data:const:f1": {
                    "type": "DirectPerturbationSensitivity<double>"
                },
                "storage_data:const:f2": {
                    "type": "DirectPerturbationSensitivity<double>"
                },
                "storage_data:const:f3": {
                    "type": "DirectPerturbationSensitivity<double>"
                },
                "storage_data:const:f_combined": {
                    "type": "DirectPerturbationSensitivity<std::vector<double>>"
                }
            }
        }
    },
    "time_steps": [
        {
            "sensitivities": {
                "storage_data:const:f1": [
                    0.9999999999999716,
                    2.0,
                    2.9999999999999964
                ],
                "storage_data:const:f2": [
                    4.0,
                    5.000000000000014,
                    6.0
                ],
                "storage_data:const:f3": [
                    7.000000000000057,
                    8.0,
                    8.999999999999986
                ],
                "storage_data:const:f_combined": [
                    [
                        0.9999999999999716,
                        4.0,
                        7.000000000000057
                    ],
                    [
                        2.0,
                        5.000000000000014,
                        8.0
                    ],
                    [
                        2.9999999999999964,
                        6.0,
                        8.999999999999986
                    ]
                ]
            },
            "time": 2.0,
            "time_step": 2
        }
    ]
}
(contrib/moose/modules/stochastic_tools/test/tests/reporters/directperturbation/gold/dp_main_out.json)

We see that the method recovers the expansion coefficients of the fif_i functions exactly.

Input Parameters

  • samplerDirect Perturbation sampler used to generate samples.

    C++ Type:SamplerName

    Unit:(no unit assumed)

    Controllable:No

    Description:Direct Perturbation sampler used to generate samples.

Required Parameters

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

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

  • relative_sensitivityFalseIf the reporter should return relative or absolute sensitivities.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:If the reporter should return relative or absolute sensitivities.

  • reportersList of Reporter values to utilize for sensitivity computations.

    C++ Type:std::vector<ReporterName>

    Unit:(no unit assumed)

    Controllable:No

    Description:List of Reporter values to utilize for sensitivity computations.

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

  • vectorpostprocessorsList of VectorPostprocessor(s) to utilize for sensitivity computations.

    C++ Type:std::vector<VectorPostprocessorName>

    Unit:(no unit assumed)

    Controllable:No

    Description:List of VectorPostprocessor(s) to utilize for sensitivity computations.

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