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
Controllable:No
Description:The name of the aux variable that this AuxRayKernel applies to

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
depends_onOther RayKernels that this RayKernel depends on
C++ Type:std::vector<std::string>
Controllable:No
Description:Other RayKernels that this RayKernel depends on
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.
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>
Controllable:No
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
Controllable:No
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>
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:No
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

Advanced Parameters

(moose/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);
}

Input Parameters