Line data    Source code

       1             : /********************************************************************/
       2             : /*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
       3             : /*                             Cardinal                             */
       4             : /*                                                                  */
       5             : /*                  (c) 2021 UChicago Argonne, LLC                  */
       6             : /*                        ALL RIGHTS RESERVED                       */
       7             : /*                                                                  */
       8             : /*                 Prepared by UChicago Argonne, LLC                */
       9             : /*               Under Contract No. DE-AC02-06CH11357               */
      10             : /*                With the U. S. Department of Energy               */
      11             : /*                                                                  */
      12             : /*             Prepared by Battelle Energy Alliance, LLC            */
      13             : /*               Under Contract No. DE-AC07-05ID14517               */
      14             : /*                With the U. S. Department of Energy               */
      15             : /*                                                                  */
      16             : /*                 See LICENSE for full restrictions                */
      17             : /********************************************************************/
      18             : 
      19             : #pragma once
      20             : 
      21             : #include "ParallelParamObject.h"
      22             : 
      23             : #include "CardinalEnums.h"
      24             : 
      25           0 : class EnergyBinBase
      26             : {
      27             : public:
      28             :   static InputParameters validParams();
      29             : 
      30             :   EnergyBinBase(const ParallelParamObject * moose_object, const InputParameters & parameters);
      31             : 
      32             :   /**
      33             :    * A function which converts a GroupStructureEnum into the vector representation of the group
      34             :    * structure.
      35             :    * @param[in] group_structure the requested group structure
      36             :    * @return the energy gruop boundaries
      37             :    */
      38             :   std::vector<double> getGroupBoundaries(energyfilter::GroupStructureEnum group_structure);
      39             : 
      40             : protected:
      41             :   /// The energy bounds used to build bins.
      42             :   std::vector<Real> _energy_bnds;
      43             : 
      44             :   /// Whether or not to reverse the ordering of energy bins during output.
      45             :   const bool _reverse_bins;
      46             : };