WellInjectionConstraint.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 WellInjectionConstraint.hpp
 */
 
 
#ifndef GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLINJECTIONCONSTRAINT_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLINJECTIONCONSTRAINT_HPP
 
#include "common/format/EnumStrings.hpp"
#include "dataRepository/Group.hpp"
#include "functions/TableFunction.hpp"
 
namespace geos
{
 
using namespace dataRepository;
template< typename ConstraintType >
class InjectionConstraint : public ConstraintType
{
public:
  typedef InjectionConstraint< ConstraintType > classtype;
 
  explicit InjectionConstraint( string const & name, dataRepository::Group * const parent );
 
  ~InjectionConstraint() override;
 
  InjectionConstraint() = delete;
 
  InjectionConstraint( InjectionConstraint const & ) = delete;
 
  InjectionConstraint( InjectionConstraint && ) = delete;
 
  InjectionConstraint & operator=( InjectionConstraint const & ) = delete;
 
  InjectionConstraint & operator=( InjectionConstraint && ) = delete;
 
 
  static string catalogName()
  {
    return "InjectionConstraint"+ConstraintType::catalogName();
  }
 
  struct injectionStreamKey
  {
    static constexpr char const * injectionStreamString() { return "injectionStream"; }
    static constexpr char const * injectionTemperatureString() { return "injectionTemperature"; }
  };
 
  arrayView1d< real64 const > getInjectionStream() const { return m_injectionStream; }
 
  real64 getInjectionTemperature() const { return m_injectionTemperature; }
 
protected:
 
  virtual void postInputInitialization() override;
  static bool isViolated( const real64 & currentValue, const real64 & constraintValue )
  { return currentValue > constraintValue; }
 
  void validateInjectionStream();
private:
 
  array1d< real64 > m_injectionStream;
 
  real64 m_injectionTemperature;
 
};
 
 
} //namespace geos
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_WELLS_WELLINJECTIONCONSTRAINT_HPP