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 "IntegralRayKernelBase.h"
      13             : 
      14             : /**
      15             :  * Base class for a RayKernel that integrates along a Ray segment and stores the result in a scalar
      16             :  * value on the Ray
      17             :  */
      18             : class IntegralRayKernel : public IntegralRayKernelBase
      19             : {
      20             : public:
      21             :   IntegralRayKernel(const InputParameters & params);
      22             : 
      23             :   static InputParameters validParams();
      24             : 
      25             :   /**
      26             :    * Gets the name of the Ray data associated with the integral accumulated by this RayKernel
      27             :    */
      28         602 :   std::string integralRayDataName() const { return _name + "_value"; }
      29             : 
      30             :   void onSegment() override final;
      31             : 
      32             : protected:
      33             :   virtual Real computeQpIntegral() = 0;
      34             : 
      35             :   /// The index into the data on the Ray that this integral accumulates into
      36             :   const RayDataIndex _integral_data_index;
      37             : 
      38             :   /// Whether or not to compute the average (divide by the length)
      39             :   const bool _average;
      40             : };