HexagonalSubchannelBin.h

Go to the documentation of this file.

/********************************************************************/
/*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
/*                             Cardinal                             */
/*                                                                  */
/*                  (c) 2021 UChicago Argonne, LLC                  */
/*                        ALL RIGHTS RESERVED                       */
/*                                                                  */
/*                 Prepared by UChicago Argonne, LLC                */
/*               Under Contract No. DE-AC02-06CH11357               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*             Prepared by Battelle Energy Alliance, LLC            */
/*               Under Contract No. DE-AC07-05ID14517               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*                 See LICENSE for full restrictions                */
/********************************************************************/

#pragma once

#include "SpatialBinUserObject.h"
#include "HexagonalLatticeUtils.h"

class HexagonalSubchannelBin : public SpatialBinUserObject
{
public:
  static InputParameters validParams();

  HexagonalSubchannelBin(const InputParameters & parameters);

  virtual unsigned int bin(const Point & p) const override;

  virtual unsigned int num_bins() const override;

protected:
  const Real & _bundle_pitch;

  const Real & _pin_pitch;

  const Real & _pin_diameter;

  const unsigned int & _n_rings;

  const unsigned int _axis;

  const bool & _pin_centered_bins;

  std::unique_ptr<HexagonalLatticeUtils> _hex_lattice;
};