Line data    Source code

       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             : 
      19             : /**
      20             :  * Obtains a Ray data or aux data value from a banked ray.
      21             :  */
      22             : class RayDataValue : public GeneralPostprocessor
      23             : {
      24             : public:
      25             :   static InputParameters validParams();
      26             : 
      27             :   RayDataValue(const InputParameters & parameters);
      28             : 
      29             :   virtual void initialize() override;
      30         144 :   virtual void execute() override {}
      31             : 
      32             :   virtual Real getValue() const override;
      33             : 
      34             : protected:
      35             :   /// The RayTracingStudy
      36             :   const RayTracingStudy & _study;
      37             : 
      38             :   /// Whether or not to get auxiliary data (if false, get standard data)
      39             :   const bool _aux;
      40             : 
      41             :   /// The provided Ray name (if any)
      42             :   const std::string * const _ray_name;
      43             :   /// The provided Ray ID (if any)
      44             :   const RayID * const _ray_id;
      45             : 
      46             : private:
      47             :   /// The index into the Ray's data that the desired RayVariable is at
      48             :   unsigned int _ray_data_index;
      49             : };