EquilibriumInitialCondition.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_EQUILIBRIUMINITIALCONDITION_HPP
#define GEOS_FIELDSPECIFICATION_EQUILIBRIUMINITIALCONDITION_HPP
 
#include "FieldSpecificationBase.hpp"
 
namespace geos
{
 
class EquilibriumInitialCondition : public FieldSpecificationBase
{
public:
 
  EquilibriumInitialCondition( string const & name, Group * parent );
 
  EquilibriumInitialCondition() = delete;
 
  virtual ~EquilibriumInitialCondition() = default;
 
  EquilibriumInitialCondition( EquilibriumInitialCondition const & ) = delete;
 
  EquilibriumInitialCondition( EquilibriumInitialCondition && ) = default;
 
  EquilibriumInitialCondition & operator=( EquilibriumInitialCondition const & ) = delete;
 
  EquilibriumInitialCondition & operator=( EquilibriumInitialCondition && ) = delete;
 
  static string catalogName() { return "HydrostaticEquilibrium"; }
 
  integer getMaxNumEquilibrationIterations() const { return m_maxNumEquilibrationIterations; }
 
  real64 getEquilibrationTolerance() const { return m_equilibrationTolerance; }
 
  real64 getElevationIncrement() const { return m_elevationIncrement; }
 
  real64 getDatumPressure() const { return m_datumPressure; }
 
  real64 getDatumElevation() const { return m_datumElevation; }
 
  string_array const & getComponentNames() const { return m_componentNames; }
 
  string getInitPhaseName() const { return m_initPhaseName; }
 
  string_array const & getComponentFractionVsElevationTableNames() const { return m_componentFractionVsElevationTableNames; }
 
  string getTemperatureVsElevationTableName() const { return m_temperatureVsElevationTableName; }
 
  real64_array const & getPhaseContacts() const { return m_phaseContacts; }
 
  struct viewKeyStruct : public FieldSpecificationBase::viewKeyStruct
  {
 
    // equilibration parameters
 
    constexpr static char const * maxNumEquilibrationIterationsString() { return "maxNumberOfEquilibrationIterations"; }
 
    constexpr static char const * elevationIncrementString() { return "elevationIncrementInHydrostaticPressureTable"; }
 
    constexpr static char const * equilibrationToleranceString() { return "equilibrationTolerance"; }
 
    // datum elevation and pressure
 
    constexpr static char const * datumElevationString() { return "datumElevation"; }
 
    constexpr static char const * datumPressureString() { return "datumPressure"; }
 
    // name of the phase initially saturating the reservoir
 
    constexpr static char const * initPhaseNameString() { return "initialPhaseName"; }
 
    // component names to use the component fraction tables
 
    constexpr static char const * componentNamesString() { return "componentNames"; }
 
    // tables storing the properties vs elevation properties
 
    constexpr static char const * componentFractionVsElevationTableNamesString() { return "componentFractionVsElevationTableNames"; }
 
    constexpr static char const * temperatureVsElevationTableNameString() { return "temperatureVsElevationTableName"; }
 
    // array storing phase contact elevations
 
    constexpr static char const * phaseContactsString() { return "phaseContacts"; }
 
  };
 
 
protected:
 
  virtual void postInputInitialization() override final;
 
  virtual void initializePreSubGroups() override final;
 
private:
 
  integer m_maxNumEquilibrationIterations;
 
  real64 m_elevationIncrement;
 
  real64 m_equilibrationTolerance;
 
  real64 m_datumElevation;
 
  real64 m_datumPressure;
 
  string m_initPhaseName;
 
  string_array m_componentNames;
 
  string_array m_componentFractionVsElevationTableNames;
 
  string m_temperatureVsElevationTableName;
 
  real64_array m_phaseContacts;
 
};
 
} /* namespace geos */
 
#endif /* GEOS_FIELDSPECIFICATION_EQUILIBRIUMINITIALCONDITION_HPP */