- mappingName of the mapping object.
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:Name of the mapping object.
- variablesThe names of the variables which need to be mapped to the latent space.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The names of the variables which need to be mapped to the latent space.
MappingReporter
A reporter which can map full solution fields to a latent space for given variables.
Overview
This object is responsible for mapping high-dimensional solution fields to low-dimensional vectors. The mapped vectors are then stored within the reporter data storage. The "mapping" parameter can be used to specify the mapping object from the VariableMappings
block. The variables which need to be mapped can be defined using "variables". There are two distinct ways to use this object:
In conjunction with a ParallelSolutionStorage object: In this case, the first time this object is executed, it will build the mapping using the available data in the parallel storage. Then, using the generated mapping, it maps the solution fields in the parallel storage into the latent space and saves the coordinates into the reporter storage. This gives a straightforward pipeline for the training of surrogate models for the coordinates of the solutions fields in the latent space. In this case, the user is expected to define the "parallel_storage" and "sampler" parameters.
Without a ParallelSolutionStorage object: This functionality is designed to load an already trained mapping object and map a solution variable in a nonlinear system into the latent space and store the coordinates in this reporter.
Example Input File Syntax
Example for mapping solutions in a ParallelSolutionStorage object:
(contrib/moose/modules/stochastic_tools/test/tests/reporters/mapping/map_main.i)Example for mapping solutions:
(contrib/moose/modules/stochastic_tools/test/tests/reporters/mapping/load_main.i)Syntax
Input Parameters
- 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
Unit:(no unit assumed)
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.
- parallel_storageThe storage space where the snapshots are stored. These snapshots are used to build the mapping. If this parameter is not specified, the reporter will fetch the variable from the nonlinear system.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The storage space where the snapshots are stored. These snapshots are used to build the mapping. If this parameter is not specified, the reporter will fetch the variable from the nonlinear system.
- parallel_typeDISTRIBUTEDThis parameter will determine how the stochastic data is gathered. It is common for outputting purposes that this parameter be set to ROOT, otherwise, many files will be produced showing the values on each processor. However, if there are lot of samples, gathering on root may be memory restrictive.
Default:DISTRIBUTED
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:This parameter will determine how the stochastic data is gathered. It is common for outputting purposes that this parameter be set to ROOT, otherwise, many files will be produced showing the values on each processor. However, if there are lot of samples, gathering on root may be memory restrictive.
- 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.
- samplerSampler be able to identify how the samples are distributed among the processes. Only needed if parallel storage is defined. It is important to have the same sampler here as the one used to prepare the snapshots in the parallel storage.
C++ Type:SamplerName
Unit:(no unit assumed)
Controllable:No
Description:Sampler be able to identify how the samples are distributed among the processes. Only needed if parallel storage is defined. It is important to have the same sampler here as the one used to prepare the snapshots in the parallel storage.
- 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
Unit:(no unit assumed)
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.
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- 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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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.