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