AquiferBoundaryCondition.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_FIELDSPECIFICATION_AQUIFERBOUNDARYCONDITION_HPP
#define GEOS_FIELDSPECIFICATION_AQUIFERBOUNDARYCONDITION_HPP
 
#include "FieldSpecificationBase.hpp"
#include "functions/TableFunction.hpp"
 
namespace geos
{
 
class AquiferBoundaryCondition : public FieldSpecificationBase
{
public:
 
  class KernelWrapper
  {
public:
 
    KernelWrapper( real64 initialPressure,
                   real64 density,
                   real64 gravCoef,
                   real64 timeConstant,
                   real64 influxConstant,
                   real64 cumulativeFlux,
                   TableFunction::KernelWrapper pressureInfluenceFunction )
      : m_initialPressure( initialPressure ),
      m_density( density ),
      m_gravCoef( gravCoef ),
      m_timeConstant( timeConstant ),
      m_influxConstant( influxConstant ),
      m_cumulativeFlux( cumulativeFlux ),
      m_pressureInfluenceFunction( pressureInfluenceFunction )
    {}
 
    GEOS_HOST_DEVICE
    inline real64
    compute( real64 const & timeAtBeginningOfStep,
             real64 const & dt,
             real64 const & reservoirPressure,
             real64 const & reservoirPressure_n,
             real64 const & reservoirGravCoef,
             real64 const & areaFraction,
             real64 & dAquiferVolFlux_dPres ) const;
 
private:
 
    // Physical parameters
 
    real64 m_initialPressure;
 
    real64 m_density;
 
    real64 m_gravCoef;
 
    real64 m_timeConstant;
 
    real64 m_influxConstant;
 
    real64 m_cumulativeFlux;
 
    TableFunction::KernelWrapper m_pressureInfluenceFunction;
 
  };
 
  AquiferBoundaryCondition( string const & name, Group * parent );
 
  AquiferBoundaryCondition() = delete;
 
  virtual ~AquiferBoundaryCondition() = default;
 
  AquiferBoundaryCondition( AquiferBoundaryCondition const & ) = delete;
 
  AquiferBoundaryCondition( AquiferBoundaryCondition && ) = default;
 
  AquiferBoundaryCondition & operator=( AquiferBoundaryCondition const & ) = delete;
 
  AquiferBoundaryCondition & operator=( AquiferBoundaryCondition && ) = delete;
 
  static string catalogName() { return "Aquifer"; }
 
  KernelWrapper createKernelWrapper() const;
 
  void setGravityVector( R1Tensor const & gravityVector );
 
  void saveConvergedState( real64 const fluxIncrement ) { m_cumulativeFlux += fluxIncrement; }
 
  void setWaterPhaseIndex( integer const waterPhaseIndex ) { m_waterPhaseIndex = waterPhaseIndex; }
 
  integer getWaterPhaseIndex() const { return m_waterPhaseIndex; }
 
  real64 const & getWaterPhaseDensity() const { return m_density; }
 
  arrayView1d< real64 const > getWaterPhaseComponentFraction() const { return m_phaseComponentFraction.toViewConst(); }
 
  string_array const & getWaterPhaseComponentNames() const { return m_phaseComponentNames; }
 
  bool allowAllPhasesIntoAquifer() const { return m_allowAllPhasesIntoAquifer; }
 
  struct viewKeyStruct : public FieldSpecificationBase::viewKeyStruct
  {
 
    // aquifer geological properties
 
    constexpr static char const * aquiferPorosityString() { return "aquiferPorosity"; }
 
    constexpr static char const * aquiferPermeabilityString() { return "aquiferPermeability"; }
 
    // aquifer fluid properties
 
    constexpr static char const * aquiferInitialPressureString() { return "aquiferInitialPressure"; }
 
    constexpr static char const * aquiferWaterViscosityString() { return "aquiferWaterViscosity"; }
 
    constexpr static char const * aquiferWaterDensityString() { return "aquiferWaterDensity"; }
 
    constexpr static char const * aquiferWaterPhaseComponentFractionString() { return "aquiferWaterPhaseComponentFraction"; }
 
    constexpr static char const * aquiferWaterPhaseComponentNamesString() { return "aquiferWaterPhaseComponentNames"; }
 
    constexpr static char const * aquiferTotalCompressibilityString() { return "aquiferTotalCompressibility"; }
 
    constexpr static char const * allowAllPhasesIntoAquiferString() { return "allowAllPhasesIntoAquifer"; }
 
    // aquifer geometry
 
    constexpr static char const * aquiferElevationString() { return "aquiferElevation"; }
 
    constexpr static char const * aquiferThicknessString() { return "aquiferThickness"; }
 
    constexpr static char const * aquiferInnerRadiusString() { return "aquiferInnerRadius"; }
 
    constexpr static char const * aquiferAngleString() { return "aquiferAngle"; }
 
    // table influence function
 
    constexpr static char const * pressureInfluenceFunctionNameString() { return "pressureInfluenceFunctionName"; }
 
    // cumulative flux
 
    constexpr static char const * cumulativeFluxString() { return "cumulativeFlux"; }
 
  };
 
 
protected:
 
  virtual void postInputInitialization() override final;
 
private:
 
  void setupDefaultPressureInfluenceFunction();
 
  void computeTimeConstant();
 
  void computeInfluxConstant();
 
 
  // Physical parameters
 
  R1Tensor m_gravityVector;
 
  real64 m_porosity;
 
  real64 m_permeability;
 
  real64 m_initialPressure;
 
  integer m_allowAllPhasesIntoAquifer;
 
  integer m_waterPhaseIndex;
 
  real64 m_viscosity;
 
  real64 m_density;
 
  array1d< real64 > m_phaseComponentFraction;
 
  string_array m_phaseComponentNames;
 
  real64 m_totalCompressibility;
 
  real64 m_elevation;
 
  real64 m_thickness;
 
  real64 m_innerRadius;
 
  real64 m_angle;
 
  real64 m_timeConstant;
 
  real64 m_influxConstant;
 
  real64 m_cumulativeFlux;
 
  string m_pressureInfluenceFunctionName;
 
};
 
GEOS_HOST_DEVICE
real64
AquiferBoundaryCondition::KernelWrapper::
  compute( real64 const & timeAtBeginningOfStep,
           real64 const & dt,
           real64 const & reservoirPressure,
           real64 const & reservoirPressure_n,
           real64 const & reservoirGravCoef,
           real64 const & areaFraction,
           real64 & dAquiferVolFlux_dPres ) const
{
  // compute the dimensionless time
  real64 const dimensionlessTimeAtBeginningOfStep = timeAtBeginningOfStep / m_timeConstant;
  real64 const dimensionlessTimeAtEndOfStep = ( timeAtBeginningOfStep + dt ) / m_timeConstant;
 
  // compute the pressure influence and its derivative wrt to dimensionless time
  real64 dPresInfluence_dTime = 0;
  real64 const presInfluence = m_pressureInfluenceFunction.compute( &dimensionlessTimeAtEndOfStep, &dPresInfluence_dTime );
 
  // compute the potential difference between the reservoir (old pressure) and the aquifer
  real64 const potDiff = m_initialPressure - reservoirPressure_n - m_density * ( m_gravCoef - reservoirGravCoef );
 
  // compute the a
  real64 const timeConstantInv = 1.0 / m_timeConstant;
  real64 const denom = presInfluence - dimensionlessTimeAtBeginningOfStep * dPresInfluence_dTime;
  real64 const a = timeConstantInv * ( m_influxConstant * potDiff - m_cumulativeFlux * dPresInfluence_dTime ) / denom;
 
  // compute the b
  real64 const b = timeConstantInv * m_influxConstant / denom;
 
  // compute the average inflow rate Q
  real64 const aquiferVolFlux =  areaFraction * ( a - b * ( reservoirPressure - reservoirPressure_n ) );
  dAquiferVolFlux_dPres = -areaFraction * b;
 
  return aquiferVolFlux;
}
 
 
} /* namespace geos */
 
#endif /* GEOS_FIELDSPECIFICATION_AQUIFERBOUNDARYCONDITION_HPP */