Cylinder.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_MESH_SIMPLEGEOMETRICOBJECTS_CYLINDER_HPP_
#define GEOS_MESH_SIMPLEGEOMETRICOBJECTS_CYLINDER_HPP_
 
#include "SimpleGeometricObjectBase.hpp"
 
namespace geos
{
 
class Cylinder : public SimpleGeometricObjectBase
{
public:
 
 
  Cylinder( const string & name,
            Group * const parent );
 
  virtual ~Cylinder() override;
 
 
 
  static string catalogName() { return "Cylinder"; }
 
 
  bool isCoordInObject( real64 const ( &coord ) [3] ) const override final;
 
 
  struct viewKeyStruct
  {
    static constexpr char const * point1String() { return "firstFaceCenter"; }
    static constexpr char const * point2String() { return "secondFaceCenter"; }
    static constexpr char const * radiusString() { return "outerRadius"; }
    static constexpr char const * innerRadiusString() { return "innerRadius"; }
  };
 
 
private:
 
  R1Tensor m_point1;
 
  R1Tensor m_point2;
 
  real64 m_radius = 0.0;
 
  real64 m_innerRadius = 0.0;
 
};
} /* namespace geos */
 
#endif /* GEOS_MESH_SIMPLEGEOMETRICOBJECTS_CYLINDER_HPP_
        */