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 "FilterBase.h" 22 : 23 : /** 24 : * A class which provides a thin wrapper around an OpenMC SphericalHarmonicsFilter 25 : * for use by Cardinal mapped tallies. 26 : */ 27 : class SphericalHarmonicsFilter : public FilterBase 28 : { 29 : public: 30 : static InputParameters validParams(); 31 : 32 : SphericalHarmonicsFilter(const InputParameters & parameters); 33 : 34 : /// Override to return false on the first bin and true on all other bins. 35 160 : virtual bool skipBin(const unsigned int bin) const override { return bin != 0; } 36 : 37 : /** 38 : * A function which returns the short-form name for each bin of 39 : * this filter. Used to label auxvariables a TallyBase scores in. 40 : * SphericalHarmonicsFilter(s) use l_mpos for m >= 0, and l_mneg for 41 : * m < 0. 42 : * @param[in] the bin index 43 : * @return a short name for the bin represented by bin_index 44 : */ 45 : virtual std::string binName(unsigned int bin_index) const override; 46 : 47 : protected: 48 : /// The spherical harmonics order. 49 : const unsigned int _order; 50 : };