- value_namereporter value name. This uses the reporter syntax
/ . C++ Type:ReporterName
Unit:(no unit assumed)
Controllable:No
Description:reporter value name. This uses the reporter syntax
/ . - variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on
ReporterTimePointSource
Apply a time dependent point load defined by Reporters.
Overview
A ReporterTimePointSource reads in multiple point sources from a Reporter or VectorPostprocessor. The point source values and coordinates are updated as the values are changed.
For exposition, the data determining the coordinates and values can be represented as a five-column matrix:
where is the number of 4-dimensional coordinates supplied. , , , and are the x, y, z, and time value at coordinate , respectively. And is the source value at coordinate . During the simulation, only the sources where matches the simulation time () are applied. So at particular during the simulation the sources being applied can be represented as:
(1)For maximum flexibility, the coordinates and values can change during the simulation based on the evaluation of these vectors in the Reporter or VectorPostprocessor. As such, can depend on time (). So Eq. (1) can be represented as:
commentnote
It is important for the ReporterTimePointSource to never use a VectorPostprocessor with "contains_complete_history"` = true`, as this can modify the ordering of the coordinates and points.
Example Input Syntax
An example of a ReporterTimePointSource using a ConstantReporter:
[DiracKernels]
[vpp_point_source]
type = ReporterTimePointSource
variable = u
value_name = values4D/value
x_coord_name = values4D/coordx
y_coord_name = values4D/coordy
z_coord_name = values4D/coordz
weight_name = values4D/weight
time_name = values4D/time
combine_duplicates = true
[]
[]
[Reporters]
[values4D]
type = ConstantReporter
real_vector_names = 'coordx coordy coordz time value weight'
real_vector_values = '0.25 0.25 0.75 0.25 0.75 0.25 0.75 0.25 0.75
0.25 0.25 0.75 0.25 0.75 0.25 0.75 0.25 0.75
0.25 0.25 0.75 0.25 0.75 0.25 0.75 0.25 0.75;
0.25 0.25 0.25 0.75 0.75 0.25 0.25 0.75 0.75
0.25 0.25 0.25 0.75 0.75 0.25 0.25 0.75 0.75
0.25 0.25 0.25 0.75 0.75 0.25 0.25 0.75 0.75;
0.25 0.25 0.25 0.25 0.25 0.75 0.75 0.75 0.75
0.25 0.25 0.25 0.25 0.25 0.75 0.75 0.75 0.75
0.25 0.25 0.25 0.25 0.25 0.75 0.75 0.75 0.75;
0.10 0.10 0.10 0.10 0.10 0.10 0.10 0.10 0.10
0.20 0.20 0.20 0.20 0.20 0.20 0.20 0.20 0.20
0.30 0.30 0.30 0.30 0.30 0.30 0.30 0.30 0.30;
0.00 0.00 1.00 2.00 3.00 4.00 5.00 6.00 7.00
4.00 1.00 9.00 10.0 11.0 12.0 13.0 14.0 15.0
4.0 1.0 17.0 18.0 19.0 20.0 21.0 22.0 23.0;
1.00 1.00 1.00 1.00 1.00 1.00 1.00 1.00 1.00
1.00 4.00 1.00 1.00 1.00 1.00 1.00 1.00 1.00
2.00 8.00 1.00 1.00 1.00 1.00 1.00 1.00 1.00'
outputs = none
[]
[]
This reporter essentially creates:
During the simulation, only the values where the time value (fourth column) is applied. So at only the first eight rows are applied.
Input Parameters
- allow_moving_sourcesFalseIf true, allow Dirac sources to move, even if the mesh does not move, during the simulation.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If true, allow Dirac sources to move, even if the mesh does not move, during the simulation.
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- combine_duplicatesTrueWhether or not to combine duplicates internally by summing their values times their weights
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to combine duplicates internally by summing their values times their weights
- point_namereporter point name. This uses the reporter syntax
/ . C++ Type:ReporterName
Unit:(no unit assumed)
Controllable:No
Description:reporter point name. This uses the reporter syntax
/ . - point_not_found_behaviorIGNOREBy default (IGNORE), it is ignored if an added point cannot be located in the specified subdomains. If this option is set to ERROR, this situation will result in an error. If this option is set to WARNING, then a warning will be issued.
Default:IGNORE
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:By default (IGNORE), it is ignored if an added point cannot be located in the specified subdomains. If this option is set to ERROR, this situation will result in an error. If this option is set to WARNING, then a warning will be issued.
- 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.
- reverse_time_end0End time used for reversing the time values.
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:End time used for reversing the time values.
- time_nameName of vector-postprocessor or reporter vector containing time, default is assumed to be all 0s.
C++ Type:ReporterName
Unit:(no unit assumed)
Controllable:No
Description:Name of vector-postprocessor or reporter vector containing time, default is assumed to be all 0s.
- 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.
- weight_nameName of vector-postprocessor or reporter vector containing weights to scale value, default is assumed to be all 1s.
C++ Type:ReporterName
Unit:(no unit assumed)
Controllable:No
Description:Name of vector-postprocessor or reporter vector containing weights to scale value, default is assumed to be all 1s.
- x_coord_namereporter x-coordinate name. This uses the reporter syntax
/ . C++ Type:ReporterName
Unit:(no unit assumed)
Controllable:No
Description:reporter x-coordinate name. This uses the reporter syntax
/ . - y_coord_namereporter y-coordinate name. This uses the reporter syntax
/ . C++ Type:ReporterName
Unit:(no unit assumed)
Controllable:No
Description:reporter y-coordinate name. This uses the reporter syntax
/ . - z_coord_namereporter z-coordinate name. This uses the reporter syntax
/ . C++ Type:ReporterName
Unit:(no unit assumed)
Controllable:No
Description:reporter z-coordinate name. This uses the reporter syntax
/ .
Optional Parameters
- absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
- extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The extra tags for the matrices this Kernel should fill
- extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The extra tags for the vectors this Kernel should fill
- matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The tag for the matrices this Kernel should fill
- vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The tag for the vectors this Kernel should fill
Tagging Parameters
- 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.
- implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The seed for the master random number generator
- 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.
Advanced Parameters
Input Files
- (modules/optimization/examples/simpleTransient/adjoint.i)
- (modules/optimization/examples/simpleTransient/adjoint_mesh.i)
- (modules/optimization/examples/simpleTransient/forward_and_adjoint.i)
- (modules/optimization/examples/simpleTransient/nonlinear_forward_and_adjoint.i)
- (modules/optimization/examples/diffusion_reaction/forward_and_adjoint.i)
- (modules/optimization/test/tests/dirackernels/reporter_time_point_source.i)
- (modules/optimization/examples/materialTransient/forward_and_adjoint.i)
- (modules/optimization/examples/materialTransient/gradient.i)