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

Points in ReporterPointSource are combined when they are within the Dirac point fuzzy-comparison tolerance. This means two loads at nearly the same coordinates are applied at a single geometric Dirac point. To apply two different reporter loads correctly at that same combined point, ReporterPointSource must use drop_duplicate_points = false so the stored point values are accumulated and assembled properly. This parameter is therefore suppressed for ReporterPointSource and set internally to false. See the developer note below for more details on how Dirac point values and duplicate handling work.

An example of a ReporterPointSource using a ConstantReporter and a VectorPostprocessor of type CSVReaderVectorPostprocessor is given by:

[DiracKernels<<<{"href": "../../syntax/DiracKernels/index.html"}>>>]
  [reporter_point_source]
    type = ReporterPointSource<<<{"description": "Apply a point load defined by Reporter.", "href": "ReporterPointSource.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
    value_name<<<{"description": "reporter value name.  This uses the reporter syntax <reporter>/<name>."}>>> = 'reporterData/u'
    x_coord_name<<<{"description": "reporter x-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = 'reporterData/x'
    y_coord_name<<<{"description": "reporter y-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = 'reporterData/y'
    z_coord_name<<<{"description": "reporter z-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = 'reporterData/z'
    weight_name<<<{"description": "Name of vector-postprocessor or reporter vector containing weights to scale value, default is assumed to be all 1s."}>>> = 'reporterData/weight'
  []
[]
(test/tests/dirackernels/reporter_point_source/2d_vpp.i)

The ConstantReporter provides the following data:

[Reporters<<<{"href": "../../syntax/Reporters/index.html"}>>>]
  [reporterData]
    type = ConstantReporter<<<{"description": "Reporter with constant values to be accessed by other objects, can be modified using transfers.", "href": "../reporters/ConstantReporter.html"}>>>
    real_vector_names<<<{"description": "Names for each vector of reals value."}>>> = 'x y z u weight'
    real_vector_values<<<{"description": "Values for vectors of reals."}>>> = '0.2 0.2 0.0; 0.3 0.8 0.0; 0 0 0; 1 -.5 0; 1 1 1'
  []
[]
(test/tests/dirackernels/reporter_point_source/2d_vpp.i)

The CSVReaderVectorPostprocessor is given by:

[VectorPostprocessors<<<{"href": "../../syntax/VectorPostprocessors/index.html"}>>>]
  [csv_reader]
    type = CSVReader<<<{"description": "Converts columns of a CSV file into vectors of a VectorPostprocessor.", "href": "../vectorpostprocessors/CSVReaderVectorPostprocessor.html"}>>>
    csv_file<<<{"description": "The name of the CSV file to read. Currently, with the exception of the header row, only numeric values are supported."}>>> = point_value_file.csv
  []
[]
(test/tests/dirackernels/reporter_point_source/2d_vpp.i)

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
(test/tests/dirackernels/reporter_point_source/point_value_file.csv)

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<<<{"href": "../../syntax/DiracKernels/index.html"}>>>]
  [vpp_point_source]
    type = ReporterPointSource<<<{"description": "Apply a point load defined by Reporter.", "href": "ReporterPointSource.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
    value_name<<<{"description": "reporter value name.  This uses the reporter syntax <reporter>/<name>."}>>> = point_sample_source/u
    x_coord_name<<<{"description": "reporter x-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = point_sample_source/x
    y_coord_name<<<{"description": "reporter y-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = point_sample_source/y
    z_coord_name<<<{"description": "reporter z-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = point_sample_source/z
  []
[]
(test/tests/dirackernels/reporter_point_source/2d_vpp_transient.i)

using the following VectorPostprocessor to provide x,y,z coordinates and value_name = u

[VectorPostprocessors<<<{"href": "../../syntax/VectorPostprocessors/index.html"}>>>]
  [point_sample_out]
    type = PointValueSampler<<<{"description": "Sample a variable at specific points.", "href": "../vectorpostprocessors/PointValueSampler.html"}>>>
    variable<<<{"description": "The names of the variables that this VectorPostprocessor operates on"}>>> = u
    points<<<{"description": "The points where you want to evaluate the variables"}>>> = '0.2 0.8 0.0'
    sort_by<<<{"description": "What to sort the samples by. Options include 'x', 'y', 'z', 'id', and the name of any of the sampled quantities (which each create a vector of the same name)."}>>> = id
    execute_on<<<{"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."}>>> = 'timestep_begin'
    contains_complete_history<<<{"description": "Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation"}>>> = true
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = 'csv'
  []
[]
(test/tests/dirackernels/reporter_point_source/2d_vpp_transient.i)

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.

Developer Note: Dirac Point Values and Duplicate Handling

Every DiracKernel combines Dirac points that are within a fuzzy-comparison tolerance of one another into a single geometric point. This combining of nearby points is performed internally by DiracKernelInfo and always occurs, regardless of the drop_duplicate_points setting. However, the values at those combined points are not always combined — that behavior depends on drop_duplicate_points.

The drop_duplicate_points parameter controls what happens during residual and Jacobian assembly:

  • drop_duplicate_points = true (default): The accumulated values of the combined points are ignored and only a single point's contribution from computeQpResidual() is used. Because the default is true, only a single point's contribution will be applied unless drop_duplicate_points is explicitly set to false.

  • drop_duplicate_points = false: The values passed to addPoint() for coincident points are accumulated onto the single combined geometric point. During assembly, this accumulated value is used as a multiplier on computeQpResidual(). This is needed when multiple sources may coincide and each must contribute its own value.

Because of this design, a leaf class's computeQpResidual() does not return the final residual contribution directly. It returns a kernel term (typically involving only test functions) that is then scaled by the stored point value during assembly in DiracKernel::computeResidual().

commentnote

ReporterPointSource forces drop_duplicate_points = false internally and suppresses the parameter. This ensures that when two reporter-defined loads land at the same geometric Dirac point (within the fuzzy tolerance), their values are accumulated and the combined value is applied during assembly rather than being treated as a single unit load.

Input Parameters

  • value_namereporter value name. This uses the reporter syntax /.

    C++ Type:ReporterName

    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

Required 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

    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>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • point_namereporter point name. This uses the reporter syntax /.

    C++ Type:ReporterName

    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

    Options:ERROR, WARNING, IGNORE

    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.

  • weight_nameName of vector-postprocessor or reporter vector containing weights to scale value, default is assumed to be all 1s.

    C++ Type:ReporterName

    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

    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

    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

    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>

    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>

    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>

    Controllable:No

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_onlyFalseWhether this object is only doing assembly to matrices (no vectors)

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether this object is only doing assembly to matrices (no vectors)

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Options:nontime, system

    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

    Options:nontime, time

    Controllable:No

    Description:The tag for the vectors this Kernel should fill

Contribution To Tagged Field Data 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.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • search_methodnearest_node_connected_sidesChoice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).

    Default:nearest_node_connected_sides

    C++ Type:MooseEnum

    Options:nearest_node_connected_sides, all_proximate_sides

    Controllable:No

    Description:Choice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    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

    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

  • 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

    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.

Material Property Retrieval Parameters

Input Files

Child Objects