CompositionalMultiphaseWell.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_FLUIDFLOW_WELLS_COMPOSITIONALMULTIPHASEWELL_HPP_
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_COMPOSITIONALMULTIPHASEWELL_HPP_
 
#include "common/DataTypes.hpp"
#include "constitutive/fluid/multifluid/Layouts.hpp"
#include "constitutive/relativePermeability/Layouts.hpp"
#include "mesh/MeshLevel.hpp"
#include "physicsSolvers/fluidFlow/wells/WellSolverBase.hpp"
#include "physicsSolvers/fluidFlow/CompositionalMultiphaseBase.hpp"
 
namespace geos
{
 
namespace constitutive
{
class ConstitutiveManager;
class MultiFluidBase;
}
 
namespace compositionalMultiphaseStatistics
{
class StatsAggregator;
}
 
class CompositionalMultiphaseWell : public WellSolverBase
{
public:
 
  CompositionalMultiphaseWell( const string & name,
                               Group * const parent );
 
  CompositionalMultiphaseWell() = delete;
 
  CompositionalMultiphaseWell( CompositionalMultiphaseWell const & ) = delete;
 
  CompositionalMultiphaseWell( CompositionalMultiphaseWell && ) = default;
 
  CompositionalMultiphaseWell & operator=( CompositionalMultiphaseWell const & ) = delete;
 
  CompositionalMultiphaseWell & operator=( CompositionalMultiphaseWell && ) = delete;
 
  virtual ~CompositionalMultiphaseWell() override = default;
 
  static string catalogName() { return "CompositionalMultiphaseWell"; }
  string getCatalogName() const override { return catalogName(); }
 
  virtual void registerDataOnMesh( Group & meshBodies ) override;
 
 
  virtual real64
  calculateResidualNorm( real64 const & time_n,
                         real64 const & dt,
                         DomainPartition const & domain,
                         DofManager const & dofManager,
                         arrayView1d< real64 const > const & localRhs ) override;
 
  virtual real64
  scalingForSystemSolution( DomainPartition & domain,
                            DofManager const & dofManager,
                            arrayView1d< real64 const > const & localSolution ) override;
 
  virtual bool
  checkSystemSolution( DomainPartition & domain,
                       DofManager const & dofManager,
                       arrayView1d< real64 const > const & localSolution,
                       real64 const scalingFactor ) override;
 
  virtual void
  applySystemSolution( DofManager const & dofManager,
                       arrayView1d< real64 const > const & localSolution,
                       real64 const scalingFactor,
                       real64 const dt,
                       DomainPartition & domain ) override;
 
  virtual void
  resetStateToBeginningOfStep( DomainPartition & domain ) override;
 
  virtual void
  implicitStepSetup( real64 const & time,
                     real64 const & dt,
                     DomainPartition & domain ) override;
 
  virtual void
  implicitStepComplete( real64 const & time,
                        real64 const & dt,
                        DomainPartition & domain ) override;
 
  void updateGlobalComponentFraction( WellElementSubRegion & subRegion ) const;
 
  void updateVolRatesForConstraint( WellElementSubRegion const & subRegion );
 
  void updateBHPForConstraint( WellElementSubRegion & subRegion );
 
  void updateFluidModel( WellElementSubRegion & subRegion );
 
  real64 updatePhaseVolumeFraction( WellElementSubRegion & subRegion ) const;
 
  void updateTotalMassDensity( WellElementSubRegion & subRegion ) const;
 
  virtual void computePerforationRates( real64 const & time_n,
                                        real64 const & dt, DomainPartition & domain ) override;
 
  virtual void updateState( DomainPartition & domain ) override;
 
  virtual real64 updateSubRegionState( WellElementSubRegion & subRegion ) override;
 
  virtual string wellElementDofName() const override { return viewKeyStruct::dofFieldString(); }
 
  virtual string resElementDofName() const override { return CompositionalMultiphaseBase::viewKeyStruct::elemDofFieldString(); }
 
  virtual localIndex numFluidComponents() const override { return m_numComponents; }
 
  virtual localIndex numFluidPhases() const override { return m_numPhases; }
 
  integer useTotalMassEquation() const { return m_useTotalMassEquation; }
 
  virtual void assembleFluxTerms( real64 const & time_n,
                                  real64 const & dt,
                                  DomainPartition & domain,
                                  DofManager const & dofManager,
                                  CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                  arrayView1d< real64 > const & localRhs )override;
  virtual void assembleAccumulationTerms( real64 const & time_n,
                                          real64 const & dt,
                                          DomainPartition & domain,
                                          DofManager const & dofManager,
                                          CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                          arrayView1d< real64 > const & localRhs ) override;
 
  virtual void assemblePressureRelations( 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 chopNegativeDensities( DomainPartition & domain );
 
  struct viewKeyStruct : WellSolverBase::viewKeyStruct
  {
    static constexpr char const * dofFieldString() { return "compositionalWellVars"; }
 
    // inputs
 
    static constexpr char const * useMassFlagString() { return CompositionalMultiphaseBase::viewKeyStruct::useMassFlagString(); }
 
    static constexpr char const * useTotalMassEquationString() { return CompositionalMultiphaseBase::viewKeyStruct::useTotalMassEquationString(); }
 
    static constexpr char const * maxCompFracChangeString() { return CompositionalMultiphaseBase::viewKeyStruct::maxCompFracChangeString(); }
 
    static constexpr char const * maxRelativePresChangeString() { return "maxRelativePressureChange"; }
 
    static constexpr char const * maxAbsolutePresChangeString() { return "maxAbsolutePressureChange"; }
 
    static constexpr char const * maxRelativeCompDensChangeString() { return "maxRelativeCompDensChange"; }
 
    static constexpr char const * maxRelativeTempChangeString() { return "maxRelativeTemperatureChange"; }
 
    static constexpr char const * allowLocalCompDensChoppingString() { return CompositionalMultiphaseBase::viewKeyStruct::allowLocalCompDensChoppingString(); }
 
    // control data (not registered on the mesh)
 
    static constexpr char const * massDensityString() { return "massDensity";}
 
    static constexpr char const * currentBHPString() { return "currentBHP"; }
    static constexpr char const * dCurrentBHPString() { return "dCurrentBHP"; }
 
    static constexpr char const * dCurrentBHP_dPresString() { return "dCurrentBHP_dPres"; }
    static constexpr char const * dCurrentBHP_dCompDensString() { return "dCurrentBHP_dCompDens"; }
 
    static constexpr char const * currentPhaseVolRateString() { return "currentPhaseVolumetricRate"; }
    static constexpr char const * dCurrentPhaseVolRateString() { return "dCurrentPhaseVolumetricRate"; }
 
 
    static constexpr char const * dCurrentPhaseVolRate_dPresString() { return "dCurrentPhaseVolumetricRate_dPres"; }
 
    static constexpr char const * dCurrentPhaseVolRate_dCompDensString() { return "dCurrentPhaseVolumetricRate_dCompDens"; }
 
    static constexpr char const * dCurrentPhaseVolRate_dRateString() { return "dCurrentPhaseVolumetricRate_dRate"; }
 
    static constexpr char const * currentTotalVolRateString() { return "currentTotalVolumetricRate"; }
    static constexpr char const * dCurrentTotalVolRateString() { return "dCurrentTotalVolumetricRate"; }
 
    static constexpr char const * currentMassRateString() { return "currentMassRate"; }
 
    static constexpr char const * dCurrentTotalVolRate_dPresString() { return "dCurrentTotalVolumetricRate_dPres"; }
 
    static constexpr char const * dCurrentTotalVolRate_dCompDensString() { return "dCurrentTotalVolumetricRate_dCompDens"; }
 
    static constexpr char const * dCurrentTotalVolRate_dRateString() { return "dCurrentTotalVolumetricRate_dRate"; }
 
  } viewKeysCompMultiphaseWell;
 
protected:
 
  virtual void postInputInitialization() override;
 
  virtual void initializePostSubGroups() override;
 
  virtual void initializePostInitialConditionsPreSubGroups() override;
 
  virtual void postRestartInitialization() override final;
  /*
   * @brief Utility function that checks the consistency of the constitutive models
   * @param[in] domain the domain partition
   * @detail
   * This function will produce an error if one of the well constitutive models
   * is incompatible with the corresponding models in reservoir
   * regions connected to that particular well.
   */
  void validateConstitutiveModels( DomainPartition const & domain ) const;
 
  void validateWellControlsForFluid( WellControls const & wellControls,
                                     constitutive::MultiFluidBase const & fluid ) const;
 
  void validateInjectionStreams( WellElementSubRegion const & subRegion ) const;
 
  virtual void validateWellConstraints( real64 const & time_n,
                                        real64 const & dt,
                                        WellElementSubRegion const & subRegion ) override;
 
  void createSeparator();
 
  void printRates( real64 const & time_n,
                   real64 const & dt,
                   DomainPartition & domain ) override;
 
private:
 
  struct ReferenceConditions
  {
    real64 pressure;
    real64 temperature;
  };
 
  void initializeWells( DomainPartition & domain, real64 const & time_n ) override;
 
  virtual void setConstitutiveNames( ElementSubRegionBase & subRegion ) const override;
 
  void precomputeReferenceConditions( real64 time_n,
                                      Group & meshBodies,
                                      MeshBody & meshBody,
                                      WellElementSubRegion const & subRegion );
 
  ReferenceConditions getReferenceConditions( WellElementSubRegion const & subRegion );
 
  integer m_useMass;
 
  integer m_useTotalMassEquation;
 
  real64 m_maxCompFracChange;
 
  real64 m_maxRelativePresChange;
 
  real64 m_maxAbsolutePresChange;
 
  real64 m_maxRelativeCompDensChange;
 
  real64 m_maxRelativeTempChange;
 
  real64 m_minScalingFactor;
 
  integer m_allowCompDensChopping;
 
  localIndex m_targetPhaseIndex;
 
  std::unique_ptr< compositionalMultiphaseStatistics::StatsAggregator > m_reservoirStatsAggregator;
 
 
};
 
} // namespace geos
 
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_COMPOSITIONALMULTIPHASEWELL_HPP_