CompositionalMultiphaseReservoirAndWells.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_COMPOSITIONALMULTIPHASERESERVOIRANDWELLS_HPP_
#define GEOS_PHYSICSSOLVERS_MULTIPHYSICS_COMPOSITIONALMULTIPHASERESERVOIRANDWELLS_HPP_
 
#include "physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp"
#include "physicsSolvers/fluidFlow/CompositionalMultiphaseBase.hpp"
#include "physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.hpp"
 
namespace geos
{
 
template< typename RESERVOIR_SOLVER = CompositionalMultiphaseBase >
class CompositionalMultiphaseReservoirAndWells : public CoupledReservoirAndWellsBase< RESERVOIR_SOLVER,
                                                                                      CompositionalMultiphaseWell >
{
public:
 
  using Base = CoupledReservoirAndWellsBase< RESERVOIR_SOLVER,
                                             CompositionalMultiphaseWell >;
  using Base::getLogLevel;
  using Base::m_solvers;
  using Base::m_linearSolverParameters;
 
  CompositionalMultiphaseReservoirAndWells( const string & name,
                                            dataRepository::Group * const parent );
 
  virtual ~CompositionalMultiphaseReservoirAndWells() override;
 
  static string catalogName()
  {
    if constexpr (std::is_same_v< RESERVOIR_SOLVER, CompositionalMultiphaseBase > ) // special case
    {
      return "CompositionalMultiphaseReservoir";
    }
    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;
  integer isThermal() { return flowSolver()->isThermal(); }
  integer useSimpleAccumulation() const { return flowSolver()->useSimpleAccumulation(); }
  integer useTotalMassEquation() const { return flowSolver()->useTotalMassEquation(); }
  integer numFluidPhases() { return flowSolver()->numFluidPhases(); }
  integer numFluidComponents() { return flowSolver()->numFluidComponents(); }
 
protected:
 
  virtual void initializePreSubGroups() override;
 
  virtual void setMGRStrategy() override;
 
private:
 
  CompositionalMultiphaseBase * flowSolver() const;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_PHYSICSSOLVERS_MULTIPHYSICS_COMPOSITIONALMULTIPHASERESERVOIRANDWELLS_HPP_ */