AcousticWaveEquationSEM.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_PHYSICSSOLVERS_WAVEPROPAGATION_ACOUSTICWAVEEQUATIONSEM_HPP_
#define GEOS_PHYSICSSOLVERS_WAVEPROPAGATION_ACOUSTICWAVEEQUATIONSEM_HPP_
 
#include "physicsSolvers/wavePropagation/shared/WaveSolverBase.hpp"
#include "mesh/MeshFields.hpp"
#include "physicsSolvers/PhysicsSolverBase.hpp"
#include "physicsSolvers/wavePropagation/sem/acoustic/shared/AcousticFields.hpp"
#include "physicsSolvers/wavePropagation/shared/WaveSolverTypeDefSEM.hpp"
 
namespace geos
{
 
class AcousticWaveEquationSEM : public WaveSolverBase
{
public:
 
  using EXEC_POLICY = parallelDevicePolicy<  >;
  using ATOMIC_POLICY = AtomicPolicy< EXEC_POLICY >;
 
  AcousticWaveEquationSEM( const std::string & name,
                           Group * const parent );
 
  virtual ~AcousticWaveEquationSEM() override;
 
  AcousticWaveEquationSEM() = delete;
  AcousticWaveEquationSEM( AcousticWaveEquationSEM const & ) = delete;
  AcousticWaveEquationSEM( AcousticWaveEquationSEM && ) = default;
 
  AcousticWaveEquationSEM & operator=( AcousticWaveEquationSEM const & ) = delete;
  AcousticWaveEquationSEM & operator=( AcousticWaveEquationSEM && ) = delete;
 
  static string coupledSolverAttributePrefix() { return "acoustic"; }
 
  static string catalogName() { return "AcousticSEM"; }
  string getCatalogName() const override { return catalogName(); }
 
  virtual void initializePreSubGroups() override;
 
  virtual void registerDataOnMesh( Group & meshBodies ) override final;
 
 
  virtual real64 explicitStepForward( real64 const & time_n,
                                      real64 const & dt,
                                      integer const cycleNumber,
                                      DomainPartition & domain,
                                      integer const computeGradient ) override;
 
  virtual real64 explicitStepBackward( real64 const & time_n,
                                       real64 const & dt,
                                       integer const cycleNumber,
                                       DomainPartition & domain,
                                       integer const computeGradient ) override;
 
  virtual real32 getGlobalMinWavespeed( MeshLevel & mesh, string_array const & regionNames ) override;
 
  virtual void addSourceToRightHandSide( integer const & cycleNumber, arrayView1d< real32 > const rhs );
 
 
  virtual void initializePML() override;
 
  virtual real64 computeTimeStep( real64 & dtOut ) override;
 
 
 
  virtual void cleanup( real64 const time_n, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition & domain ) override;
 
  struct viewKeyStruct : WaveSolverBase::viewKeyStruct
  {
    static constexpr char const * pressureNp1AtReceiversString() { return "pressureNp1AtReceivers"; }
 
  } waveEquationViewKeys;
 
 
  real64 explicitStepInternal( real64 const & time_n,
                               real64 const & dt,
                               integer const & cycleNumber,
                               DomainPartition & domain );
 
  void computeUnknowns( real64 const & time_n,
                        real64 const & dt,
                        integer const & cycleNumber,
                        DomainPartition & domain,
                        MeshLevel & mesh,
                        string_array const & regionNames );
 
  void synchronizeUnknowns( real64 const & time_n,
                            real64 const & dt,
                            DomainPartition & domain,
                            MeshLevel & mesh,
                            string_array const & regionNames );
 
  void prepareNextTimestep( MeshLevel & mesh );
 
protected:
 
  virtual void postInputInitialization() override final;
 
  virtual void initializePostInitialConditionsPreSubGroups() override final;
 
private:
 
  virtual void precomputeSourceAndReceiverTerm( MeshLevel & baseMesh, MeshLevel & mesh, string_array const & regionNames ) override;
 
  virtual void applyFreeSurfaceBC( real64 const time, DomainPartition & domain ) override;
 
  virtual void applyPML( real64 const time, DomainPartition & domain ) override;
 
  array2d< real32 > m_pressureNp1AtReceivers;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_PHYSICSSOLVERS_WAVEPROPAGATION_ACOUSTICWAVEEQUATIONSEM_HPP_ */