- 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
ReporterPointSource
A ReporterPointSource reads in multiple point sources from a Reporter. The point source values and coordinates are updated as the Reporter values are changed.
warningwarning
Duplicated points, i.e. points with the same xyz coordinates, are dropped by DiracKernels and applied as a single point. The input parameter "combine_duplicates" combines the values and weights of duplicated points when set to True. Reporters containing duplicate points will produce an error when set to False. The parameter drop_duplicate_points used by other DiracKernels to handle duplicate points is suppressed for the ReporterPointSource because it is expected that every duplicate point in a ReporterPointSource will have different value and weight and are not just multiples of the sames value.
An example of a ReporterPointSource using a ConstantReporter and a VectorPostprocessor of type CSVReaderVectorPostprocessor is given by:
[DiracKernels]
[reporter_point_source]
type = ReporterPointSource
variable = u
value_name = 'reporterData/u'
x_coord_name = 'reporterData/x'
y_coord_name = 'reporterData/y'
z_coord_name = 'reporterData/z'
weight_name = 'reporterData/weight'
[]
[]
The ConstantReporter provides the following data:
[Reporters]
[reporterData]
type = ConstantReporter
real_vector_names = 'x y z u weight'
real_vector_values = '0.2 0.2 0.0; 0.3 0.8 0.0; 0 0 0; 1 -.5 0; 1 1 1'
[]
[]
The CSVReaderVectorPostprocessor is given by:
[VectorPostprocessors]
[csv_reader]
type = CSVReader
csv_file = point_value_file.csv
[]
[]
reading from the following csv file:
x,y,z,id,u,x3,y3,z3,value3
0.2,0.3,0.0,0,1.0,0.2,0.3,0,0.1
0.2,0.8,0.0,1,-0.5,0.2,0.8,0.0,-0.1
0.0,0.0,0.0,2,0.0,0.8,0.5,0.8,-1.0
The Reporter and VectorPostprocessor for the above example produce the same ReporterPointSource (e.g. same magnitude and location).
The next example applies a ReporterPointSource in a transient simulation given by:
[DiracKernels]
[vpp_point_source]
type = ReporterPointSource
variable = u
value_name = point_sample_source/u
x_coord_name = point_sample_source/x
y_coord_name = point_sample_source/y
z_coord_name = point_sample_source/z
[]
[]
using the following VectorPostprocessor to provide x,y,z coordinates and value_name = u
[VectorPostprocessors]
[point_sample_out]
type = PointValueSampler
variable = u
points = '0.2 0.8 0.0'
sort_by = id
execute_on = 'timestep_begin'
contains_complete_history = true
outputs = 'csv'
[]
[]
In the above input file, the ReporterPointSource is applying loads at two different locations. Note that the PointValueSampler has execute_on = timestep_begin to force the VectorPostprocessor to execute prior to being used by ReporterPointSource.
commentnote
It is important for the ReporterPointSource to never use a VectorPostprocessor with contains_complete_history = true, as this can modify the ordering of the coordinates and points. In the above input file, two locations have loads applied to them by the ReporterPointSource. The load values are given by the PointValueSampler.
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.
- 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.