RayDataValue

Obtains a value from the data or aux data of a Ray after tracing has been completed.

A Ray in the Ray Tracing Module has the ability to locally store information that can be modified along the trace. This object enables convenient access to said data after the trace has completed.

Input Parameters

data_nameThe name of the data to extract from the Ray
C++ Type:std::string
Options:
Description:The name of the data to extract from the Ray
studyThe RayTracingStudy that owns the Ray
C++ Type:UserObjectName
Options:
Description:The RayTracingStudy that owns the Ray

Required Parameters

auxFalseWhether or not the data is an auxiliary value
Default:False
C++ Type:bool
Options:
Description:Whether or not the data is an auxiliary value
execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, TRANSFER
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
ray_idThe ID of the Ray to get the value from. This or 'ray_id' must be set.
C++ Type:unsigned long
Options:
Description:The ID of the Ray to get the value from. This or 'ray_id' must be set.
ray_nameName of the Ray to get the value from. This or 'ray_name' must be set.
C++ Type:std::string
Options:
Description:Name of the Ray to get the value from. This or 'ray_name' must be set.

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Options:
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
force_preauxFalseForces the GeneralUserObject to be executed in PREAUX
Default:False
C++ Type:bool
Options:
Description:Forces the GeneralUserObject to be executed in PREAUX
force_preicFalseForces the GeneralUserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Options:
Description:Forces the GeneralUserObject to be executed in PREIC during initial setup
outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Options:
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
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
Options:
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

Input Files

(modules/ray_tracing/test/tests/postprocessors/ray_data_value/ray_data_value.i)
(modules/ray_tracing/test/tests/raybcs/dependencies/ray_bc_dependencies.i)
(modules/ray_tracing/test/tests/raykernels/dependencies/ray_kernel_dependencies.i)
(modules/ray_tracing/test/tests/postprocessors/ray_data_value/ray_data_value_errors.i)

(modules/ray_tracing/test/tests/postprocessors/ray_data_value/ray_data_value.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 5
    ny = 5
    xmax = 5
    ymax = 5
  []
[]

[RayKernels/null]
  type = NullRayKernel
[]

[UserObjects/study]
  type = RepeatableRayStudy
  start_points = '0.5 0.5 0
                  2.5 2.5 0'
  end_points = '5 4.9 0
                0.1 0 0'
  names = 'ray0 ray1'
  ray_data_names = 'data0 data1'
  initial_ray_data = '1 2;
                      3 4'
  ray_aux_data_names = 'aux_data0 aux_data1'
  initial_ray_aux_data = '5 6;
                          7 8'
[]

[Postprocessors]
  [ray0_data0]
    type = RayDataValue
    study = study
    ray_name = ray0
    data_name = data0
  []
  [ray0_data1]
    type = RayDataValue
    study = study
    ray_name = ray0
    data_name = data1
  []
  [ray0_aux_data0]
    type = RayDataValue
    study = study
    ray_name = ray0
    data_name = aux_data0
    aux = true
  []
  [ray0_aux_data1]
    type = RayDataValue
    study = study
    ray_name = ray0
    data_name = aux_data1
    aux = true
  []

  # For ray1, we're betting on the fact that the IDs are assigned
  # in sequential order, therefore its ID should be 1. In reality,
  # you should rely on the name but this is just for testing purposes.
  [ray1_data0]
    type = RayDataValue
    study = study
    ray_id = 1
    data_name = data0
  []
  [ray1_data1]
    type = RayDataValue
    study = study
    ray_id = 1
    data_name = data1
  []
  [ray1_aux_data0]
    type = RayDataValue
    study = study
    ray_id = 1
    data_name = aux_data0
    aux = true
  []
  [ray1_aux_data1]
    type = RayDataValue
    study = study
    ray_id = 1
    data_name = aux_data1
    aux = true
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = false
  csv = true
[]

(modules/ray_tracing/test/tests/raybcs/dependencies/ray_bc_dependencies.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 1
  []
[]

[UserObjects/study]
  type = RepeatableRayStudy
  start_points = '0 0 0'
  directions = '1 0 0'
  names = ray
  ray_data_names = data
  initial_ray_data = 1
  ray_kernel_coverage_check = false
[]

[RayBCs]
  [add_1]
    type = ChangeRayRayBCTest
    boundary = right
    data_name = data
    add_value = 1
    depends_on = add_10
  []
  [scale_5]
    type = ChangeRayRayBCTest
    data_name = data
    boundary = right
    scale_value = 5
    depends_on = scale_9
  []
  [add_10]
    type = ChangeRayRayBCTest
    data_name = data
    boundary = right
    add_value = 10
  []
  [scale_9]
    type = ChangeRayRayBCTest
    data_name = data
    boundary = right
    scale_value = 9
    depends_on = add_1
  []
  [kill]
    type = KillRayBC
    boundary = right
  []
[]

[Postprocessors/value]
  type = RayDataValue
  study = study
  ray_name = ray
  data_name = data
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
[]

(modules/ray_tracing/test/tests/raykernels/dependencies/ray_kernel_dependencies.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 1
  []
[]

[UserObjects/study]
  type = RepeatableRayStudy
  start_points = '0 0 0'
  directions = '1 0 0'
  names = ray
  ray_data_names = data
  initial_ray_data = 1
[]

[RayBCs/kill]
  type = KillRayBC
  boundary = right
[]

[RayKernels]
  [add_1]
    type = ChangeRayRayKernelTest
    data_name = data
    add_value = 1
    depends_on = add_10
  []
  [scale_5]
    type = ChangeRayRayKernelTest
    data_name = data
    scale_value = 5
    depends_on = scale_9
  []
  [add_10]
    type = ChangeRayRayKernelTest
    data_name = data
    add_value = 10
  []
  [scale_9]
    type = ChangeRayRayKernelTest
    data_name = data
    scale_value = 9
    depends_on = add_1
  []
[]

[Postprocessors/value]
  type = RayDataValue
  study = study
  ray_name = ray
  data_name = data
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
[]

(modules/ray_tracing/test/tests/postprocessors/ray_data_value/ray_data_value_errors.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 1
  []
[]

[UserObjects]
  active = ''

  [lots]
    type = LotsOfRaysRayStudy
    vertex_to_vertex = false
    centroid_to_centroid = false
    centroid_to_vertex = false
    ray_kernel_coverage_check = false
  []
  [repeatable]
    type = RepeatableRayStudy
    start_points = '0 0 0'
    directions = '1 0 0'
    ray_data_names = data
    names = ray
    ray_kernel_coverage_check = false
  []
  [no_banking_study]
    type = DisableRayBankingStudy
    start_points = '0 0 0'
    directions = '1 0 0'
    ray_data_names = data
    names = ray
    ray_kernel_coverage_check = false
  []
[]

[RayBCs]
  active = ''
  [kill]
    type = KillRayBC
    boundary = right
  []
[]

[Postprocessors]
  active = ''

  [no_registration]
    type = RayDataValue
    study = lots
    ray_name = dummy
    data_name = dummy
  []
  [no_banking]
    type = RayDataValue
    study = no_banking_study
    ray_name = ray
    data_name = data
  []
  [ray_name_not_found]
    type = RayDataValue
    study = repeatable
    ray_name = dummy
    data_name = data
    execute_on = initial
  []
  [data_name_not_found]
    type = RayDataValue
    study = repeatable
    ray_name = ray
    data_name = dummy
    execute_on = initial
  []
  [aux_data_name_not_found]
    type = RayDataValue
    study = repeatable
    ray_name = ray
    data_name = dummy
    aux = true
    execute_on = initial
  []
  [id_not_found]
    type = RayDataValue
    study = repeatable
    ray_id = 1
    data_name = data
    execute_on = final
  []
  [neither_provided]
    type = RayDataValue
    study = repeatable
    data_name = data
    execute_on = initial
  []
  [both_provided]
    type = RayDataValue
    study = repeatable
    data_name = data
    ray_id = 0
    ray_name = dummy
    execute_on = initial
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

Input Parameters
Input Files

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access