- file_baseThe desired solution output name without an extension. If not provided, MOOSE sets it with Outputs/file_base when available. Otherwise, MOOSE uses input file name and this object name for a master input or uses master file_base, the subapp name and this object name for a subapp input to set it.
C++ Type:std::string
Controllable:No
Description:The desired solution output name without an extension. If not provided, MOOSE sets it with Outputs/file_base when available. Otherwise, MOOSE uses input file name and this object name for a master input or uses master file_base, the subapp name and this object name for a subapp input to set it.
- trainersA list of SurrogateTrainer objects to output.
C++ Type:std::vector<UserObjectName>
Controllable:No
Description:A list of SurrogateTrainer objects to output.
SurrogateTrainerOutput
Output for trained surrogate model data.
Overview
Surrogate models, once trained, can be output to a binary file for later use by using the SurrogateTrainerOutput object. All data within the model that was delcared using declareTrainerData
is automatically stored in the generated file.
Example Input File Syntax
The following snippet includes a surrogate model that is being trained and after the training is complete the model data is output using the SurrogateTrainerOutput object.
[Trainers]
[poly_chaos]
type = PolynomialChaosTrainer
execute_on = timestep_end
order = 5
distributions = 'D_dist S_dist'
sampler = quadrature
response = storage/data:avg:value
[]
[]
[Outputs]
[out]
type = SurrogateTrainerOutput
trainers = 'poly_chaos'
execute_on = FINAL
[]
[]
(modules/stochastic_tools/test/tests/surrogates/load_store/train.i)Input Parameters
- additional_execute_onThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, FAILED, CUSTOM, ALWAYS.
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, FAILED, CUSTOM, ALWAYS.
- append_dateFalseWhen true the date and time are appended to the output filename.
Default:False
C++ Type:bool
Controllable:No
Description:When true the date and time are appended to the output filename.
- append_date_formatThe format of the date/time to append, if not given UTC format is used (see http://www.cplusplus.com/reference/ctime/strftime).
C++ Type:std::string
Controllable:No
Description:The format of the date/time to append, if not given UTC format is used (see http://www.cplusplus.com/reference/ctime/strftime).
- end_stepTime step at which this output object stop operating
C++ Type:int
Controllable:No
Description:Time step at which this output object stop operating
- execute_onINITIAL TIMESTEP_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, FAILED, CUSTOM, ALWAYS.
Default:INITIAL 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, FAILED, CUSTOM, ALWAYS.
- output_linearFalseSpecifies whether output occurs on each linear residual evaluation
Default:False
C++ Type:bool
Controllable:No
Description:Specifies whether output occurs on each linear residual evaluation
- output_nonlinearFalseSpecifies whether output occurs on each nonlinear residual evaluation
Default:False
C++ Type:bool
Controllable:No
Description:Specifies whether output occurs on each nonlinear residual evaluation
- start_stepTime step at which this output object begins to operate
C++ Type:int
Controllable:No
Description:Time step at which this output object begins to operate
- use_displacedFalseEnable/disable the use of the displaced mesh for outputting
Default:False
C++ Type:bool
Controllable:No
Description:Enable/disable the use of the displaced mesh for outputting
Optional 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.
- output_if_base_containsIf this is supplied then output will only be done in the case that the output base contains one of these strings. This is helpful in outputting only a subset of outputs when using MultiApps.
C++ Type:std::vector<std::string>
Controllable:No
Description:If this is supplied then output will only be done in the case that the output base contains one of these strings. This is helpful in outputting only a subset of outputs when using MultiApps.
- padding4The number of digits for the extension suffix (e.g., out.e-s002)
Default:4
C++ Type:unsigned int
Controllable:No
Description:The number of digits for the extension suffix (e.g., out.e-s002)
Advanced Parameters
- end_timeTime at which this output object stop operating
C++ Type:double
Controllable:No
Description:Time at which this output object stop operating
- interval1The interval at which time steps are output to the solution file
Default:1
C++ Type:unsigned int
Controllable:No
Description:The interval at which time steps are output to the solution file
- start_timeTime at which this output object begins to operate
C++ Type:double
Controllable:No
Description:Time at which this output object begins to operate
- sync_onlyFalseOnly export results at sync times
Default:False
C++ Type:bool
Controllable:No
Description:Only export results at sync times
- sync_timesTimes at which the output and solution is forced to occur
C++ Type:std::vector<double>
Controllable:No
Description:Times at which the output and solution is forced to occur
- time_tolerance1e-14Time tolerance utilized checking start and end times
Default:1e-14
C++ Type:double
Controllable:No
Description:Time tolerance utilized checking start and end times
Timing Parameters
- linear_residual_dt_divisor1000Number of divisions applied to time step when outputting linear residuals
Default:1000
C++ Type:double
Controllable:No
Description:Number of divisions applied to time step when outputting linear residuals
- linear_residual_end_timeSpecifies an end time to begin output on each linear residual evaluation
C++ Type:double
Controllable:No
Description:Specifies an end time to begin output on each linear residual evaluation
- linear_residual_start_timeSpecifies a start time to begin output on each linear residual evaluation
C++ Type:double
Controllable:No
Description:Specifies a start time to begin output on each linear residual evaluation
- nonlinear_residual_dt_divisor1000Number of divisions applied to time step when outputting non-linear residuals
Default:1000
C++ Type:double
Controllable:No
Description:Number of divisions applied to time step when outputting non-linear residuals
- nonlinear_residual_end_timeSpecifies an end time to begin output on each nonlinear residual evaluation
C++ Type:double
Controllable:No
Description:Specifies an end time to begin output on each nonlinear residual evaluation
- nonlinear_residual_start_timeSpecifies a start time to begin output on each nonlinear residual evaluation
C++ Type:double
Controllable:No
Description:Specifies a start time to begin output on each nonlinear residual evaluation
Petsc Parameters
Input Files
- (modules/combined/examples/stochastic/poly_chaos_train_uniform.i)
- (modules/stochastic_tools/examples/surrogates/pod_rb/2d_multireg/trainer.i)
- (modules/stochastic_tools/test/tests/surrogates/libtorch_nn/train.i)
- (modules/stochastic_tools/examples/surrogates/combined/trans_diff_2d/trans_diff_trainer.i)
- (modules/stochastic_tools/examples/surrogates/poly_chaos_normal_quad.i)
- (modules/stochastic_tools/test/tests/surrogates/gaussian_process/GP_squared_exponential_training.i)
- (modules/stochastic_tools/examples/surrogates/poly_chaos_uniform_mc.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/errors/trainer.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/internal/trainer.i)
- (modules/stochastic_tools/examples/surrogates/polynomial_regression/uniform_train.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/boundary/trainer.i)
- (modules/stochastic_tools/examples/surrogates/polynomial_regression/normal_train.i)
- (modules/stochastic_tools/examples/surrogates/nearest_point_training.i)
- (modules/stochastic_tools/test/tests/surrogates/polynomial_regression/train.i)
- (modules/stochastic_tools/examples/surrogates/poly_chaos_normal_mc.i)
- (modules/stochastic_tools/examples/surrogates/gaussian_process/GP_normal_mc.i)
- (modules/stochastic_tools/test/tests/surrogates/nearest_point/train.i)
- (modules/stochastic_tools/test/tests/surrogates/load_store/train.i)
- (modules/stochastic_tools/examples/surrogates/poly_chaos_uniform_quad.i)