VariableIntegralRayKernel

Input Parameters

variableThe name of the variable to integrate
C++ Type:std::vector<VariableName>
Options:
Description:The name of the variable to integrate

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
depends_onOther RayKernels that this RayKernel depends on
C++ Type:std::vector<std::string>
Options:
Description:Other RayKernels that this RayKernel depends on
raysThe name of the Rays associated with this object; only used if Ray registration is enabled within the study. If no Rays are supplied, this object will be applied to all Rays.
C++ Type:std::vector<std::string>
Options:
Description:The name of the Rays associated with this object; only used if Ray registration is enabled within the study. If no Rays are supplied, this object will be applied to all Rays.
studyThe RayTracingStudy associated with this object. If none provided, this will default to the one study that exists.
C++ Type:UserObjectName
Options:
Description:The RayTracingStudy associated with this object. If none provided, this will default to the one study that exists.

Optional Parameters

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.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Options:
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
Options:
Description:The seed for the master random number generator

The integral performed along the value $var element = document.getElementById("moose-equation-31826601-fa15-4cbe-a284-e778c9721175");katex.render("u", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is

var element = document.getElementById("moose-equation-7d5e8d62-373a-4cf3-aa6a-6a1a89f291d3");katex.render("\\int_L u~dr, \\quad L = \\{\\vec{r}_1 + t\\vec{r}_2 \\mid t \\in [0, 1]\\}\\,,", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});

which is achieved by overriding computeQpIntegral, as:

Real
VariableIntegralRayKernel::computeQpIntegral()
{
  return _u[_qp];
}

The resulting integrated value can be obtained using a RayIntegralValue postprocessor.

Advanced Parameters

Input Parameters

variableThe name of the variable to integrate
C++ Type:std::vector<VariableName>
Options:
Description:The name of the variable to integrate

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
depends_onOther RayKernels that this RayKernel depends on
C++ Type:std::vector<std::string>
Options:
Description:Other RayKernels that this RayKernel depends on
raysThe name of the Rays associated with this object; only used if Ray registration is enabled within the study. If no Rays are supplied, this object will be applied to all Rays.
C++ Type:std::vector<std::string>
Options:
Description:The name of the Rays associated with this object; only used if Ray registration is enabled within the study. If no Rays are supplied, this object will be applied to all Rays.
studyThe RayTracingStudy associated with this object. If none provided, this will default to the one study that exists.
C++ Type:UserObjectName
Options:
Description:The RayTracingStudy associated with this object. If none provided, this will default to the one study that exists.

Optional Parameters

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.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Options:
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
Options:
Description:The seed for the master random number generator

Advanced Parameters

Input Files

(modules/ray_tracing/test/tests/outputs/ray_tracing_mesh_output/ray_mesh_output_data.i)
(modules/ray_tracing/test/tests/postprocessors/ray_integral_value/ray_integral_value_errors.i)
(modules/ray_tracing/test/tests/coord_type/rspherical_line_integral.i)
(modules/ray_tracing/test/tests/raykernels/variable_integral_ray_kernel/simple_diffusion_line_integral.i)
(modules/ray_tracing/test/tests/raykernels/variable_integral_ray_kernel/variable_integral_ray_kernel.i)
(modules/ray_tracing/test/tests/coord_type/rz_line_integral.i)
(modules/ray_tracing/test/tests/raykernels/variable_integral_ray_kernel/fv_simple_diffusion_line_integral.i)

(modules/ray_tracing/src/raykernels/VariableIntegralRayKernel.C)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#include "VariableIntegralRayKernel.h"

registerMooseObject("RayTracingApp", VariableIntegralRayKernel);

InputParameters
VariableIntegralRayKernel::validParams()
{
  InputParameters params = IntegralRayKernel::validParams();

  params.addClassDescription("Integrates a Variable or AuxVariable along a Ray.");

  params.addRequiredCoupledVar("variable", "The name of the variable to integrate");

  return params;
}

VariableIntegralRayKernel::VariableIntegralRayKernel(const InputParameters & params)
  : IntegralRayKernel(params), _u(coupledValue("variable"))
{
}

Real
VariableIntegralRayKernel::computeQpIntegral()
{
  return _u[_qp];
}

(modules/ray_tracing/test/tests/outputs/ray_tracing_mesh_output/ray_mesh_output_data.i)

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

[Variables/u]
  [InitialCondition]
    type = FunctionIC
    variable = u
    function = '(x < 2) * (x + 2 * y) + (x >= 2) * (2 * x + 2 * y - 2)'
  []
[]

[UserObjects]
  [study]
    type = RepeatableRayStudy
    names = 'diag
             top_across
             bottom_across
             partial'
    start_points = '0 0 0
                    0 5 0
                    0 0 0
                    0.5 0.5 0'
    end_points = '5 5 0
                  5 5 0
                  5 0 0
                  4.5 0.5 0'
    always_cache_traces = true
    data_on_cache_traces = true
    aux_data_on_cache_traces = true
    ray_aux_data_names = 'test_aux'
    initial_ray_aux_data = '1; 2; 3; 4'
  []
[]

[RayKernels]
  [variable_integral]
    type = VariableIntegralRayKernel
    study = study
    variable = u
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
  [rays]
    type = RayTracingExodus
    study = study
    output_data = true
    output_aux_data = true
    execute_on = final
  []
  [rays_nodal]
    type = RayTracingExodus
    study = study
    output_data_nodal = true
    execute_on = final
  []
[]

(modules/ray_tracing/test/tests/postprocessors/ray_integral_value/ray_integral_value_errors.i)

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

[AuxVariables/u]
[]

[UserObjects]
  active = 'repeatable'

  [repeatable]
    type = RepeatableRayStudy
    start_points = '0 0 0'
    directions = '1 0 0'
    names = ray
  []
  [lots]
    type = LotsOfRaysRayStudy
    ray_kernel_coverage_check = false
  []
  [no_banking_study]
    type = DisableRayBankingStudy
    start_points = '0 0 0'
    directions = '1 0 0'
    names = ray
  []
[]

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

[RayKernels]
  active = ''

  [null]
    type = NullRayKernel
  []
  [variable_integral]
    type = VariableIntegralRayKernel
    variable = u
  []
[]

[Postprocessors]
  active = ''

  [not_integral_ray_kernel]
    type = RayIntegralValue
    ray_kernel = null
    ray = ray
  []
  [kernel_not_found]
    type = RayIntegralValue
    ray_kernel = dummy
    ray = ray
  []
  [ray_not_found]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = dummy
  []
  [no_registration]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = dummy
  []
  [no_banking]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = dummy
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

(modules/ray_tracing/test/tests/coord_type/rspherical_line_integral.i)

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

[Variables/u]
[]

[BCs]
  [fixed]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Kernels]
  [diffusion]
    type = Diffusion
    variable = u
  []
  [source]
    type = BodyForce
    variable = u
    value = 10
  []
[]

[UserObjects]
  [study]
    type = RepeatableRayStudy
    names = 'ray0'
    start_points = '0 0 0'
    end_points = '1 0 0'
  []
[]

[RayKernels]
  [variable_integral]
    type = VariableIntegralRayKernel
    study = study
    variable = u
  []
[]

[Postprocessors]
  [value]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = ray0
  []
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Problem]
  coord_type = RSPHERICAL
[]

[Outputs]
  exodus = true
  csv = true
[]

(modules/ray_tracing/test/tests/raykernels/variable_integral_ray_kernel/simple_diffusion_line_integral.i)

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

[Variables/u]
[]

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

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

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = false
  csv = true
  [rays]
    type = RayTracingExodus
    study = study
    output_data = false # enable for data output
    output_data_nodal = false # enable for nodal data output
    execute_on = NONE # TIMESTEP_END for Ray mesh output
  []
[]

[UserObjects/study]
  type = RepeatableRayStudy
  names = 'diag
           right_up'
  start_points = '0 0 0
                  5 0 0'
  end_points = '5 5 0
                5 5 0'

  execute_on = TIMESTEP_END

  # Needed to cache trace information for RayTracingMeshOutput
  # always_cache_traces = true
  # Needed to cache Ray data for RayTracingMeshOutput
  # data_on_cache_traces = true
[]

[RayKernels/u_integral]
  type = VariableIntegralRayKernel
  variable = u
[]

[Postprocessors]
  [diag_line_integral]
    type = RayIntegralValue
    ray_kernel = u_integral
    ray = diag
  []
  [right_up_line_integral]
    type = RayIntegralValue
    ray_kernel = u_integral
    ray = right_up
  []
[]

(modules/ray_tracing/test/tests/raykernels/variable_integral_ray_kernel/variable_integral_ray_kernel.i)

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

[Variables/u]
  [InitialCondition]
    type = FunctionIC
    variable = u
    function = '(x < 2) * (x + 2 * y) + (x >= 2) * (2 * x + 2 * y - 2)'
  []
[]

[AuxVariables/aux]
  order = CONSTANT
  family = MONOMIAL
  [InitialCondition]
    type = FunctionIC
    variable = u_ag
    function = 'x + y + cos(x)'
  []
[]


[UserObjects]
  [study]
    type = RepeatableRayStudy
    names = 'diag
             top_across
             bottom_across
             partial'
    start_points = '0 0 0
                    0 5 0
                    0 0 0
                    0.5 0.5 0'
    end_points = '5 5 0
                  5 5 0
                  5 0 0
                  4.5 0.5 0'
  []
[]

[RayKernels]
  [variable_integral]
    type = VariableIntegralRayKernel
    study = study
    variable = u
  []
  [aux_variable_integral]
    type = VariableIntegralRayKernel
    study = study
    variable = aux
  []
[]

[Postprocessors]
  [diag_value]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = diag
  []
  [top_across_value]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = top_across
  []
  [bottom_across_value]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = bottom_across
  []
  [partial_value]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = partial
  []

  [aux_diag_value]
    type = RayIntegralValue
    ray_kernel = aux_variable_integral
    ray = diag
  []
  [aux_top_across_value]
    type = RayIntegralValue
    ray_kernel = aux_variable_integral
    ray = top_across
  []
  [aux_bottom_across_value]
    type = RayIntegralValue
    ray_kernel = aux_variable_integral
    ray = bottom_across
  []
  [aux_partial_value]
    type = RayIntegralValue
    ray_kernel = aux_variable_integral
    ray = partial
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = false
  csv = true
[]

(modules/ray_tracing/test/tests/coord_type/rz_line_integral.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 5
    ny = 2
    xmin = 0
    xmax = 2
    ymin = 0
    ymax = 1
  []
[]

[Variables/u]
[]

[BCs]
  [fixed]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Kernels]
  [diffusion]
    type = Diffusion
    variable = u
  []
  [source]
    type = BodyForce
    variable = u
    value = 10
  []
[]

[UserObjects]
  [study]
    type = RepeatableRayStudy
    names = 'ray0 ray1'
    start_points = '0 0.5 0
                    0 0.1 0'
    end_points = '2.0 0.5 0
                  2.0 0.9 0'
  []
[]

[RayKernels]
  [variable_integral]
    type = VariableIntegralRayKernel
    study = study
    variable = u
  []
[]

[Postprocessors]
  [ray0_value]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = ray0
  []
  [ray1_value]
    type = RayIntegralValue
    ray_kernel = variable_integral
    ray = ray1
  []
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Problem]
  coord_type = RZ
[]

[Outputs]
  exodus = true
  csv = true
[]

(modules/ray_tracing/test/tests/raykernels/variable_integral_ray_kernel/fv_simple_diffusion_line_integral.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  xmax = 10
  ymax = 10
[]

[Variables/v]
  family = MONOMIAL
  order = CONSTANT
  fv = true
[]

[FVKernels/diff]
  type = FVDiffusion
  variable = v
  coeff = coeff
[]

[FVBCs]
  [left]
    type = FVDirichletBC
    variable = v
    boundary = left
    value = 7
  []
  [right]
    type = FVDirichletBC
    variable = v
    boundary = right
    value = 42
  []
  [top_bottom]
    type = FVDirichletBC
    variable = v
    boundary = 'top bottom'
    value = 1
  []
[]

[Materials/diff]
  type = ADGenericConstantMaterial
  prop_names = 'coeff'
  prop_values = '1'
[]


[UserObjects/study]
  type = RepeatableRayStudy
  names = 'diag
           right_up'
  start_points = '0 0 0
                  10 0 0'
  end_points = '10 10 0
                10 10 0'
[]

[RayKernels/v_integral]
  type = VariableIntegralRayKernel
  study = study
  variable = v
[]

[Postprocessors]
  [diag_line_integral]
    type = RayIntegralValue
    ray_kernel = v_integral
    ray = diag
  []
  [right_up_line_integral]
    type = RayIntegralValue
    ray_kernel = v_integral
    ray = right_up
  []
[]

[Problem]
  kernel_coverage_check = false
[]

[Executioner]
  type = Steady
  solve_type = 'NEWTON'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  csv = true
  exodus = false
[]

Input Parameters
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

VariableIntegralRayKernel

Input Parameters

Required Parameters

Optional Parameters

Advanced Parameters

Input Parameters

Required Parameters

Optional Parameters

Advanced Parameters

Input Files