WellConstraintsBase.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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.
 * ------------------------------------------------------------------------------------------------------------
 */
 
/*
 * @file WellConstraintBase.hpp
 */
 
 
#ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLCONSTRAINTBASE_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLCONSTRAINTBASE_HPP
 
#include "common/format/EnumStrings.hpp"
 
#include "functions/TableFunction.hpp"
#include "dataRepository/Group.hpp"
namespace geos
{
 
enum class ConstraintSourceId : integer
{
  USER,    
  WHP,    
  UNINITIALIZED,   
};
 
 
enum class ConstraintTypeId : integer
{
  BHP,    
  PHASEVOLRATE,   
  TOTALVOLRATE,   
  MASSRATE,   
  UNINITIALIZED,   
};
 
class WellConstraintBase : public dataRepository::Group
{
public:
  friend class WellControls;
 
  using CatalogInterface = dataRepository::CatalogInterface< WellConstraintBase, string const &, dataRepository::Group * const >;
 
  static CatalogInterface::CatalogType & getCatalog();
 
  virtual string getCatalogName() const = 0;
 
 
  explicit WellConstraintBase( string const & name, dataRepository::Group * const parent );
 
 
  ~WellConstraintBase() override;
 
  WellConstraintBase() = delete;
 
  WellConstraintBase( WellConstraintBase const & ) = delete;
 
  WellConstraintBase( WellConstraintBase && ) = delete;
 
  WellConstraintBase & operator=( WellConstraintBase const & ) = delete;
 
  WellConstraintBase & operator=( WellConstraintBase && ) = delete;
 
 
 
 
  // Temp interface - tjb
  virtual ConstraintTypeId getControl() const = 0;
 
  ConstraintSourceId getConstraintSource( ) const { return m_constraintSource; }
 
  bool isConstraintActive( ) const { return m_isConstraintActive; }
 
  void setConstraintActive( bool const & constraintActive ) { m_isConstraintActive=constraintActive; }
 
  void setConstraintValue( real64 const & constraintValue )
  {
    m_constraintValue = constraintValue;
  }
 
  real64 getConstraintValue( real64 const & currentTime ) const
  {
    if( m_constraintScheduleTableName.empty() )
    {
      return m_rateSign*m_constraintValue;
    }
 
    return m_rateSign*m_constraintScheduleTable->evaluate( &currentTime );
  }
 
 
  struct viewKeyStruct
  {
    static constexpr char const * constraintScheduleTableNameString() { return "constraintScheduleTableName"; }
 
    static constexpr char const * constraintActiveString() { return "constraintActive"; }
 
  }
  viewKeysWellConstraint;
 
  // Quantities computed from well constraint solve with this boundary condition
  // Until we have a more general interface for constraints to return these quantities,
  // we will store them in the constraint object itself.
  // This is not ideal but it is a temporary solution to avoid having to solve the constraint multiple times in the well solver and in the
  // test.
  void setBHP( real64 bhp ){ m_BHP=bhp;};
  void setPhaseVolumeRates( array1d< real64 > const & phaseVolumeRates ) { m_phaseVolumeRates = phaseVolumeRates; };
  void setTotalVolumeRate( real64 totalVolumeRate ){ m_totalVolumeRate = totalVolumeRate; };
  void setMassRate( real64 massRate ){ m_massRate = massRate; };
 
  real64 bottomHolePressure() const { return m_BHP; }
 
  arrayView1d< real64 const > phaseVolumeRates() const { return m_phaseVolumeRates; }
 
  real64 totalVolumeRate() const { return m_totalVolumeRate; }
 
  real64 liquidRate() const { return m_liquidRate; }
 
  real64 massRate() const { return m_massRate; }
 
  // endof This needs to be somewhere else tjb
  virtual bool checkViolation( WellConstraintBase const & currentConstraint, real64 const & currentTime ) const = 0;
 
protected:
 
  virtual void postInputInitialization() override;
 
  void setNextDtFromTables( real64 const currentTime, real64 & nextDt ) const;
 
 
protected:
 
  ConstraintSourceId m_constraintSource;
 
  integer m_isConstraintActive;
 
  bool m_useScheduleTable;
 
  real64 m_constraintValue;
 
  static void setNextDtFromTable( TableFunction const * table, real64 const currentTime, real64 & nextDt );
 
  string m_constraintScheduleTableName;
 
  TableFunction const * m_constraintScheduleTable;
 
  // Quantities computed from well constraint solve with this boundary condition
 
  // botton hole pressure
  real64 m_BHP;
 
  // phase rates
  array1d< real64 >  m_phaseVolumeRates;
 
  // liquid rate
  real64 m_liquidRate;
 
  // total volume rate
  real64 m_totalVolumeRate;
 
  // mass rate
  real64 m_massRate;
 
  real64 m_rateSign;
};
 
 
} //namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLCONSTRAINTBASE_HPP