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:

var element = document.getElementById("moose-equation-0bfbdcff-a33f-4c84-9e34-8b3a63fe79cd");katex.render("\\mathbf{S} \\equiv \\begin{bmatrix} x_1 & y_1 & z_1 & t_1 & s_1 \\\\ x_2 & y_2 & z_2 & t_2 & s_2 \\\\ \\vdots & \\vdots & \\vdots & \\vdots & \\vdots \\\\ x_N & y_N & z_N & t_N & s_N \\end{bmatrix} ,", element, {displayMode:true,throwOnError:false});

where $var element = document.getElementById("moose-equation-870340d6-1bcf-440b-89ae-45706cff36a3");katex.render("N", element, {displayMode:false,throwOnError:false});$ is the number of 4-dimensional coordinates supplied. $var element = document.getElementById("moose-equation-d2e0f4e6-2d28-4a45-a34e-cca2102a55c1");katex.render("x_i", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-b138655a-74a3-4a63-96f6-5ff06c805080");katex.render("y_i", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-26f3239d-3b9b-49d0-9928-c59b716e0fea");katex.render("z_i", element, {displayMode:false,throwOnError:false});$ , and $var element = document.getElementById("moose-equation-7d359354-6419-4317-9176-53dd16d6ffcb");katex.render("t_i", element, {displayMode:false,throwOnError:false});$ are the x, y, z, and time value at coordinate $var element = document.getElementById("moose-equation-a26aeb5a-17c1-4726-b5e9-a432160deead");katex.render("i", element, {displayMode:false,throwOnError:false});$ , respectively. And $var element = document.getElementById("moose-equation-f87bc389-6ec6-455d-9d12-d858593406fc");katex.render("s_i", element, {displayMode:false,throwOnError:false});$ is the source value at coordinate $var element = document.getElementById("moose-equation-68695690-b043-4f78-b1ae-7b0768f9374a");katex.render("i", element, {displayMode:false,throwOnError:false});$ . During the simulation, only the sources where $var element = document.getElementById("moose-equation-d145c957-db1a-44d2-9746-650cdf1ed2e1");katex.render("t_i", element, {displayMode:false,throwOnError:false});$ matches the simulation time ( $var element = document.getElementById("moose-equation-7450a2d0-77de-4fb6-b97d-848936dafe1e");katex.render("t_{\\mathrm{sim}}", element, {displayMode:false,throwOnError:false});$ ) are applied. So at particular $var element = document.getElementById("moose-equation-2a4d8c8f-11c0-4bef-bbf9-2d0c1db591cd");katex.render("t_{\\mathrm{sim}}", element, {displayMode:false,throwOnError:false});$ during the simulation the sources being applied can be represented as:

(1)var element = document.getElementById("moose-equation-30365adb-fa05-4c07-8227-75eaf18c2dc0");katex.render("\\vec{S}_i(t_{\\mathrm{sim}}) = \\begin{bmatrix} x_i & y_i & z_i & s_i\\delta_{t_i, t_{\\mathrm{sim}}} \\end{bmatrix},\\quad i=1,...,N.", element, {displayMode:true,throwOnError:false});

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, $var element = document.getElementById("moose-equation-26897066-21d3-402a-880d-65854a75b66a");katex.render("\\mathbf{S}", element, {displayMode:false,throwOnError:false});$ can depend on time ( $var element = document.getElementById("moose-equation-1eacc44e-4547-4184-983e-65b127453e70");katex.render("\\mathbf{S}(t)", element, {displayMode:false,throwOnError:false});$ ). So Eq. (1) can be represented as:

var element = document.getElementById("moose-equation-3b1c2d26-a4c5-4c00-bebd-23c92f92bf52");katex.render("\\vec{S}_i(t_{\\mathrm{sim}}) = \\begin{bmatrix} x_i(t_{\\mathrm{sim}}) & y_i(t_{\\mathrm{sim}}) & z_i(t_{\\mathrm{sim}}) & s_i(t_{\\mathrm{sim}})\\delta_{t_i(t_{\\mathrm{sim}}), t_{\\mathrm{sim}}} \\end{bmatrix},\\quad i=1,...,N(t_{\\mathrm{sim}}).", element, {displayMode:true,throwOnError:false});

note

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<<<{"href": "../../syntax/DiracKernels/index.html"}>>>]
  [vpp_point_source]
    type = ReporterTimePointSource<<<{"description": "Apply a time dependent point load defined by Reporters.", "href": "ReporterTimePointSource.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>."}>>> = values4D/value
    x_coord_name<<<{"description": "reporter x-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = values4D/coordx
    y_coord_name<<<{"description": "reporter y-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = values4D/coordy
    z_coord_name<<<{"description": "reporter z-coordinate name.  This uses the reporter syntax <reporter>/<name>."}>>> = values4D/coordz
    weight_name<<<{"description": "Name of vector-postprocessor or reporter vector containing weights to scale value, default is assumed to be all 1s."}>>> = values4D/weight
    time_name<<<{"description": "Name of vector-postprocessor or reporter vector containing time, default is assumed to be all 0s."}>>> = values4D/time
    combine_duplicates<<<{"description": "Whether or not to combine duplicates internally by summing their values times their weights"}>>> = true
  []
[]

[Reporters<<<{"href": "../../syntax/Reporters/index.html"}>>>]
  [values4D]
    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."}>>> = 'coordx coordy coordz time value weight'
    real_vector_values<<<{"description": "Values for vectors of reals."}>>> = '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<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = none
  []
[]

This reporter essentially creates:

var element = document.getElementById("moose-equation-d13c8436-c81d-4f9a-996f-c5cee69cd7c7");katex.render("\\mathbf{S} = \\begin{bmatrix} x & y & z & t & s \\\\ \\hline 0.25 & 0.25 & 0.25 & 0.10 & 0.00 \\\\ 0.75 & 0.25 & 0.25 & 0.10 & 1.00 \\\\ 0.25 & 0.75 & 0.25 & 0.10 & 2.00 \\\\ 0.75 & 0.75 & 0.25 & 0.10 & 3.00 \\\\ 0.25 & 0.25 & 0.75 & 0.10 & 4.00 \\\\ 0.75 & 0.25 & 0.75 & 0.10 & 5.00 \\\\ 0.25 & 0.75 & 0.75 & 0.10 & 6.00 \\\\ 0.75 & 0.75 & 0.75 & 0.10 & 7.00 \\\\ 0.25 & 0.25 & 0.25 & 0.20 & 8.00 \\\\ 0.75 & 0.25 & 0.25 & 0.20 & 9.00 \\\\ 0.25 & 0.75 & 0.25 & 0.20 & 10.0 \\\\ 0.75 & 0.75 & 0.25 & 0.20 & 11.0 \\\\ 0.25 & 0.25 & 0.75 & 0.20 & 12.0 \\\\ 0.75 & 0.25 & 0.75 & 0.20 & 13.0 \\\\ 0.25 & 0.75 & 0.75 & 0.20 & 14.0 \\\\ 0.75 & 0.75 & 0.75 & 0.20 & 15.0 \\\\ 0.25 & 0.25 & 0.25 & 0.30 & 16.0 \\\\ 0.75 & 0.25 & 0.25 & 0.30 & 17.0 \\\\ 0.25 & 0.75 & 0.25 & 0.30 & 18.0 \\\\ 0.75 & 0.75 & 0.25 & 0.30 & 19.0 \\\\ 0.25 & 0.25 & 0.75 & 0.30 & 20.0 \\\\ 0.75 & 0.25 & 0.75 & 0.30 & 21.0 \\\\ 0.25 & 0.75 & 0.75 & 0.30 & 22.0 \\\\ 0.75 & 0.75 & 0.75 & 0.30 & 23.0 \\\\ \\end{bmatrix}.", element, {displayMode:true,throwOnError:false});

During the simulation, only the values where the time value (fourth column) is applied. So at $var element = document.getElementById("moose-equation-9b6865ae-b14e-4503-a9ab-fc224f65aa99");katex.render("t_{\\mathrm{sim}}=0.10", element, {displayMode:false,throwOnError:false});$ only the first eight rows are applied.

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
combine_duplicatesTrueWhether or not to combine duplicates internally by summing their values times their weights
Default:True
C++ Type:bool
Controllable:No
Description:Whether or not to combine duplicates internally by summing their values times their weights
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)
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.
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
Controllable:No
Description:Name of vector-postprocessor or reporter vector containing time, default is assumed to be all 0s.
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_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
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

(moose/modules/optimization/test/tests/dirackernels/reporter_time_point_source.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 3
    nx = 4
    ny = 4
    nz = 4
  []
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [diff]
    type = Diffusion
    variable = u
  []
  [dot]
    type = TimeDerivative
    variable = u
  []
[]

[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
  []
[]

[VectorPostprocessors]
  [sample]
    type = PointValueSampler
    variable = u
    points = '0.25 0.25 0.25
              0.75 0.25 0.25
              0.25 0.75 0.25
              0.75 0.75 0.25
              0.25 0.25 0.75
              0.75 0.25 0.75
              0.25 0.75 0.75
              0.75 0.75 0.75'
    sort_by = id
    execute_on = 'initial timestep_end'
  []
[]

[BCs]
  [bc]
    type = DirichletBC
    variable = u
    boundary = 'left right top bottom front back'
    value = 0
  []
[]

[Executioner]
  type = Transient
  dt = 0.1
  num_steps = 3
  solve_type = 'PJFNK'
  nl_rel_tol = 1e-10
[]

[Outputs]
  csv = true
  execute_on = 'initial timestep_end'
[]

Overview
Example Input Syntax
Input Parameters