WellManager.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_WELL_MANAGER_HPP_
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELL_MANAGER_HPP_
 
#include "physicsSolvers/PhysicsSolverBase.hpp"
#include "physicsSolvers/fluidFlow/SinglePhaseBase.hpp"
#include "physicsSolvers/fluidFlow/CompositionalMultiphaseBase.hpp"
#include "physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.hpp"
#include "physicsSolvers/fluidFlow/wells/SinglePhaseWell.hpp"
namespace geos
{
 
class DomainPartition;
class WellControls;
class WellElementSubRegion;
 
namespace dataRepository
{
namespace keys
{
static constexpr auto compositionalMultiphaseWell = "CompositionalMultiphaseWell";
static constexpr auto singlePhaseWell = "SinglePhaseWell";
}
}
class WellManager : public PhysicsSolverBase
{
public:
 
  static string coupledSolverAttributePrefix() { return "well"; }
 
  WellManager( const string & name,
               Group * const parent );
 
  virtual ~WellManager() override = default;
 
  WellManager() = delete;
 
  WellManager( WellManager const & ) = delete;
 
  WellManager( WellManager && ) = default;
 
  WellManager & operator=( WellManager const & ) = delete;
 
  WellManager & operator=( WellManager && ) = delete;
 
  virtual Group * createChild( string const & childKey, string const & childName ) override;
 
  virtual void expandObjectCatalogs() override;
 
  void setFlowSolverName( string const & name ) { m_flowSolverName = name; }
 
  void setCompositional( bool const & isCompositional ) { m_isCompositional = isCompositional; }
 
  bool isCompositional() const { return m_isCompositional; }
 
 
  string const & getFlowSolverName() const { return m_flowSolverName; }
 
 
  static string catalogName() { return "WellManager"; }
  string getCatalogName() const override { return catalogName(); }
 
  virtual void registerDataOnMesh( Group & meshBodies ) override;
  WellControls & getWell( WellElementSubRegion const & subRegion );
 
  WellControls & getWell( std::string const & wellControlsName );
 
  WellControls const & getWell( std::string const & wellControlsName ) const;
  string wellElementDofName() const;
 
  struct viewKeyStruct : PhysicsSolverBase::viewKeyStruct
  {
    static constexpr char const * dofFieldString() { return "wellVars"; }
    static constexpr char const * isThermalString() { return "isThermal"; }
    static constexpr char const * useMassFlagString() {return "useMass"; }
    static constexpr char const * targetRegionsString() { return "targetRegions"; }
    static constexpr char const * timeStepFromTablesFlagString() { return "timeStepFromTables"; }
    static constexpr char const * useTotalMassEquationString() { return "useTotalMassEquation"; }
    static constexpr char const * allowLocalCompDensChoppingString() { return CompositionalMultiphaseBase::viewKeyStruct::allowLocalCompDensChoppingString(); }
 
 
  };
 
  localIndex numDofPerWellElement() const;
 
  localIndex numDofPerResElement() const;
 
  integer isThermal() const;
 
 
  virtual string resElementDofName() const;
 
  virtual localIndex numFluidComponents() const;
 
  virtual localIndex numFluidPhases() const;
 
  integer useTotalMassEquation() const { return m_useTotalMassEquation; }
 
  WellControls & getWellControls( WellElementSubRegion const & subRegion );
 
  WellControls const & getWellControls( WellElementSubRegion const & subRegion ) const;
 
  CompositionalMultiphaseWell & getCompositionalMultiphaseWell( WellElementSubRegion const & subRegion );
 
  CompositionalMultiphaseWell const & getCompositionalMultiphaseWell( WellElementSubRegion const & subRegion ) const;
 
  void selectWellConstraint( real64 const & time_n,
                             real64 const & dt,
                             integer const coupledIterationNumber,
                             DomainPartition & domain );
  /* PhysicsSolverBase interfaces */
 
  virtual real64 setNextDt( real64 const & currentTime,
                            real64 const & currentDt,
                            DomainPartition & domain ) override;
 
  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
  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
  resetStateToBeginningOfStep( DomainPartition & domain ) override;
 
  virtual void
  implicitStepComplete( real64 const & time,
                        real64 const & dt,
                        DomainPartition & 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 real64
  calculateResidualNorm( real64 const & time,
                         real64 const & dt,
                         DomainPartition const & domain,
                         DofManager const & dofManager,
                         arrayView1d< real64 const > const & localRhs ) override;
  virtual void updateState( DomainPartition & domain ) 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;
 
  void chopNegativeDensities( DomainPartition & domain );
 
  void setKeepVariablesConstantDuringInitStep( bool const keepVariablesConstantDuringInitStep );
 
 
protected:
  //virtual void postInputInitialization() override;
 
  virtual void initializePostSubGroups() override;
 
  virtual void initializePostInitialConditionsPreSubGroups() override;
 
  virtual void postRestartInitialization() override final;
 
 
private:
 
  string m_flowSolverName;
 
  integer m_useMass;
 
  integer m_useTotalMassEquation;
 
  integer m_isThermal;
 
  bool m_isCompositional;
 
 
  integer m_numFluidPhases;
 
  integer m_numFluidComponents;
 
  integer m_numDofPerWellElement;
 
  integer m_numDofPerResElement;
 
  real64 m_minScalingFactor;
 
  integer m_allowCompDensChopping;
 
  // flag to enable time step selection base on rates/bhp tables coordinates
  integer m_timeStepFromTables;
};
 
}
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELL_MANAGER_HPP_