WellBHPConstraints.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 WellBHPConstraints.hpp
 */
 
#ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLBHPCONSTRAINTS_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLBHPCONSTRAINTS_HPP
 
#include "common/format/EnumStrings.hpp"
#include "dataRepository/Group.hpp"
#include "functions/TableFunction.hpp"
#include "WellConstraintsBase.hpp"
namespace geos
{
 
enum class BHPConstraintTypeId : integer
{
  MIN,    
  MAX,    
  UNINITIALIZED,   
};
 
 
template< BHPConstraintTypeId T >
class BHPConstraint : public WellConstraintBase
{
public:
 
  explicit BHPConstraint( string const & name, dataRepository::Group * const parent );
 
 
  ~BHPConstraint() override;
 
  BHPConstraint() = delete;
 
  BHPConstraint( BHPConstraint const & ) = delete;
 
  BHPConstraint( BHPConstraint && ) = delete;
 
  BHPConstraint & operator=( BHPConstraint const & ) = delete;
 
  BHPConstraint & operator=( BHPConstraint && ) = delete;
 
 
 
  // Temp interface - tjb
  virtual ConstraintTypeId getControl() const override { return ConstraintTypeId::BHP; };
 
 
  struct viewKeyStruct
  {
    static constexpr char const * targetBHPString() { return "targetBHP"; }
    static constexpr char const * refElevString() { return "referenceElevation"; }
  }
  viewKeysWellBHPConstraint;
 
  virtual bool checkViolation( WellConstraintBase const & currentConstraint, real64 const & currentTime ) const override;
 
  real64 getReferenceElevation() const { return m_refElevation; }
 
  void setReferenceElevation( real64 const & refElevation ) { m_refElevation=refElevation; }
 
  real64 getReferenceGravityCoef() const { return m_refGravCoef; }
 
  void setReferenceGravityCoef( real64 const & refGravCoef ) { m_refGravCoef = refGravCoef; }
 
 
  static string catalogName()
  {
    if constexpr (T == BHPConstraintTypeId::MAX)
    {
      return "MaximumBHPConstraint";
    }
    else
    {
      return "MinimumBHPConstraint";
    }
 
  }
 
 
  virtual string getCatalogName() const override { return catalogName(); }
protected:
 
  virtual void postInputInitialization() override;
 
  real64 m_refElevation;
 
  real64 m_refGravCoef;
 
};
 
using MinimumBHPConstraint = BHPConstraint< BHPConstraintTypeId::MIN >;
using MaximumBHPConstraint = BHPConstraint< BHPConstraintTypeId::MAX >;
 
} //namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLBHPCONSTRAINTS_HPP