ReporterOffsetFunctionMaterial

Compute the sum of a function offset by a set of points.

This creates a material that is the sum of a function shifted by a set of points contained in a reporter. The reporter can contain points by specifying "point_name" or by three seperate reporters containing the (x,y,z) coordinates of the points using "x_coord_name", "y_coord_name", and "z_coord_name". This can be useful for creating a field containing multiple sources, as shown in Figure 1 and described in the equation below.

var element = document.getElementById("moose-equation-c4cddbc2-4f3a-43ee-83bc-717b16b53928");katex.render("\\tilde f(\\mathbf{x}) = \\sum_{i=1}^{n} \\left(f(\\mathbf{x} - \\mathbf{p}_{offset}) \\right)", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});

Figure 1: Field with multiple offsets of (left) gaussian function and (right) constant circle function.

Example Input File Syntax

In this example, ReporterOffsetFunctionMaterial is used to define the two materials shown in Figure 1. The value at a point is the sum of all the shifted functions. In this example, the gaussian and constant circle functions are defined at (x,y,z)=(0,0,0), shown by the source in the lower left corner of each domain. This function is then shifted according to the offset vectors given by the Reporter.

[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
  [multiple_sources]
    type = ReporterOffsetFunctionMaterial<<<{"description": "Compute the sum of a function offset by a set of points.", "href": "ReporterOffsetFunctionMaterial.html"}>>>
    property_name<<<{"description": "Material property base name"}>>> = 'multiple_funcs'
    x_coord_name<<<{"description": "Reporter with x-coordinate data."}>>> = 'constant/x'
    y_coord_name<<<{"description": "Reporter with y-coordinate data."}>>> = 'constant/y'
    z_coord_name<<<{"description": "Reporter with z-coordinate data."}>>> = 'constant/z'
    function<<<{"description": "The weighting function."}>>> = gauss
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = exodus
    output_properties<<<{"description": "List of material properties, from this material, to output (outputs must also be defined to an output type)"}>>> = multiple_funcs
  []
[]

Input Parameters

functionThe weighting function.
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The weighting function.
property_nameMaterial property base name
C++ Type:std::string
Controllable:No
Description:Material property base name

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
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Controllable:No
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Options:NONE, ELEMENT, SUBDOMAIN
Controllable:No
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared 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.
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

output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector<std::string>
Controllable:No
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

point_nameReporter with point data. /.
C++ Type:ReporterName
Controllable:No
Description:Reporter with point data. /.
x_coord_nameReporter with x-coordinate data.
C++ Type:ReporterName
Controllable:No
Description:Reporter with x-coordinate data.
y_coord_nameReporter with y-coordinate data.
C++ Type:ReporterName
Controllable:No
Description:Reporter with y-coordinate data.
z_coord_nameReporter with z-coordinate data.
C++ Type:ReporterName
Controllable:No
Description:Reporter with z-coordinate data.

Offset Locations For Function Evaluations 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

(modules/optimization/test/tests/optimizationreporter/reporter_offset/reporter_offset_mat.i)

(modules/optimization/test/tests/optimizationreporter/reporter_offset/reporter_offset_mat.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 100
    ny = 100

    xmax = 1
    ymax = 1
  []
[]
[Problem]
  solve = false
[]

[Materials]
  [multiple_sources]
    type = ReporterOffsetFunctionMaterial
    property_name = 'multiple_funcs'
    x_coord_name = 'constant/x'
    y_coord_name = 'constant/y'
    z_coord_name = 'constant/z'
    function = gauss
    outputs = exodus
    output_properties = multiple_funcs
  []
  [ad_multiple_sources]
    type = ADReporterOffsetFunctionMaterial
    property_name = 'ad_multiple_funcs'
    x_coord_name = 'constant/x'
    y_coord_name = 'constant/y'
    z_coord_name = 'constant/z'
    function = circle
    outputs = exodus
    output_properties = ad_multiple_funcs
  []

[]
[Reporters]
  [constant]
    type = ConstantReporter
    real_vector_names = 'x y z'
    real_vector_values = '0 0.25 0.5 0.45; 0 0.75 0.5 0.45; 0.0 0.0 0.0 0.0'
    execute_on = 'INITIAL'
  []
[]

[Functions]
  [gauss]
    type = ParsedFunction
    expression = 'exp(-2.0 *(x^2 + y^2 + z^2)/(beam_radii^2))'
    symbol_names = 'beam_radii'
    symbol_values = '0.1'
  []
  [circle]
    type = ParsedFunction
    expression = 'if(x^2 +y^2 +z^2< beam_radii^2,1,0)'
    symbol_names = 'beam_radii'
    symbol_values = '0.1'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
  execute_on = FINAL
[]

(modules/optimization/test/tests/optimizationreporter/reporter_offset/reporter_offset_mat.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 100
    ny = 100

    xmax = 1
    ymax = 1
  []
[]
[Problem]
  solve = false
[]

[Materials]
  [multiple_sources]
    type = ReporterOffsetFunctionMaterial
    property_name = 'multiple_funcs'
    x_coord_name = 'constant/x'
    y_coord_name = 'constant/y'
    z_coord_name = 'constant/z'
    function = gauss
    outputs = exodus
    output_properties = multiple_funcs
  []
  [ad_multiple_sources]
    type = ADReporterOffsetFunctionMaterial
    property_name = 'ad_multiple_funcs'
    x_coord_name = 'constant/x'
    y_coord_name = 'constant/y'
    z_coord_name = 'constant/z'
    function = circle
    outputs = exodus
    output_properties = ad_multiple_funcs
  []

[]
[Reporters]
  [constant]
    type = ConstantReporter
    real_vector_names = 'x y z'
    real_vector_values = '0 0.25 0.5 0.45; 0 0.75 0.5 0.45; 0.0 0.0 0.0 0.0'
    execute_on = 'INITIAL'
  []
[]

[Functions]
  [gauss]
    type = ParsedFunction
    expression = 'exp(-2.0 *(x^2 + y^2 + z^2)/(beam_radii^2))'
    symbol_names = 'beam_radii'
    symbol_values = '0.1'
  []
  [circle]
    type = ParsedFunction
    expression = 'if(x^2 +y^2 +z^2< beam_radii^2,1,0)'
    symbol_names = 'beam_radii'
    symbol_values = '0.1'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
  execute_on = FINAL
[]

Example Input File Syntax
Input Parameters
Input Files