QDRateAndStateBase.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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_PHYSICSSOLVERS_INDUCEDSEISMICITY_QDRATEANDSTATEBASE_HPP
#define GEOS_PHYSICSSOLVERS_INDUCEDSEISMICITY_QDRATEANDSTATEBASE_HPP
 
#include "physicsSolvers/PhysicsSolverBase.hpp"
 
namespace geos
{
 
class QDRateAndStateBase : public PhysicsSolverBase
{
public:
  QDRateAndStateBase() = delete;
 
  QDRateAndStateBase( const string & name,
                      Group * const parent );
 
  virtual ~QDRateAndStateBase() override;
 
  virtual void registerDataOnMesh( Group & meshBodies ) override;
 
  struct viewKeyStruct : public PhysicsSolverBase::viewKeyStruct
  {
    constexpr static char const * frictionLawNameString() { return "frictionLawName"; }
    constexpr static char const * shearImpedanceString() { return "shearImpedance"; }
  };
 
  void saveState( DomainPartition & domain ) const;
 
  void enforceRateAndVelocityConsistency( SurfaceElementSubRegion & subRegion ) const;
 
  virtual real64 updateStresses( real64 const & time_n,
                                 real64 const & dt,
                                 const int cycleNumber,
                                 DomainPartition & domain ) const = 0;
 
  virtual void applyInitialConditionsToFault( int const cycleNumber,
                                              DomainPartition & domain ) const;
 
protected:
 
  real64 m_shearImpedance;
};
 
} /* namespace geos */
 
#endif /* GEOS_PHYSICSSOLVERS_INDUCEDSEISMICTY_QDRATEANDSTATEBASE_HPP */