SinglePhaseReservoirAndWells.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_MULTIPHYSICS_SINGLEPHASERESERVOIRANDWELLS_HPP_
#define GEOS_PHYSICSSOLVERS_MULTIPHYSICS_SINGLEPHASERESERVOIRANDWELLS_HPP_
 
#include "physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp"
#include "physicsSolvers/fluidFlow/SinglePhaseBase.hpp"
#include "physicsSolvers/fluidFlow/wells/SinglePhaseWell.hpp"
 
namespace geos
{
 
template< typename RESERVOIR_SOLVER = SinglePhaseBase >
class SinglePhaseReservoirAndWells : public CoupledReservoirAndWellsBase< RESERVOIR_SOLVER,
                                                                          SinglePhaseWell >
{
public:
 
  using Base = CoupledReservoirAndWellsBase< RESERVOIR_SOLVER,
                                             SinglePhaseWell >;
  using Base::m_solvers;
  using Base::m_linearSolverParameters;
 
  SinglePhaseReservoirAndWells( const string & name,
                                dataRepository::Group * const parent );
 
  virtual ~SinglePhaseReservoirAndWells() override;
 
  static string catalogName()
  {
    if constexpr (std::is_same_v< RESERVOIR_SOLVER, SinglePhaseBase > ) // special case
    {
      return "SinglePhaseReservoir";
    }
    else // default
    {
      return RESERVOIR_SOLVER::catalogName() + "Reservoir";
    }
  }
 
  string getCatalogName() const override { return catalogName(); }
 
  virtual void addCouplingSparsityPattern( DomainPartition const & domain,
                                           DofManager const & dofManager,
                                           SparsityPatternView< globalIndex > const & pattern ) const override;
 
  virtual void assembleCouplingTerms( real64 const time_n,
                                      real64 const dt,
                                      DomainPartition const & domain,
                                      DofManager const & dofManager,
                                      CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                      arrayView1d< real64 > const & localRhs ) override;
 
  void
  assembleHydrofracFluxTerms( real64 const time_n,
                              real64 const dt,
                              DomainPartition const & domain,
                              DofManager const & dofManager,
                              CRSMatrixView< real64, globalIndex const > const & localMatrix,
                              arrayView1d< real64 > const & localRhs,
                              CRSMatrixView< real64, localIndex const > const & dR_dAper )
  { flowSolver()->assembleHydrofracFluxTerms( time_n, dt, domain, dofManager, localMatrix, localRhs, dR_dAper ); }
 
  template< typename SUBREGION_TYPE >
  void accumulationAssemblyLaunch( DofManager const & dofManager,
                                   SUBREGION_TYPE const & subRegion,
                                   CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                   arrayView1d< real64 > const & localRhs )
  { flowSolver()->accumulationAssemblyLaunch( dofManager, subRegion, localMatrix, localRhs ); }
 
  void prepareStencilWeights( DomainPartition & domain ) const
  { flowSolver()->prepareStencilWeights( domain ); }
  void updateStencilWeights( DomainPartition & domain ) const
  { flowSolver()->updateStencilWeights( domain ); }
 
  void updateMass( CellElementSubRegion & subRegion ) const
  { flowSolver()->updateMass( subRegion ); }
 
protected:
 
  virtual void initializePreSubGroups() override;
 
  virtual void setMGRStrategy() override
  {
    if( this->m_linearSolverParameters.get().preconditionerType == LinearSolverParameters::PreconditionerType::mgr )
      GEOS_ERROR( GEOS_FMT( "{}: MGR strategy is not implemented for {}", this->getName(), this->getCatalogName()));
  }
 
private:
 
  SinglePhaseBase * flowSolver() const;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_PHYSICSSOLVERS_MULTIPHYSICS_SINGLEPHASERESERVOIRANDWELLS_HPP_ */