- samplerDirect Perturbation sampler used to generate samples.
C++ Type:SamplerName
Controllable:No
Description:Direct Perturbation sampler used to generate samples.
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:
[Samplers<<<{"href": "../../syntax/Samplers/index.html"}>>>]
[directperturbation]
type = DirectPerturbationSampler<<<{"description": "Sampler that creates samples for a direct perturbation-based sensitivity study.", "href": "../samplers/DirectPerturbationSampler.html"}>>>
nominal_parameter_values<<<{"description": "The nominal values of the parameters around which we shall perturb them."}>>> = '0.1 0.2 0.3'
relative_perturbation_intervals<<<{"description": "The numbers by which the nominal values are multiplied to get a perturbed value."}>>> = '0.1 0.2 0.3'
perturbation_method<<<{"description": "The perturbation method to use for creating samples."}>>> = central_difference
execute_on<<<{"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."}>>> = PRE_MULTIAPP_SETUP
[]
[][Reporters<<<{"href": "../../syntax/Reporters/index.html"}>>>]
[storage]
type = StochasticReporter<<<{"description": "Storage container for stochastic simulation results coming from Reporters.", "href": "StochasticReporter.html"}>>>
outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = NONE
[]
[sensitivities]
type = DirectPerturbationReporter<<<{"description": "Compute local sensitivities using the direct perturbation method.", "href": "DirectPerturbationReporter.html"}>>>
reporters<<<{"description": "List of Reporter values to utilize for sensitivity computations."}>>> = 'storage/data:const:f1 storage/data:const:f2 storage/data:const:f3 storage/data:const:f_combined'
execute_on<<<{"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."}>>> = FINAL
sampler<<<{"description": "Direct Perturbation sampler used to generate samples."}>>> = directperturbation
[]
[]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
}
]
}
We see that the method recovers the expansion coefficients of the functions exactly.
Input Parameters
- relative_sensitivityFalseIf the reporter should return relative or absolute sensitivities.
Default:False
C++ Type:bool
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>
Controllable:No
Description:List of Reporter values to utilize for sensitivity computations.
- 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
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
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
- 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.