WellLiquidRateConstraint.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 WellLiquidRateConstraint.hpp
 */
 
 
#ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLLIQUIDRATECONSTRAINT_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLLIQUIDRATECONSTRAINT_HPP
 
#include "common/format/EnumStrings.hpp"
 
#include "functions/TableFunction.hpp"
#include "WellConstraintsBase.hpp"
 
namespace geos
{
 
 
class LiquidRateConstraint : public WellConstraintBase
{
public:
 
 
 
  explicit LiquidRateConstraint( string const & name, dataRepository::Group * const parent );
 
 
  ~LiquidRateConstraint() override;
 
  LiquidRateConstraint() = delete;
 
  LiquidRateConstraint( LiquidRateConstraint const & ) = delete;
 
  LiquidRateConstraint( LiquidRateConstraint && ) = delete;
 
  LiquidRateConstraint & operator=( LiquidRateConstraint const & ) = delete;
 
  LiquidRateConstraint & operator=( LiquidRateConstraint && ) = delete;
 
  static string catalogName()
  {
    return "LiquidRateConstraint";
  }
 
 
  const string_array & getPhaseNames() const { return m_phaseNames; }
 
  void setPhaseNames( const string_array & phaseNames )  { m_phaseNames=phaseNames; }
 
  const array1d< integer > & getPhaseIndices() const { return m_phaseIndices; }
 
 
  struct viewKeyStruct
  {
    static constexpr char const * liquidRateString() { return "liquidRate"; }
    static constexpr char const * phaseNamesString() { return "phaseNames"; }
  };
 
  // Temp interface - tjb
  virtual ConstraintTypeId getControl() const override { return ConstraintTypeId::LIQUIDRATE; };
 
  virtual bool checkViolation( WellConstraintBase const & currentConstraint, real64 const & currentTime ) const override;
 
protected:
 
  virtual void postInputInitialization() override;
 
  template< typename T >
  void  validateLiquidType( T const & fluidModel )
  {
    m_phaseIndices.resize( m_phaseNames.size());
    for( size_t ip =0; ip<m_phaseNames.size(); ip++ )
    {
      integer phaseIndex = fluidModel.getPhaseIndex( m_phaseNames[ip] );
      GEOS_THROW_IF( phaseIndex == -1,
                     "LiquidProductionConstraint " <<  viewKeyStruct::liquidRateString()    <<
                     ": Invalid Liquid type for simulation fluid model " << m_phaseNames[ip],
                     InputError );
      m_phaseIndices[ip]=phaseIndex;
    }
  }
protected:
 
  string_array m_phaseNames;
  array1d< integer > m_phaseIndices;
 
};
 
 
 
} //namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLLiquidRateConstraint_HPP