WellPhaseVolumeRateConstraint.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 WellPhaseVolumeRateConstraint.hpp
 */
 
 
#ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLPHASEVOLUMERATECONSTRAINT_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLPHASEVOLUMERATECONSTRAINT_HPP
 
#include "common/format/EnumStrings.hpp"
#include "dataRepository/Group.hpp"
#include "functions/TableFunction.hpp"
#include "WellConstraintsBase.hpp"
#include "WellConstants.hpp"
 
namespace geos
{
 
 
template< typename T >
localIndex getPhaseIndexFromFluidModel( T const & fluidModel, std::string const & inputPhase )
{
  localIndex phaseIndex=-1;
  // Find target phase index for phase rate constraint
  for( integer ip = 0; ip < fluidModel.numFluidPhases(); ++ip )
  {
    if( fluidModel.phaseNames()[ip] == inputPhase )
    {
      phaseIndex = ip;
    }
  }
  return phaseIndex;
}
 
class PhaseVolumeRateConstraint : public WellConstraintBase
{
public:
 
 
 
  explicit PhaseVolumeRateConstraint( string const & name, dataRepository::Group * const parent );
 
  ~PhaseVolumeRateConstraint() override;
 
  PhaseVolumeRateConstraint() = delete;
 
  PhaseVolumeRateConstraint( PhaseVolumeRateConstraint const & ) = delete;
 
  PhaseVolumeRateConstraint( PhaseVolumeRateConstraint && ) = delete;
 
  PhaseVolumeRateConstraint & operator=( PhaseVolumeRateConstraint const & ) = delete;
 
  PhaseVolumeRateConstraint & operator=( PhaseVolumeRateConstraint && ) = delete;
 
 
  static string catalogName()
  {
    return "PhaseVolumeRateConstraint";
  }
 
 
  // Temp interface - tjb
  virtual ConstraintTypeId getControl() const override { return ConstraintTypeId::PHASEVOLRATE; };
 
  const string & getPhaseName() const { return m_phaseName; }
 
  void setPhaseName( const string & phaseName ) { m_phaseName = phaseName; }
 
  const localIndex & getPhaseIndex() const { return m_phaseIndex; }
 
  void setPhaseIndex( const localIndex & phaseIndex ) { m_phaseIndex = phaseIndex; }
 
  struct viewKeyStruct
  {
    static constexpr char const * phaseRateString() { return "phaseRate"; }
    static constexpr char const * phaseNameString() { return "phaseName"; }
  };
 
  template< typename T > void validatePhaseType( T const & fluidModel );
 
  virtual bool checkViolation( WellConstraintBase const & currentConstraint, real64 const & currentTime ) const override;
protected:
 
  virtual void postInputInitialization() override;
 
private:
 
  string m_phaseName;
 
  localIndex m_phaseIndex;
 
};
 
template< typename T >
void PhaseVolumeRateConstraint::validatePhaseType( T const & fluidModel )
{
  // Find target phase index for phase rate constraint
  m_phaseIndex = getPhaseIndexFromFluidModel( fluidModel, this->template getReference< string >( viewKeyStruct::phaseNameString()));
 
  GEOS_THROW_IF( m_phaseIndex == -1,
                 "PhaseVolumeRateConstraint " << this->template getReference< string >( viewKeyStruct::phaseNameString())   <<
                 ": Invalid phase type for simulation fluid model",
                 InputError );
}
 
} //namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLPHASEVOLUMERATECONSTRAINT_HPP