WellVolumeRateConstraint.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 WellVolumeRateConstraints.hpp
 */
 
 
#ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLTOTALVOLRATECONSTRAINTS_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLTOTALVOLRATECONSTRAINTS_HPP
 
#include "common/format/EnumStrings.hpp"
#include "dataRepository/Group.hpp"
#include "functions/TableFunction.hpp"
#include "WellConstraintsBase.hpp"
namespace geos
{
 
 
 
class VolumeRateConstraint : public WellConstraintBase
{
public:
 
 
  explicit VolumeRateConstraint( string const & name, dataRepository::Group * const parent );
 
 
  ~VolumeRateConstraint() override;
 
  VolumeRateConstraint() = delete;
 
  VolumeRateConstraint( VolumeRateConstraint const & ) = delete;
 
  VolumeRateConstraint( VolumeRateConstraint && ) = delete;
 
  VolumeRateConstraint & operator=( VolumeRateConstraint const & ) = delete;
 
  VolumeRateConstraint & operator=( VolumeRateConstraint && ) = delete;
 
  static string catalogName()
  {
    return "VolumeRateConstraint";
  }
 
  struct viewKeyStruct
  {
    static constexpr char const * volumeRateString() { return "volumeRate"; }
  };
 
  // Temp interface - tjb
  virtual ConstraintTypeId getControl() const override { return ConstraintTypeId::TOTALVOLRATE; };
 
  virtual bool checkViolation( WellConstraintBase const & currentConstraint, real64 const & currentTime ) const override;
protected:
 
  virtual void postInputInitialization() override;
 
};
 
 
} //namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLCONSTRAINT_HPP