PerfectlyMatchedLayer.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 Total, S.A
 * 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.
 * ------------------------------------------------------------------------------------------------------------
 */
 
/*
 * PerfectlyMatchedLayer.hpp
 *
 */
 
#ifndef GEOS_FIELDSPECIFICATION_PERFECTLYMATCHEDLAYER_HPP_
#define GEOS_FIELDSPECIFICATION_PERFECTLYMATCHEDLAYER_HPP_
 
#include "FieldSpecificationBase.hpp"
 
namespace geos
{
 
class PerfectlyMatchedLayer : public FieldSpecificationBase
{
public:
  PerfectlyMatchedLayer( string const & name, dataRepository::Group * const parent );
 
  PerfectlyMatchedLayer() = delete;
 
  virtual ~PerfectlyMatchedLayer() = default;
 
  static string catalogName() { return "PML"; }
 
  R1Tensor32 getMin() const { return m_xMin; }
 
  R1Tensor32 getMax() const { return m_xMax; }
 
  real64 getReflectivity() const { return m_reflectivity; }
 
  R1Tensor32 getThicknessMinXYZ() const { return m_thicknessMinXYZ; }
 
  R1Tensor32 getThicknessMaxXYZ() const { return m_thicknessMaxXYZ; }
 
  R1Tensor32 getWaveSpeedMinXYZ() const { return m_waveSpeedMinXYZ; }
 
  R1Tensor32 getWaveSpeedMaxXYZ() const { return m_waveSpeedMaxXYZ; }
 
  struct viewKeyStruct : public FieldSpecificationBase::viewKeyStruct
  {
    static constexpr char const * xMinString() { return "xMin"; }
 
    static constexpr char const * xMaxString() { return "xMax"; }
 
    static constexpr char const * reflectivityString() { return "reflectivity"; }
 
    static constexpr char const * thicknessMinXYZString() { return "thicknessMinXYZ"; }
 
    static constexpr char const * thicknessMaxXYZString() { return "thicknessMaxXYZ"; }
 
    static constexpr char const * waveSpeedMinXYZString() { return "waveSpeedMinXYZ"; }
 
    static constexpr char const * waveSpeedMaxXYZString() { return "waveSpeedMaxXYZ"; }
 
  };
 
  static constexpr real64 minThickness = 0.001;
 
  static constexpr real64 smallestXMin = -999999.0;
 
  static constexpr real64 largestXMax = 999999.0;
 
protected:
 
  virtual void postInputInitialization() override final;
 
private:
 
  R1Tensor32 m_xMin;
 
  R1Tensor32 m_xMax;
 
  real32 m_reflectivity;
 
  R1Tensor32 m_thicknessMinXYZ;
  R1Tensor32 m_thicknessMaxXYZ;
 
  R1Tensor32 m_waveSpeedMinXYZ;
  R1Tensor32 m_waveSpeedMaxXYZ;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_FIELDSPECIFICATION_PERFECTLYMATCHEDLAYER_HPP_ */