RayDistanceAux

Accumulates the distance traversed by each Ray segment into an aux variable for the element that the segments are in.

The accumulation is achieved by overriding onSegment and appending into the AuxVariable via addValue(), as:

void
RayDistanceAux::onSegment()
{
  addValue(_current_segment_length);
}

Input Parameters

variableThe name of the aux variable that this AuxRayKernel applies to
C++ Type:AuxVariableName
Options:
Description:The name of the aux variable that this AuxRayKernel applies to

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/raykernels/aux_ray_kernel/const_monomial_only.i)
(modules/ray_tracing/test/tests/raykernels/ray_distance_aux/ray_distance_aux.i)

(modules/ray_tracing/src/raykernels/RayDistanceAux.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 "RayDistanceAux.h"

registerMooseObject("RayTracingApp", RayDistanceAux);

InputParameters
RayDistanceAux::validParams()
{
  auto params = AuxRayKernel::validParams();
  params.addClassDescription("Accumulates the distance traversed by each Ray segment into an aux "
                             "variable for the element that the segments are in.");
  return params;
}

RayDistanceAux::RayDistanceAux(const InputParameters & params) : AuxRayKernel(params) {}

void
RayDistanceAux::onSegment()
{
  addValue(_current_segment_length);
}

(modules/ray_tracing/test/tests/raykernels/aux_ray_kernel/const_monomial_only.i)

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

[UserObjects/study]
  type = RepeatableRayStudy
  start_points = '0 0 0'
  directions = '1 0 0'
  names = 'ray'
  execute_on = INITIAL
[]

[AuxVariables/aux]
[]

[RayKernels/distance]
  type = RayDistanceAux
  variable = aux
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

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

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

[AuxVariables/distance]
  order = CONSTANT
  family = MONOMIAL
[]

[RayKernels/distance]
  type = RayDistanceAux
  variable = distance
[]

[UserObjects/study]
  type = LotsOfRaysRayStudy
  vertex_to_vertex = false
  centroid_to_vertex = false
  centroid_to_centroid = true
  execute_on = initial
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[Outputs]
  exodus = true
[]

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