- acquisitionName of the acquisition function.
C++ Type:UserObjectName
Controllable:No
Description:Name of the acquisition function.
- al_gpActive learning GP trainer.
C++ Type:UserObjectName
Controllable:No
Description:Active learning GP trainer.
- gp_evaluatorEvaluator for the trained GP.
C++ Type:UserObjectName
Controllable:No
Description:Evaluator for the trained GP.
- 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.
GenericActiveLearner
A generic reporter to support parallel active learning: re-trains GP and picks the next best batch.
Description
The GenericActiveLearner is intended to facilitate parallel active learning schemes in MOOSE. This class does the following important functions:
Re-train the Gaussian process surrogate via the
reTrainfunction in the ActiveLearningGaussianProcess object.Select the next best batch of inputs on which to evaluate the MOOSE model using the AcquisitionFunction.
This object should be used in conjuction to the Reporter GenericActiveLearningSampler which facilitates the generation of new samples for evaluating the Gaussian process and evaluation of the MOOSE model using the previous best samples selected by the Gaussian process.
Input Parameters
- acquisition_functionacquisition_functionThe values of the acquistion function in the current iteration.
Default:acquisition_function
C++ Type:ReporterValueName
Controllable:No
Description:The values of the acquistion function in the current iteration.
- convergence_valueconvergence_valueValue to measure convergence of active learning.
Default:convergence_value
C++ Type:ReporterValueName
Controllable:No
Description:Value to measure convergence of active learning.
- inputsinputsModified value of the model inputs from this reporter class.
Default:inputs
C++ Type:ReporterValueName
Controllable:No
Description:Modified value of the model inputs from this reporter class.
- outputs_requiredoutputs_requiredModified value of the model output from this reporter class.
Default:outputs_required
C++ Type:ReporterValueName
Controllable:No
Description:Modified value of the model output from this reporter class.
- penalize_acquisitionTrueSet true to prevent clustering of the best batch inputs when operating in parallel.
Default:True
C++ Type:bool
Controllable:No
Description:Set true to prevent clustering of the best batch inputs when operating in parallel.
- sorted_indicessorted_indicesThe sorted sample indices in order of importance to evaluate the subApp.
Default:sorted_indices
C++ Type:ReporterValueName
Controllable:No
Description:The sorted sample indices in order of importance to evaluate the subApp.
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.