CSGCartesianLattice.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "CSGLattice.h"

#ifdef MOOSE_UNIT_TEST
#include "gtest/gtest.h"
#endif

namespace CSG
{

class CSGCartesianLattice : public CSGLattice
{
public:
  CSGCartesianLattice(const std::string & name,
                      const Real pitch,
                      std::vector<std::vector<std::reference_wrapper<const CSGUniverse>>> universes,
                      const std::optional<OuterVariant> & outer = std::nullopt);

  CSGCartesianLattice(const std::string & name,
                      const Real pitch,
                      const std::optional<OuterVariant> & outer = std::nullopt);

  virtual ~CSGCartesianLattice() = default;

  std::unique_ptr<CSGLattice> clone() const override
  {
    return std::make_unique<CSGCartesianLattice>(*this);
  }

  virtual std::unordered_map<std::string, AttributeVariant> getAttributes() const override;

  virtual bool isValidIndex(const std::pair<int, int> index) const override;

  virtual bool isValidUniverseMap(
      std::vector<std::vector<std::reference_wrapper<const CSGUniverse>>> universes) const override;

  unsigned int getNRows() const { return _nrow; }

  unsigned int getNCols() const { return _ncol; }

  Real getPitch() const { return _pitch; }

  void setPitch(Real pitch);

protected:
  virtual bool compareAttributes(const CSGLattice & other) const override;

  virtual void setUniverses(
      std::vector<std::vector<std::reference_wrapper<const CSGUniverse>>> universes) override;

  Real _pitch;

  unsigned int _nrow;

  unsigned int _ncol;

  friend class CSGBase;

#ifdef MOOSE_UNIT_TEST
  FRIEND_TEST(CSGLatticeTest, testCartSetUniverses);
  FRIEND_TEST(CSGLatticeTest, testCartSetUniverseAtIndex);
  FRIEND_TEST(CSGLatticeTest, testEmptyToFilled);
  FRIEND_TEST(CSGLatticeTest, testCartLatticeEquality);
#endif
};
}