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.

An example of a ReporterPointSource using a ConstantReporter and a VectorPostrocessor of type CSVReader is given by:

[reporter_point_source]
  type = ReporterPointSource
  variable = u
  value_name = 'reporterData2/u2'
  x_coord_name = 'reporterData1/x'
  y_coord_name = 'reporterData1/y'
  z_coord_name = 'reporterData1/z'
[]

where the reporter data is taken from two different reporters (e.g. the coordinates from reporterData1 and the values come from reporterData2) The two ConstantReporters are given as:

[Reporters]
  [reporterData1]
    type = ConstantReporter
    real_vector_names = 'x y z u'
    real_vector_values = '0.2 0.2 0.0; 0.3 0.8 0.0; 0 0 0; 5 5 5'
  []
  [reporterData2]
    type = ConstantReporter
    real_vector_names = 'x2 y2 z2 u2'
    real_vector_values = '0.2 0.2; 0.3 0.8 0.0; 0 0 0; 1 -.5 0'
  []
[]

The CSVReader VectorPostrocessor 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 VectorPostrocessor 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

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

note

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

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
Controllable:No
Description:The name of the variable that this residual object operates on
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 /.

Required Parameters

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_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.
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
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.

Optional 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.
drop_duplicate_pointsTrueBy default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.
Default:True
C++ Type:bool
Controllable:No
Description:By default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.
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

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

Tagging Parameters

(../../../SoftwareDownloads/moose/test/tests/dirackernels/reporter_point_source/2d_vpp.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
  uniform_refine = 4
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []
[]

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

[DiracKernels]
  inactive = 'reporter_point_source_err'
  [vpp_point_source]
    type = ReporterPointSource
    variable = u
    value_name = 'csv_reader/u'
    x_coord_name = 'csv_reader/x'
    y_coord_name = 'csv_reader/y'
    z_coord_name = 'csv_reader/z'
  []
  [reporter_point_source]
    type = ReporterPointSource
    variable = u
    value_name = 'reporterData2/u2'
    x_coord_name = 'reporterData1/x'
    y_coord_name = 'reporterData1/y'
    z_coord_name = 'reporterData1/z'
  []
  [reporter_point_source_err]
    type = ReporterPointSource
    variable = u
    value_name = 'reporterData2/u2'
    x_coord_name = 'reporterData2/x2'
    y_coord_name = 'reporterData1/y'
    z_coord_name = 'reporterData1/z'
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = 3
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = 1
    value = 1
  []
[]

[VectorPostprocessors]
  [csv_reader]
    type = CSVReader
    csv_file = point_value_file.csv
  []
[]

[Reporters]
  [reporterData1]
    type = ConstantReporter
    real_vector_names = 'x y z u'
    real_vector_values = '0.2 0.2 0.0; 0.3 0.8 0.0; 0 0 0; 5 5 5'
  []
  [reporterData2]
    type = ConstantReporter
    real_vector_names = 'x2 y2 z2 u2'
    real_vector_values = '0.2 0.2; 0.3 0.8 0.0; 0 0 0; 1 -.5 0'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
[]

[Outputs]
  exodus = true
[]

(../../../SoftwareDownloads/moose/test/tests/dirackernels/reporter_point_source/2d_vpp.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
  uniform_refine = 4
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []
[]

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

[DiracKernels]
  inactive = 'reporter_point_source_err'
  [vpp_point_source]
    type = ReporterPointSource
    variable = u
    value_name = 'csv_reader/u'
    x_coord_name = 'csv_reader/x'
    y_coord_name = 'csv_reader/y'
    z_coord_name = 'csv_reader/z'
  []
  [reporter_point_source]
    type = ReporterPointSource
    variable = u
    value_name = 'reporterData2/u2'
    x_coord_name = 'reporterData1/x'
    y_coord_name = 'reporterData1/y'
    z_coord_name = 'reporterData1/z'
  []
  [reporter_point_source_err]
    type = ReporterPointSource
    variable = u
    value_name = 'reporterData2/u2'
    x_coord_name = 'reporterData2/x2'
    y_coord_name = 'reporterData1/y'
    z_coord_name = 'reporterData1/z'
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = 3
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = 1
    value = 1
  []
[]

[VectorPostprocessors]
  [csv_reader]
    type = CSVReader
    csv_file = point_value_file.csv
  []
[]

[Reporters]
  [reporterData1]
    type = ConstantReporter
    real_vector_names = 'x y z u'
    real_vector_values = '0.2 0.2 0.0; 0.3 0.8 0.0; 0 0 0; 5 5 5'
  []
  [reporterData2]
    type = ConstantReporter
    real_vector_names = 'x2 y2 z2 u2'
    real_vector_values = '0.2 0.2; 0.3 0.8 0.0; 0 0 0; 1 -.5 0'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
[]

[Outputs]
  exodus = true
[]

(../../../SoftwareDownloads/moose/test/tests/dirackernels/reporter_point_source/2d_vpp.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
  uniform_refine = 4
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []
[]

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

[DiracKernels]
  inactive = 'reporter_point_source_err'
  [vpp_point_source]
    type = ReporterPointSource
    variable = u
    value_name = 'csv_reader/u'
    x_coord_name = 'csv_reader/x'
    y_coord_name = 'csv_reader/y'
    z_coord_name = 'csv_reader/z'
  []
  [reporter_point_source]
    type = ReporterPointSource
    variable = u
    value_name = 'reporterData2/u2'
    x_coord_name = 'reporterData1/x'
    y_coord_name = 'reporterData1/y'
    z_coord_name = 'reporterData1/z'
  []
  [reporter_point_source_err]
    type = ReporterPointSource
    variable = u
    value_name = 'reporterData2/u2'
    x_coord_name = 'reporterData2/x2'
    y_coord_name = 'reporterData1/y'
    z_coord_name = 'reporterData1/z'
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = 3
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = 1
    value = 1
  []
[]

[VectorPostprocessors]
  [csv_reader]
    type = CSVReader
    csv_file = point_value_file.csv
  []
[]

[Reporters]
  [reporterData1]
    type = ConstantReporter
    real_vector_names = 'x y z u'
    real_vector_values = '0.2 0.2 0.0; 0.3 0.8 0.0; 0 0 0; 5 5 5'
  []
  [reporterData2]
    type = ConstantReporter
    real_vector_names = 'x2 y2 z2 u2'
    real_vector_values = '0.2 0.2; 0.3 0.8 0.0; 0 0 0; 1 -.5 0'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
[]

[Outputs]
  exodus = true
[]

(../../../SoftwareDownloads/moose/test/tests/dirackernels/reporter_point_source/point_value_file.csv)

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

(../../../SoftwareDownloads/moose/test/tests/dirackernels/reporter_point_source/2d_vpp_transient.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
  uniform_refine = 4
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []
[]

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

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

[VectorPostprocessors]
  [point_sample_source]
    type = PointValueSampler
    variable = u
    points = '0.2 0.8 0.0  0.2 0.2 0.0'
    sort_by = id
    execute_on = 'timestep_begin'
    outputs = none
  []
  [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'
  []
[]

[Functions]
  [left_bc_fn]
    type = ParsedFunction
    value = 1+5*y*y
  []
[]

[BCs]
  [left]
    type = FunctionNeumannBC
    variable = u
    boundary = left
    function = left_bc_fn
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

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

[Outputs]
  csv = true
[]

(../../../SoftwareDownloads/moose/test/tests/dirackernels/reporter_point_source/2d_vpp_transient.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
  uniform_refine = 4
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []
[]

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

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

[VectorPostprocessors]
  [point_sample_source]
    type = PointValueSampler
    variable = u
    points = '0.2 0.8 0.0  0.2 0.2 0.0'
    sort_by = id
    execute_on = 'timestep_begin'
    outputs = none
  []
  [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'
  []
[]

[Functions]
  [left_bc_fn]
    type = ParsedFunction
    value = 1+5*y*y
  []
[]

[BCs]
  [left]
    type = FunctionNeumannBC
    variable = u
    boundary = left
    function = left_bc_fn
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

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

[Outputs]
  csv = true
[]

Input Parameters