CSGSurface.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
 
#ifdef MOOSE_UNIT_TEST
#include "gtest/gtest.h"
#endif
 
#include "MooseApp.h"
#include "CSGTransformationHelper.h"
 
namespace CSG
{
 
class CSGSurface : public CSGTransformationHelper
{
public:
  enum class Halfspace
  {
    POSITIVE,
    NEGATIVE
  };
 
  CSGSurface(const std::string & name);
 
  virtual ~CSGSurface() = default;
 
  const std::string getSurfaceType() const
  {
    return MooseUtils::prettyCppType(libMesh::demangle(typeid(*this).name()));
  }
 
  virtual std::unordered_map<std::string, Real> getCoeffs() const = 0; // Pure virtual function
 
  virtual Real evaluateSurfaceEquationAtPoint(const Point & p) const = 0; // Pure virtual function
 
  CSGSurface::Halfspace getHalfspaceFromPoint(const Point & p) const;
 
  const std::string & getName() const { return _name; }
 
  virtual bool isEngUnit() const { return false; }
 
  bool operator==(const CSGSurface & other) const;
 
  bool operator!=(const CSGSurface & other) const;
 
protected:
  virtual std::unique_ptr<CSGSurface> clone() const = 0; // Pure virtual function
 
  // set the name of the surface - intentionally not public because
  // name needs to be managed at the CSGSurfaceList level
  void setName(const std::string & name) { _name = name; }
 
  std::string _name;
 
  // CSGSurfaceList needs to be friend to access setName()
  friend class CSGSurfaceList;
  friend class CSGBase; // needed for addTransformation() access
 
#ifdef MOOSE_UNIT_TEST
  FRIEND_TEST(CSGSurfaceTest, testSetName);
  FRIEND_TEST(CSGSurfaceTest, testSurfaceEquality);
#endif
};
} // namespace CSG