WellSolverBase.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_WELLSOLVERBASE_HPP_
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLSOLVERBASE_HPP_
 
#include "physicsSolvers/PhysicsSolverBase.hpp"
 
namespace geos
{
 
class DomainPartition;
class WellControls;
class WellElementSubRegion;
 
class WellSolverBase : public PhysicsSolverBase
{
public:
 
  static string coupledSolverAttributePrefix() { return "well"; }
 
  WellSolverBase( const string & name,
                  Group * const parent );
 
  virtual ~WellSolverBase() override;
 
  WellSolverBase() = delete;
 
  WellSolverBase( WellSolverBase const & ) = delete;
 
  WellSolverBase( WellSolverBase && ) = default;
 
  WellSolverBase & operator=( WellSolverBase const & ) = delete;
 
  WellSolverBase & operator=( WellSolverBase && ) = delete;
 
  virtual Group * createChild( string const & childKey, string const & childName ) override;
 
  virtual void expandObjectCatalogs() override;
 
 
  void setFlowSolverName( string const & name ) { m_flowSolverName = name; }
 
  string const & getFlowSolverName() const { return m_flowSolverName; }
 
  localIndex numDofPerWellElement() const { return m_numDofPerWellElement; }
 
  localIndex numDofPerResElement() const { return m_numDofPerResElement; }
 
  integer isThermal() const { return m_isThermal; }
 
  virtual string wellElementDofName() const = 0;
 
  virtual string resElementDofName() const = 0;
 
  virtual localIndex numFluidComponents() const = 0;
 
  virtual localIndex numFluidPhases() const = 0;
 
  WellControls & getWellControls( WellElementSubRegion const & subRegion );
 
  WellControls const & getWellControls( WellElementSubRegion const & subRegion ) const;
 
 
  void setPerforationStatus( real64 const & time_n, DomainPartition & domain );
 
  virtual void registerDataOnMesh( Group & meshBodies ) override;
 
  void selectWellConstraint( real64 const & time_n,
                             real64 const & dt,
                             integer const coupledIterationNumber,
                             DomainPartition & domain );
 
 
                             void setupWellDofs( DomainPartition & domain );
       
    void setupWellSystem ( DomainPartition & domain,
                         DofManager & dofManager,
                         CRSMatrix< real64, globalIndex > & localMatrix,
                         ParallelVector & rhs,
                         ParallelVector & solution,
                         bool const setSparsity = true );
 
  virtual void setupDofs( DomainPartition const & domain,
                          DofManager & dofManager ) const override;
 
  virtual void implicitStepSetup( real64 const & time_n,
                                  real64 const & dt,
                                  DomainPartition & domain ) override;
 
  virtual void implicitStepComplete( real64 const & GEOS_UNUSED_PARAM( time_n ),
                                     real64 const & GEOS_UNUSED_PARAM( dt ),
                                     DomainPartition & GEOS_UNUSED_PARAM( domain ) ) override {}
 
  virtual void applyBoundaryConditions( real64 const GEOS_UNUSED_PARAM( time_n ),
                                        real64 const GEOS_UNUSED_PARAM( dt ),
                                        DomainPartition & GEOS_UNUSED_PARAM( domain ),
                                        DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                                        CRSMatrixView< real64, globalIndex const > const & GEOS_UNUSED_PARAM( localMatrix ),
                                        arrayView1d< real64 > const & GEOS_UNUSED_PARAM( localRhs ) ) 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 ) )  {}
 
  void assembleWellSystem( real64 const time,
                           real64 const dt,
                           ElementRegionManager const & elementRegionManager,
                           WellElementSubRegion & subRegion,
                           DofManager const & dofManager,
                           CRSMatrixView< real64, globalIndex const > const & localMatrix,
                           arrayView1d< real64 > const & localRhs );
 
  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 & GEOS_UNUSED_PARAM( time ),
                                      real64 const & GEOS_UNUSED_PARAM( dt ),
                                      WellElementSubRegion const & GEOS_UNUSED_PARAM( subRegion ),
                                      DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                                      CRSMatrixView< real64, globalIndex const > const & GEOS_UNUSED_PARAM( localMatrix ),
                                      arrayView1d< real64 > const & GEOS_UNUSED_PARAM( localRhs ) ) = 0;
 
 
  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 ) = 0;
 
 
 
  virtual void assembleWellAccumulationTerms( real64 const & time,
                                              real64 const & dt,
                                              WellElementSubRegion & subRegion,
                                              DofManager const & dofManager,
                                              CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                              arrayView1d< real64 > const & localRhs ) = 0;
 
 
  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 ) = 0;
 
  virtual void assembleWellConstraintTerms( real64 const & GEOS_UNUSED_PARAM( time ),
                                            real64 const & GEOS_UNUSED_PARAM( dt ),
                                            WellElementSubRegion const & GEOS_UNUSED_PARAM( subRegion ),
                                            DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                                            CRSMatrixView< real64, globalIndex const > const & GEOS_UNUSED_PARAM( localMatrix ),
                                            arrayView1d< real64 > const & GEOS_UNUSED_PARAM( localRhs ) ) = 0;
 
  virtual void assembleWellPressureRelations ( real64 const & GEOS_UNUSED_PARAM( time ),
                                               real64 const & GEOS_UNUSED_PARAM( dt ),
                                               WellElementSubRegion const & GEOS_UNUSED_PARAM( subRegion ),
                                               DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                                               CRSMatrixView< real64, globalIndex const > const & GEOS_UNUSED_PARAM( localMatrix ),
                                               arrayView1d< real64 > const & GEOS_UNUSED_PARAM( localRhs ) ) = 0;
  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 ) = 0;
 
  virtual real64 updateWellState( WellElementSubRegion & subRegion ) = 0;
  virtual void updateState( DomainPartition & domain ) override;
 
  virtual real64 updateSubRegionState( WellElementSubRegion & subRegion ) = 0;
 
 
  virtual void computeWellPerforationRates( real64 const & GEOS_UNUSED_PARAM( time_n ),
                                            real64 const & GEOS_UNUSED_PARAM( dt ),
                                            ElementRegionManager const & GEOS_UNUSED_PARAM( elemManager ),
                                            WellElementSubRegion & GEOS_UNUSED_PARAM( subRegion ) ){}
 
  virtual void computePerforationRates( real64 const & time_n,
                                        real64 const & dt,
                                        DomainPartition & domain ) = 0;
 
  virtual real64
  calculateWellResidualNorm( real64 const & GEOS_UNUSED_PARAM( time_n ),
                             real64 const & GEOS_UNUSED_PARAM( dt ),
                             WellElementSubRegion const & GEOS_UNUSED_PARAM( subRegion ),
                             DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                             arrayView1d< real64 const > const & GEOS_UNUSED_PARAM( localRhs ) ) = 0;
 
  virtual real64
    scalingForWellSystemSolution( ElementSubRegionBase & GEOS_UNUSED_PARAM( subRegion ),
                                  DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                                  arrayView1d< real64 const > const & GEOS_UNUSED_PARAM( localSolution ) ) = 0;
 
  virtual bool
    checkWellSystemSolution( ElementSubRegionBase & GEOS_UNUSED_PARAM( subRegion ),
                             DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                             arrayView1d< real64 const > const & GEOS_UNUSED_PARAM( localSolution ),
                             real64 const GEOS_UNUSED_PARAM( scalingFactor ) ) = 0;
  virtual void
    applyWellSystemSolution( DofManager const & GEOS_UNUSED_PARAM( dofManager ),
                             arrayView1d< real64 const > const & GEOS_UNUSED_PARAM( localSolution ),
                             real64 const GEOS_UNUSED_PARAM( scalingFactor ),
                             real64 const GEOS_UNUSED_PARAM( dt ),
                             DomainPartition & GEOS_UNUSED_PARAM( domain ),
                             MeshLevel & GEOS_UNUSED_PARAM( mesh ),
                             WellElementSubRegion & GEOS_UNUSED_PARAM( subRegion ) ) = 0;
 
  bool solveNonlinearSystem( real64 const & time_n,
                             real64 const & stepDt,
                             integer const cycleNumber,
                             DomainPartition & domain,
                             MeshLevel & mesh,
                             ElementRegionManager & elementRegionManager,
                             WellElementSubRegion & subregion,
                             DofManager const & dofManager );
  bool
  lineSearch1( real64 const & time_n,
               real64 const & dt,
               integer const cycleNumber,
               DomainPartition & domain,
               ElementRegionManager & elemManager,
               WellElementSubRegion & subRegion,
               MeshLevel & mesh,
               DofManager const & dofManager,
               CRSMatrixView< real64, globalIndex const > const & localMatrix,
               ParallelVector & rhs,
               ParallelVector & solution,
               real64 const scaleFactor,
               real64 & lastResidual );
  virtual real64 setNextDt( real64 const & currentTime,
                            real64 const & currentDt,
                            DomainPartition & domain ) override;
 
  void setKeepVariablesConstantDuringInitStep( bool const keepVariablesConstantDuringInitStep )
  { m_keepVariablesConstantDuringInitStep = keepVariablesConstantDuringInitStep; }
 
  struct viewKeyStruct : PhysicsSolverBase::viewKeyStruct
  {
    static constexpr char const * isThermalString() { return "isThermal"; }
    static constexpr char const * writeCSVFlagString() { return "writeCSV"; }
    static constexpr char const * timeStepFromTablesFlagString() { return "timeStepFromTables"; }
    static constexpr char const * useNewCodeString() { return "useNewCode"; }
 
    static constexpr char const * fluidNamesString() { return "fluidNames"; }
  };
 
private:
 
  void precomputeData( DomainPartition & domain );
 
protected:
 
  virtual void postInputInitialization() override;
 
  virtual void initializePostInitialConditionsPreSubGroups() override;
 
  virtual void initializePostSubGroups() override;
 
  virtual void initializeWells( DomainPartition & domain, real64 const & time_n ) = 0;
  virtual void initializeWell( DomainPartition & domain, MeshLevel & mesh, WellElementSubRegion & subRegion, real64 const & time_n ) = 0;
  virtual void validateWellConstraints( real64 const & time_n,
                                        real64 const & dt,
                                        WellElementSubRegion const & subRegion,
                                        ElementRegionManager const & elemManager ) = 0;
 
  virtual void printRates( real64 const & time_n,
                           real64 const & dt,
                           DomainPartition & domain ) = 0;
 
 virtual bool evaluateConstraints( real64 const & GEOS_UNUSED_PARAM(  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 &  GEOS_UNUSED_PARAM(  subRegion ) ,
                                    DofManager const & GEOS_UNUSED_PARAM( dofManager ) ) { return false;};
 
 
 
  string m_flowSolverName;
 
  integer m_numPhases;
 
  integer m_numComponents;
 
  integer m_numDofPerWellElement;
 
  integer m_numDofPerResElement;
 
  integer m_isThermal;
 
  integer m_writeCSV;
  string const m_ratesOutputDir;
 
  // flag to enable time step selection base on rates/bhp tables coordinates
  integer m_timeStepFromTables;
 
  bool m_keepVariablesConstantDuringInitStep;
 
  string m_referenceFluidModelName;
 
  integer m_estimateSolution;
 
 
  std::map< std::string, DofManager >   m_estimatorDoFManager;
 
 
 
  integer m_useNewCode;
  integer my_ctime; //tjb
};
 
}
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLSOLVERBASE_HPP_