WellProductionConstraint.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 WellProductionConstraints.hpp
 */
 
 
#ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLPRODUCTIONCONSTRAINT_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLPRODUCTIONCONSTRAINT_HPP
 
#include "common/format/EnumStrings.hpp"
#include "dataRepository/Group.hpp"
#include "functions/TableFunction.hpp"
 
namespace geos
{
using namespace dataRepository;
template< typename ConstraintType >
class ProductionConstraint : public ConstraintType
{
public:
 
  explicit ProductionConstraint( string const & name, dataRepository::Group * const parent );
 
  ~ProductionConstraint() override;
 
  ProductionConstraint() = delete;
 
  ProductionConstraint( ProductionConstraint const & ) = delete;
 
  ProductionConstraint( ProductionConstraint && ) = delete;
 
  ProductionConstraint & operator=( ProductionConstraint const & ) = delete;
 
  ProductionConstraint & operator=( ProductionConstraint && ) = delete;
 
 
  static string catalogName()
  {
    return "Production"+ConstraintType::catalogName();
  }
  virtual string getCatalogName() const override { return catalogName(); }
protected:
 
  virtual void postInputInitialization() override;
 
  static bool isViolated( const real64 & currentValue, const real64 & constraintValue )
  { return currentValue < constraintValue; }
};
 
 
} //namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLPRODUCTIONCONSTRAINT_HPP