KillRayBC

A RayBC that kills a Ray on a boundary.

The ray is killed by setting the Ray to not be continued:

void
KillRayBC::onBoundary(const unsigned int /* num_applying */)
{
  // After RayBCs are completed, ray->shouldContinue() is checked and this will kill the Ray
  currentRay()->setShouldContinue(false);
}

Input Parameters

boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies

Required Parameters

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

Advanced Parameters

(moose/modules/ray_tracing/src/raybcs/KillRayBC.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 "KillRayBC.h"

registerMooseObject("RayTracingApp", KillRayBC);

InputParameters
KillRayBC::validParams()
{
  auto params = GeneralRayBC::validParams();
  params.addClassDescription("A RayBC that kills a Ray on a boundary.");
  return params;
}

KillRayBC::KillRayBC(const InputParameters & params) : GeneralRayBC(params) {}

void
KillRayBC::onBoundary(const unsigned int /* num_applying */)
{
  // After RayBCs are completed, ray->shouldContinue() is checked and this will kill the Ray
  currentRay()->setShouldContinue(false);
}