PlanarGeometricObject.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_PLANARGEOMETRICOBJECT_HPP_
#define GEOS_MESH_SIMPLEGEOMETRICOBJECTS_PLANARGEOMETRICOBJECT_HPP_
 
#include "SimpleGeometricObjectBase.hpp"
 
namespace geos
{
 
class PlanarGeometricObject : public SimpleGeometricObjectBase
{
public:
 
 
  PlanarGeometricObject( const string & name,
                         Group * const parent );
 
  virtual ~PlanarGeometricObject() override;
 
 
 
  static string catalogName() { return "PlanarGeometricObject"; }
 
 
  virtual bool isCoordInObject( real64 const ( &coord ) [3] ) const override = 0;
 
 
  R1Tensor & getNormal() {return m_normal;}
 
  R1Tensor const & getNormal() const {return m_normal;}
 
  R1Tensor & getWidthVector() {return m_widthVector;}
 
  R1Tensor const & getWidthVector() const {return m_widthVector;}
 
  R1Tensor & getLengthVector() {return m_lengthVector;}
 
  R1Tensor const & getLengthVector() const {return m_lengthVector;}
 
  virtual R1Tensor & getCenter() = 0;
 
  virtual R1Tensor const & getCenter() const = 0;
 
protected:
 
  R1Tensor m_normal;
  R1Tensor m_lengthVector;
  R1Tensor m_widthVector;
  real64 m_tolerance;
 
  static constexpr real64 orthoNormalBaseTolerance = 1e-10;
 
 
  struct viewKeyStruct
  {
    static constexpr char const * normalString() { return "normal"; }
    static constexpr char const * mLengthVectorString() { return "lengthVector"; }
    static constexpr char const * mWidthVectorString() { return "widthVector"; }
  };
 
 
};
} /* namespace geos */
 
#endif /* GEOS_MESH_SIMPLEGEOMETRICOBJECTS_PLANARGEOMETRICOBJECT_HPP_*/