- output_valueValue of the model output from the SubApp.
C++ Type:ReporterName
Controllable:No
Description:Value of the model output from the SubApp.
- samplerThe sampler object.
C++ Type:SamplerName
Controllable:No
Description:The sampler object.
AdaptiveMonteCarloDecision
Generic reporter which decides whether or not to accept a proposed sample in Adaptive Monte Carlo type of algorithms.
Description
Adaptive Monte Carlo algorithms, generally speaking, work by proposing the next set of input parameters, performing a model evaluation, and deciding whether or not to accept the proposed input parameters. Classes derived from the Sampler class help propose the next set of input parameters and classes derived from the MultiApp system to evaluate the model. However, an additional class is needed to make the decision on whether or not to accept the next input parameters proposed by the sampler class. To this end, AdaptiveMonteCarloDecision will help make such decisions. AdaptiveMonteCarloDecision is designed as a reporter class since a reporter has access to both the sampler objects and the MultiApp system.
Available adaptive Monte Carlo samplers
The following adaptive Monte Carlo samplers have been implemented in MOOSE:
Adaptive Importance Sampling (AIS)
AIS proposes and accepts the next input parameters using a Markov Chain Monte Carlo scheme to sample sufficiently in the failure region given a model. See AdaptiveImportanceSampler for more information.
Parallel Subset Simulation (PSS)
PSS can be used for characterizing probabilistic failure or performing optimization under uncertainty efficiently when dealing with expensive numerical models. This method works by creating intermediate failure thresholds and using hundreds of Markov chains to efficiently propagate to regions of the input parameter space that are most significant for either failure characterization or optimization. See ParallelSubsetSimulation for more information.
Input Parameters
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.
- inputsinputsUncertain inputs to the model.
Default:inputs
C++ Type:ReporterValueName
Controllable:No
Description:Uncertain inputs to the model.
- output_requiredoutput_requiredModified value of the model output from this reporter class.
Default:output_required
C++ Type:ReporterValueName
Controllable:No
Description:Modified value of the model output from this reporter class.
- 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
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.
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).
- 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.
- 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
- outputsVector of output names were 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 were 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.