SinglePhaseWell.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_SINGLEPHASEWELL_HPP_
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_SINGLEPHASEWELL_HPP_
 
#include "physicsSolvers/fluidFlow/wells/WellControls.hpp"
 
#include "constitutive/fluid/singlefluid/SingleFluidLayouts.hpp"
 
namespace geos
{
 
namespace dataRepository
{
class Group;
}
 
namespace constitutive
{
class SingleFluidBase;
}
 
namespace singlePhaseStatistics
{
class StatsAggregator;
}
 
class WellElementSubRegion;
 
class SinglePhaseWell : public WellControls
{
public:
 
  using DerivOffset = constitutive::singlefluid::DerivativeOffsetC< 1 >;
  SinglePhaseWell( const string & name,
                   Group * const parent );
 
  SinglePhaseWell() = delete;
 
  SinglePhaseWell( SinglePhaseWell const & ) = delete;
 
  SinglePhaseWell( SinglePhaseWell && ) = delete;
 
  SinglePhaseWell & operator=( SinglePhaseWell const & ) = delete;
 
  SinglePhaseWell & operator=( SinglePhaseWell && ) = delete;
 
  virtual ~SinglePhaseWell() override;
 
  void registerWellDataOnMesh( WellElementSubRegion & subRegion ) override;
 
  virtual void initializeWell( DomainPartition & domain, Group & meshBodies, string const & meshBodyName, MeshLevel & mesh, WellElementSubRegion & subRegion, real64 const & time_n )override;
 
  virtual void initializeWellPostInitialConditionsPreSubGroups( WellElementSubRegion & subRegion )override;
 
  virtual bool isCompositional() const override { return false; }
  virtual void assembleWellAccumulationTerms( real64 const & time,
                                              real64 const & dt,
                                              WellElementSubRegion & subRegion,
                                              DofManager const & dofManager,
                                              CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                              arrayView1d< real64 > const & localRhs ) override;
  virtual void assembleWellPressureRelations( real64 const & time_n,
                                              real64 const & dt,
                                              WellElementSubRegion const & subRegion,
                                              DofManager const & dofManager,
                                              CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                              arrayView1d< real64 > const & localRhs ) override;
 
  virtual void assembleWellConstraintTerms( real64 const & time_n,
                                            real64 const & dt,
                                            WellElementSubRegion const & subRegion,
                                            DofManager const & dofManager,
                                            CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                            arrayView1d< real64 > const & localRhs ) override;
 
  virtual void computeWellPerforationRates( real64 const & time_n,
                                            real64 const & GEOS_UNUSED_PARAM( dt ),
                                            ElementRegionManager & elemManager,
                                            WellElementSubRegion & subRegion ) override;
 
  virtual void assembleWellFluxTerms( real64 const & time,
                                      real64 const & dt,
                                      WellElementSubRegion const & subRegion,
                                      DofManager const & dofManager,
                                      CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                      arrayView1d< real64 > const & localRhs ) override;
  virtual array1d< real64 >
  calculateLocalWellResidualNorm( real64 const & time_n,
                                  real64 const & dt,
                                  NonlinearSolverParameters const & nonlinearSolverParameters,
                                  WellElementSubRegion const & subRegion,
                                  DofManager const & dofManager,
                                  arrayView1d< real64 const > const & localRhs )override;
 
 
  virtual real64
  calculateWellResidualNorm( real64 const & time_n,
                             real64 const & dt,
                             NonlinearSolverParameters const & nonlinearSolverParameters,
                             WellElementSubRegion const & subRegion,
                             DofManager const & dofManager,
                             arrayView1d< real64 const > const & localRhs ) override;
 
  virtual real64 scalingForWellSystemSolution( WellElementSubRegion & subRegion,
                                               DofManager const & dofManager,
                                               arrayView1d< real64 const > const & localSolution ) override;
  virtual bool
  checkWellSystemSolution( WellElementSubRegion & subRegion,
                           DofManager const & dofManager,
                           arrayView1d< real64 const > const & localSolution,
                           real64 const scalingFactor,
                           real64 & minPressure,
                           real64 & minDensity,
                           real64 & minTotalDensity,
                           ElementsReporterBuffer & negPressureIds,
                           ElementsReporterBuffer & negDensityIds,
                           ElementsReporterBuffer & negTotalDensityIds ) override;
  virtual void
  applyWellSystemSolution( DofManager const & dofManager,
                           arrayView1d< real64 const > const & localSolution,
                           real64 const scalingFactor,
                           real64 const dt,
                           DomainPartition & domain,
                           MeshLevel & mesh,
                           WellElementSubRegion & subRegion ) override;
 
  virtual void applyWellBoundaryConditions ( real64 const GEOS_UNUSED_PARAM( time_n ),
                                             real64 const GEOS_UNUSED_PARAM( dt ),
                                             ElementRegionManager & GEOS_UNUSED_PARAM( elemManager ),
                                             WellElementSubRegion & GEOS_UNUSED_PARAM( subRegion ),
                                             DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                                             arrayView1d< real64 > const & GEOS_UNUSED_PARAM( localRhs ),
                                             CRSMatrixView< real64, globalIndex const > const & GEOS_UNUSED_PARAM( localMatrix ) )override {};
 
  virtual void resetStateToBeginningOfStep( DomainPartition & domain,
                                            string const & meshBodyName, ElementRegionManager const & elemManager, WellElementSubRegion & subRegion ) override;
 
  virtual void implicitStepSetup( real64 const & time_n,
                                  real64 const & GEOS_UNUSED_PARAM( dt ),
                                  DomainPartition & domain,
                                  string const & meshBodyName,
                                  ElementRegionManager & elemManager,
                                  WellElementSubRegion & subRegion )override;
 
  virtual void
  implicitStepComplete( real64 const & time,
                        real64 const & dt,
                        WellElementSubRegion const & subRegion ) override;
 
  virtual void printRates( real64 const & time_n,
                           real64 const & dt,
                           WellElementSubRegion const & subRegion ) override;
 
  virtual real64 updateSubRegionState( real64 const time_n,
                                       MeshBody const & meshBody,
                                       ElementRegionManager const & elemManager,
                                       WellElementSubRegion & subRegion ) override;
 
  virtual string wellElementDofName() const override { return viewKeyStruct::dofFieldString(); }
 
  virtual string resElementDofName() const override;
 
  virtual localIndex numFluidComponents() const override { return 0; }
 
  virtual localIndex numFluidPhases() const override { return 1; }
 
  virtual void updateBHPForConstraint( WellElementSubRegion & subRegion );
 
  virtual void updateFluidModel( WellElementSubRegion & subRegion ) const;
  void updateSeparator( ElementRegionManager const & elemManager, WellElementSubRegion & subRegion );
 
  void calculateReferenceElementRates( WellElementSubRegion & subRegion );
 
  virtual real64 updateWellState( MeshBody const & meshBody,
                                  ElementRegionManager const & elemManager,
                                  WellElementSubRegion & subRegion ) override;
 
 
  /*
   * @brief apply a special treatment to the wells that are shut
 
   * @param dofManager degree-of-freedom manager associated with the linear system
   * @param matrix the system matrix
   * @param rhs the system right-hand side vector
   */
  void shutDownWell( WellElementSubRegion & subRegion,
                     DofManager const & dofManager,
                     CRSMatrixView< real64, globalIndex const > const & localMatrix,
                     arrayView1d< real64 > const & localRhs );
 
  void assembleVolumeBalanceTerms( DomainPartition const & domain,
                                   DofManager const & dofManager,
                                   CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                   arrayView1d< real64 > const & localRhs );
 
  struct viewKeyStruct : WellControls::viewKeyStruct
  {
    static constexpr char const * dofFieldString() { return "wellVars"; }
 
 
  };
 
protected:
 
  virtual void initializePostInitialConditionsPreSubGroups() override;
 
  void saveState( WellElementSubRegion & subRegion );
 
  virtual void postRestartInitialization( )override;
  integer m_allowNegativePressure;
 
private:
 
  struct ReferenceConditions
  {
    real64 pressure;
    real64 temperature;
  };
 
  std::unique_ptr< singlePhaseStatistics::StatsAggregator > m_reservoirStatsAggregator;
 
  virtual void setConstitutiveNames( ElementSubRegionBase & subRegion ) const override;
 
  void initializeWells( DomainPartition & domain, real64 const & time_n );
 
  void precomputeReferenceConditions( real64 time_n,
                                      Group & meshBodies,
                                      MeshBody & meshBody,
                                      WellElementSubRegion const & subRegion );
 
  ReferenceConditions getReferenceConditions( WellElementSubRegion const & subRegion );
 
  virtual void validateWellConstraints( real64 const & time_n,
                                        real64 const & dt,
                                        WellElementSubRegion const & subRegion
                                        ) override;
 
 
 
  virtual void createSeparator( WellElementSubRegion & subRegion ) override;
 
};
 
} // namespace geos
 
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_SINGLEPHASEWELL_HPP_