- boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
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);
}
(moose/modules/ray_tracing/src/raybcs/KillRayBC.C)Input Parameters
- depends_onOther RayBCs that this RayBC depends on
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.