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 "WellSolverBase.hpp"
 
#include "constitutive/fluid/singlefluid/SingleFluidLayouts.hpp"
 
namespace geos
{
 
namespace dataRepository
{
class Group;
}
 
namespace constitutive
{
class SingleFluidBase;
}
class WellElementSubRegion;
 
class SinglePhaseWell : public WellSolverBase
{
public:
 
  using DerivOffset = constitutive::singlefluid::DerivativeOffsetC< 1 >;
  SinglePhaseWell( const string & name,
                   Group * const parent );
 
  SinglePhaseWell() = delete;
 
  SinglePhaseWell( SinglePhaseWell const & ) = delete;
 
  SinglePhaseWell( SinglePhaseWell && ) = default;
 
  SinglePhaseWell & operator=( SinglePhaseWell const & ) = delete;
 
  SinglePhaseWell & operator=( SinglePhaseWell && ) = delete;
 
  virtual ~SinglePhaseWell() override = default;
 
  static string catalogName() { return "SinglePhaseWell"; }
  string getCatalogName() const override { return catalogName(); }
 
  virtual void registerDataOnMesh( Group & meshBodies ) override;
 
  virtual real64 scalingForWellSystemSolution( ElementSubRegionBase & subRegion,
                                               DofManager const & dofManager,
                                               arrayView1d< real64 const > const & localSolution ) override;
  virtual real64
  calculateWellResidualNorm( real64 const & time_n,
                             real64 const & dt,
                             WellElementSubRegion const & subRegion,
                             DofManager const & dofManager,
                             arrayView1d< real64 const > const & localRhs ) override;
  virtual real64
  calculateResidualNorm( real64 const & time_n,
                         real64 const & dt,
                         DomainPartition const & domain,
                         DofManager const & dofManager,
                         arrayView1d< real64 const > const & localRhs ) override;
 
  virtual bool
  checkWellSystemSolution( ElementSubRegionBase & subRegion,
                           DofManager const & dofManager,
                           arrayView1d< real64 const > const & localSolution,
                           real64 const scalingFactor ) override;
 
  virtual bool
  checkSystemSolution( DomainPartition & domain,
                       DofManager const & dofManager,
                       arrayView1d< real64 const > const & localSolution,
                       real64 const scalingFactor ) 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
  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;
 
  virtual string wellElementDofName() const override { return viewKeyStruct::dofFieldString(); }
 
  virtual string resElementDofName() const override;
 
  virtual localIndex numFluidComponents() const override { return 1; }
 
  virtual localIndex numFluidPhases() const override { return 1; }
 
  virtual void calculateReferenceElementRates( WellElementSubRegion & subRegion );
 
  virtual void updateBHPForConstraint( WellElementSubRegion & subRegion );
 
  virtual void updateFluidModel( WellElementSubRegion & subRegion ) const;
  void updateSeparator( WellElementSubRegion & subRegion );
 
  virtual void computePerforationRates( real64 const & time_n,
                                        real64 const & dt, DomainPartition & domain ) override;
 
  virtual real64 updateWellState( WellElementSubRegion & subRegion ) override;
  virtual void updateState( DomainPartition & domain ) override;
 
  virtual real64 updateSubRegionState( WellElementSubRegion & subRegion ) override;
 
  virtual void assembleSystem( real64 const time,
                               real64 const dt,
                               DomainPartition & domain,
                               DofManager const & dofManager,
                               CRSMatrixView< real64, globalIndex const > const & localMatrix,
                               arrayView1d< real64 > const & localRhs ) 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 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 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 assembleAccumulationTerms( real64 const & time_n,
                                          real64 const & dt, DomainPartition & domain,
                                          DofManager const & dofManager,
                                          CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                          arrayView1d< real64 > const & localRhs ) override;
 
  void assembleVolumeBalanceTerms( DomainPartition const & domain,
                                   DofManager const & dofManager,
                                   CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                   arrayView1d< real64 > const & localRhs );
 
  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 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 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;
 
  /*
   * @brief apply a special treatment to the wells that are shut
   * @param time_n the time at the previous converged time step
   * @param domain the physical domain object
   * @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( real64 const time_n,
                     DomainPartition const & domain,
                     DofManager const & dofManager,
                     CRSMatrixView< real64, globalIndex const > const & localMatrix,
                     arrayView1d< real64 > const & localRhs );
  struct viewKeyStruct : WellSolverBase::viewKeyStruct
  {
    static constexpr char const * dofFieldString() { return "singlePhaseWellVars"; }
 
    // control data (not registered on the mesh)
    static constexpr char const * currentBHPString() { return "currentBHP"; }
    static constexpr char const * dCurrentBHPString() { return "dCurrentBHP"; }
    static constexpr char const * currentVolRateString() { return "currentVolumetricRate"; }
    static constexpr char const * dCurrentVolRateString() { return "dCurrentVolRate"; }
  };
 
protected:
 
  virtual void initializePostInitialConditionsPreSubGroups() override;
 
  void saveState( WellElementSubRegion & subRegion );
 
  void printRates( real64 const & time_n,
                   real64 const & dt,
                   DomainPartition & domain ) override;
 
  integer m_allowNegativePressure;
 
private:
 
  virtual void setConstitutiveNames( ElementSubRegionBase & subRegion ) const override;
 
  void initializeWells( DomainPartition & domain, real64 const & time_n ) override;
  void initializeWell( DomainPartition & domain, MeshLevel & mesh, WellElementSubRegion & subRegion, real64 const & time_n ) override;
  virtual void validateWellConstraints( real64 const & time_n,
                                        real64 const & dt,
                                        WellElementSubRegion const & subRegion,
                                        ElementRegionManager const & elemManager ) override;
 
 virtual bool evaluateConstraints( real64 const &   time_n ,
                                    real64 const & GEOS_UNUSED_PARAM( stepDt ),
                                    integer const GEOS_UNUSED_PARAM( cycleNumber ),
                                    integer const GEOS_UNUSED_PARAM( coupledIterationNumber ),
                                    DomainPartition & GEOS_UNUSED_PARAM( domain ),
                                    MeshLevel & GEOS_UNUSED_PARAM( mesh ),
                                    ElementRegionManager & GEOS_UNUSED_PARAM( elemManager ),
                                    WellElementSubRegion &   subRegion  ,
                                    DofManager const & GEOS_UNUSED_PARAM( dofManager ) ) override;
 
 
  void createSeparator();
 
};
 
} // namespace geos
 
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_SINGLEPHASEWELL_HPP_