https://mooseframework.inl.gov
Loading...
Searching...
No Matches
RayDataValue.h
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#pragma once
11
13
14#include "Ray.h"
15
16// Forward declarations
17class RayTracingStudy;
18
23{
24public:
26
28
29 virtual void initialize() override;
30 virtual void execute() override {}
31
32 virtual Real getValue() const override;
33
34protected:
37
39 const bool _aux;
40
42 const std::string * const _ray_name;
44 const RayID * const _ray_id;
45
46private:
48 unsigned int _ray_data_index;
49};
unsigned long int RayID
Type for a Ray's ID.
Definition Ray.h:44
const InputParameters & parameters() const
Obtains a Ray data or aux data value from a banked ray.
virtual Real getValue() const override
static InputParameters validParams()
virtual void initialize() override
const RayID *const _ray_id
The provided Ray ID (if any)
const RayTracingStudy & _study
The RayTracingStudy.
unsigned int _ray_data_index
The index into the Ray's data that the desired RayVariable is at.
virtual void execute() override
const bool _aux
Whether or not to get auxiliary data (if false, get standard data)
const std::string *const _ray_name
The provided Ray name (if any)
Base class for Ray tracing studies that will generate Rays and then propagate all of them to terminat...