- trainer_nameTrainer object that contains the solutions for different samples.
C++ Type:UserObjectName
Controllable:No
Description:Trainer object that contains the solutions for different samples.
PODResidualTransfer
This object is responsible for transferring residual vectors from PODFullSolveMultiApp to PODReducedBasisTrainer.
Example Syntax
This objects type needs to know about the trainer and the multi-app objects. This can be achieved by specifying the "trainer_name" and "multi_app" parameters in the input file.
[res]
type = PODResidualTransfer
from_multi_app = sub
sampler = sample
trainer_name = "pod_rb"
execute_on = 'final'
check_multiapp_execute_on = false
[]
Input Parameters
- _called_legacy_paramsTrue
Default:True
C++ Type:bool
Controllable:No
- check_multiapp_execute_onFalseWhen false the check between the multiapp and transfer execute on flags is not preformed.
Default:False
C++ Type:bool
Controllable:No
Description:When false the check between the multiapp and transfer execute on flags is not preformed.
- displaced_source_meshFalseWhether or not to use the displaced mesh for the source mesh.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to use the displaced mesh for the source mesh.
- displaced_target_meshFalseWhether or not to use the displaced mesh for the target mesh.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to use the displaced mesh for the target mesh.
- execute_onSAME_AS_MULTIAPPThe 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, SAME_AS_MULTIAPP, ALWAYS.
Default:SAME_AS_MULTIAPP
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, SAME_AS_MULTIAPP, ALWAYS.
- from_multi_appThe name of the MultiApp to receive data from
C++ Type:MultiAppName
Controllable:No
Description:The name of the MultiApp to receive data from
- samplerA the Sampler object that Transfer is associated..
C++ Type:SamplerName
Controllable:No
Description:A the Sampler object that Transfer is associated..
- to_multi_appThe name of the MultiApp to transfer the data to
C++ Type:MultiAppName
Controllable:No
Description:The name of the MultiApp to transfer the data to
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.
- 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
Input Files
- (modules/stochastic_tools/examples/surrogates/pod_rb/2d_multireg/trainer.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/internal/trainer_and_surr.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/errors/trainer.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/errors/trainer_and_surr.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/internal/trainer.i)
- (modules/stochastic_tools/test/tests/surrogates/pod_rb/boundary/trainer.i)