https://mooseframework.inl.gov
KillRayKernel.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "KillRayKernel.h"
11 
12 registerMooseObject("RayTracingApp", KillRayKernel);
13 
16 {
17  auto params = GeneralRayKernel::validParams();
18  params.addClassDescription("A RayKernel that kills a Ray.");
19  return params;
20 }
21 
23 
24 void
26 {
27  currentRay()->setShouldContinue(false);
28 }
const std::shared_ptr< Ray > & currentRay() const
Gets the current Ray that this is working on.
static InputParameters validParams()
A RayKernel that kills the Ray.
Definition: KillRayKernel.h:18
KillRayKernel(const InputParameters &params)
Definition: KillRayKernel.C:22
virtual void onSegment() override
Called on each segment of a Ray.
Definition: KillRayKernel.C:25
registerMooseObject("RayTracingApp", KillRayKernel)
static InputParameters validParams()
Definition: KillRayKernel.C:15