From 4ef2c1254657bae5df1ffd860de402ee6964ef51 Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 12 Sep 2025 15:45:52 +0200 Subject: [PATCH 01/16] first pas --- .../VanGenuchtenCapillaryPressure.cpp | 2 +- .../constitutive/docs/CO2BrineFluid.rst | 13 +++++++++++++ .../fluid/multifluid/MultiFluidBase.cpp | 2 +- .../constant/InvariantImmiscibleFluid.cpp | 2 +- .../singlefluid/CompressibleSinglePhaseFluid.cpp | 4 ++-- .../fluid/singlefluid/ProppantSlurryFluid.cpp | 4 ++-- .../permeability/PressurePermeability.cpp | 2 +- .../BrooksCoreyBakerRelativePermeability.cpp | 2 +- .../BrooksCoreyRelativePermeability.cpp | 4 ++-- .../constitutive/solid/porosity/PorosityBase.cpp | 2 +- .../solid/porosity/PressurePorosity.cpp | 4 ++-- .../fluidFlow/CompositionalMultiphaseBase.cpp | 4 ++-- .../fluidFlow/CompositionalMultiphaseStatistics.cpp | 2 +- .../fluidFlow/ImmiscibleMultiphaseFlow.cpp | 2 +- .../ReactiveCompositionalMultiphaseOBL.cpp | 2 +- .../fluidFlow/wells/CompositionalMultiphaseWell.cpp | 2 +- .../physicsSolvers/fluidFlow/wells/WellControls.cpp | 4 ++-- 17 files changed, 35 insertions(+), 22 deletions(-) diff --git a/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp b/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp index 6d830c59ef9..6bc44cf97af 100644 --- a/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp +++ b/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp @@ -36,7 +36,7 @@ VanGenuchtenCapillaryPressure::VanGenuchtenCapillaryPressure( string const & nam registerWrapper( viewKeyStruct::phaseMinVolumeFractionString(), &m_phaseMinVolumeFraction ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Minimum volume fraction value for each phase" ); + setDescription( "Minimum volume fraction value for each phase (expressed as a percentage) used to compute the relative permeability " ); registerWrapper( viewKeyStruct::phaseCapPressureExponentInvString(), &m_phaseCapPressureExponentInv ). setApplyDefaultValue( 0.5 ). diff --git a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst index 2a3e001fc46..5bd223494f9 100644 --- a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst +++ b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst @@ -42,6 +42,19 @@ The user can parameterize the construction of the table by specifying the salini Note that the pressures are in Pascal, temperatures are in Kelvin, and the salinity is a molality (moles of NaCl per kg of brine). The temperature must be between 283.15 and 623.15 Kelvin. + +p_min: The minimum pressure value [Pa] for which the density table is defined. It sets the lower boundary of the pressure range. + +p_max: The maximum pressure value [Pa] for the density table. It sets the upper boundary of the pressure range. + +Δp (Delta p): The increment in pressure [Pa] between successive values in the pressure axis of the table. It defines the resolution of the pressure dimension. + +T_min: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. + +T_max: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. + +ΔT (Delta T): The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. + The table is populated using the model of Duan and Sun (2003). Specifically, we solve the following nonlinear CO2 equation of state (equation (A1) in Duan and Sun, 2003) for each pair :math:`(p,T)` to obtain the reduced volume, :math:`V_r`. diff --git a/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp b/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp index 03e574667c0..c39a683d6c5 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp @@ -43,7 +43,7 @@ MultiFluidBase::MultiFluidBase( string const & name, Group * const parent ) registerWrapper( viewKeyStruct::componentMolarWeightString(), &m_componentMolarWeight ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Component molar weights" ); + setDescription( "Component molar weights [kg/mol]" ); registerWrapper( viewKeyStruct::phaseNamesString(), &m_phaseNames ). setRTTypeName( rtTypes::CustomTypes::groupNameRefArray ). diff --git a/src/coreComponents/constitutive/fluid/multifluid/constant/InvariantImmiscibleFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/constant/InvariantImmiscibleFluid.cpp index a676abdf379..7a4640a3c1a 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/constant/InvariantImmiscibleFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/constant/InvariantImmiscibleFluid.cpp @@ -22,7 +22,7 @@ InvariantImmiscibleFluid::InvariantImmiscibleFluid( string const & name, Group * registerWrapper( viewKeyStruct::componentMolarWeightString(), &m_componentMolarWeight ) .setInputFlag( dataRepository::InputFlags::REQUIRED ) - .setDescription( "Molar weights of components" ); + .setDescription( "Component molar weights [kg/mol]" ); // Densities: constant phase densities registerWrapper( "densities", &m_densities ) diff --git a/src/coreComponents/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp b/src/coreComponents/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp index a5475f846a9..341ab6f8bb0 100644 --- a/src/coreComponents/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp +++ b/src/coreComponents/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp @@ -45,7 +45,7 @@ CompressibleSinglePhaseFluid::CompressibleSinglePhaseFluid( string const & name, registerWrapper( viewKeyStruct::compressibilityString(), &m_compressibility ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Fluid compressibility" ); + setDescription( "Fluid compressibility [Pa^-1]" ); registerWrapper( viewKeyStruct::viscosibilityString(), &m_viscosibility ). setApplyDefaultValue( 0.0 ). @@ -55,7 +55,7 @@ CompressibleSinglePhaseFluid::CompressibleSinglePhaseFluid( string const & name, registerWrapper( viewKeyStruct::referencePressureString(), &m_referencePressure ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Reference pressure" ); + setDescription( "Reference pressure [Pa]" ); registerWrapper( viewKeyStruct::referenceDensityString(), &m_referenceDensity ). setApplyDefaultValue( 1000.0 ). diff --git a/src/coreComponents/constitutive/fluid/singlefluid/ProppantSlurryFluid.cpp b/src/coreComponents/constitutive/fluid/singlefluid/ProppantSlurryFluid.cpp index c73569ebb3c..034fcc4c4cb 100644 --- a/src/coreComponents/constitutive/fluid/singlefluid/ProppantSlurryFluid.cpp +++ b/src/coreComponents/constitutive/fluid/singlefluid/ProppantSlurryFluid.cpp @@ -33,7 +33,7 @@ ProppantSlurryFluid::ProppantSlurryFluid( string const & name, Group * const par registerWrapper( viewKeyStruct::compressibilityString(), &m_compressibility ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Fluid compressibility" ); + setDescription( "Fluid compressibility [Pa^-1]" ); registerWrapper( viewKeyStruct::referenceProppantDensityString(), &m_referenceProppantDensity ). setApplyDefaultValue( 1400.0 ). @@ -43,7 +43,7 @@ ProppantSlurryFluid::ProppantSlurryFluid( string const & name, Group * const par registerWrapper( viewKeyStruct::referencePressureString(), &m_referencePressure ). setApplyDefaultValue( 1e5 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Reference pressure" ); + setDescription( "Reference pressure [Pa]" ); registerWrapper( viewKeyStruct::referenceDensityString(), &m_referenceDensity ). setApplyDefaultValue( 1000.0 ). diff --git a/src/coreComponents/constitutive/permeability/PressurePermeability.cpp b/src/coreComponents/constitutive/permeability/PressurePermeability.cpp index abcb8cde307..349f91c8b95 100644 --- a/src/coreComponents/constitutive/permeability/PressurePermeability.cpp +++ b/src/coreComponents/constitutive/permeability/PressurePermeability.cpp @@ -42,7 +42,7 @@ PressurePermeability::PressurePermeability( string const & name, Group * const p registerWrapper( viewKeyStruct::referencePressureString(), &m_referencePressure ). setInputFlag( InputFlags::REQUIRED ). - setDescription( "Reference pressure for the pressure permeability model" ); + setDescription( "Reference pressure for the pressure permeability model [Pa]" ); registerWrapper( viewKeyStruct::referencePermeabilityString(), &m_referencePermeability ). setApplyDefaultValue( 0.0 ). diff --git a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp index bb8ad661a74..a650908e334 100644 --- a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp +++ b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp @@ -34,7 +34,7 @@ BrooksCoreyBakerRelativePermeability::BrooksCoreyBakerRelativePermeability( stri registerWrapper( viewKeyStruct::phaseMinVolumeFractionString(), &m_phaseMinVolumeFraction ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Minimum volume fraction value for each phase" ); + setDescription( "Minimum volume fraction value for each phase (expressed as a percentage) used to compute the relative permeability " ); registerWrapper( viewKeyStruct::waterOilRelPermExponentString(), &m_waterOilRelPermExponent ). setApplyDefaultValue( 1.0 ). diff --git a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp index 9e19941f1e7..5b51f8ae277 100644 --- a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp +++ b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp @@ -38,7 +38,7 @@ BrooksCoreyRelativePermeability::BrooksCoreyRelativePermeability( string const & registerWrapper( viewKeyStruct::phaseMinVolumeFractionString(), &m_phaseMinVolumeFraction ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Minimum volume fraction value for each phase" ); + setDescription( "Minimum volume fraction value for each phase (expressed as a percentage) used to compute the relative permeability " ); registerWrapper( viewKeyStruct::phaseRelPermExponentString(), &m_phaseRelPermExponent ). setApplyDefaultValue( 1.0 ). @@ -49,7 +49,7 @@ BrooksCoreyRelativePermeability::BrooksCoreyRelativePermeability( string const & registerWrapper( viewKeyStruct::phaseRelPermMaxValueString(), &m_phaseRelPermMaxValue ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Maximum relative permeability value for each phase" ); + setDescription( "Ratio between a phase's permeability and the maximum permeability of the rock, for each phase." ); registerWrapper( viewKeyStruct::volFracScaleString(), &m_volFracScale ). setApplyDefaultValue( 1.0 ). diff --git a/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp b/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp index 8b354eaebcc..0becc2dfa6e 100644 --- a/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp +++ b/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp @@ -41,7 +41,7 @@ PorosityBase::PorosityBase( string const & name, Group * const parent ): { registerWrapper( viewKeyStruct::defaultReferencePorosityString(), &m_defaultReferencePorosity ). setInputFlag( InputFlags::REQUIRED ). - setDescription( "Default value of the reference porosity" ); + setDescription( "The default porosity value of the rock at the referencePressure" ); registerField( fields::porosity::porosity{}, &m_newPorosity ); diff --git a/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp b/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp index cf62672c08d..6e756f11b7e 100644 --- a/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp +++ b/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp @@ -34,11 +34,11 @@ PressurePorosity::PressurePorosity( string const & name, Group * const parent ): { registerWrapper( viewKeyStruct::referencePressureString(), &m_referencePressure ). setInputFlag( InputFlags::REQUIRED ). - setDescription( "Reference pressure for solid compressibility" ); + setDescription( "Reference pressure for solid compressibility[Pa]" ); registerWrapper( viewKeyStruct::compressibilityString(), &m_compressibility ). setInputFlag( InputFlags::REQUIRED ). - setDescription( "Solid compressibility" ); + setDescription( "Solid compressibility [Pa^-1]" ); } void PressurePorosity::allocateConstitutiveData( dataRepository::Group & parent, diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index 419c1222a5e..8047fa8d8c4 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -115,7 +115,7 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) change in phase volume fraction in a time step" ); + setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); this->registerWrapper( viewKeyStruct::targetRelativeCompDensChangeString(), &m_targetRelativeCompDensChange ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). @@ -131,7 +131,7 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.5 ). - setDescription( "Maximum (absolute) change in a component fraction in a Newton iteration" ); + setDescription( "Maximum (absolute) allowed change in the composition fraction of any component within a single time step, in a Newton iteration" ); this->registerWrapper( viewKeyStruct::maxRelativePresChangeString(), &m_maxRelativePresChange ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp index ed8d8e5eb80..244bb884c42 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp @@ -51,7 +51,7 @@ CompositionalMultiphaseStatistics::CompositionalMultiphaseStatistics( const stri registerWrapper( viewKeyStruct::computeCFLNumbersString(), &m_computeCFLNumbers ). setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Flag to decide whether CFL numbers are computed or not" ); + setDescription( "Flag to decide whether CFL numbers are computed or not, used to calculate a safe time-step for the simulation" ); registerWrapper( viewKeyStruct::computeRegionStatisticsString(), &m_computeRegionStatistics ). setApplyDefaultValue( 1 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp index 00162bb1129..7af524e8787 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp @@ -90,7 +90,7 @@ ImmiscibleMultiphaseFlow::ImmiscibleMultiphaseFlow( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) change in phase volume fraction in a time step" ); + setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); } void ImmiscibleMultiphaseFlow::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index af7b3b8e51b..cf59d9751b2 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -94,7 +94,7 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st this->registerWrapper( viewKeyStruct::maxCompFracChangeString(), &m_maxCompFracChange ). setApplyDefaultValue( 1.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Maximum (absolute) change in a component fraction between two Newton iterations" ); + setDescription( "Maximum (absolute) allowed change in the composition fraction of any component within a single time step, in a Newton iteration" ); this->registerWrapper( viewKeyStruct::transMultExpString(), &m_transMultExp ). setApplyDefaultValue( 1.0 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index e3d685991e4..91f3fb422d0 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -88,7 +88,7 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 1.0 ). - setDescription( "Maximum (absolute) change in a component fraction between two Newton iterations" ); + setDescription( "Maximum (absolute) allowed change in the composition fraction of any component within a single time step, in a Newton iteration" ); this->registerWrapper( viewKeyStruct::maxRelativeCompDensChangeString(), &m_maxRelativeCompDensChange ). setSizedFromParent( 0 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index 15914dfb8a1..f84138f12f4 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -72,7 +72,7 @@ WellControls::WellControls( string const & name, Group * const parent ) setDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::WRITE_AND_READ ). - setDescription( "Target bottom-hole pressure [Pa]" ); + setDescription( "The Bottom Hole Pressure [Pa] being targeted during the injection." ); registerWrapper( viewKeyStruct::targetTotalRateString(), &m_targetTotalRate ). setDefaultValue( 0.0 ). @@ -108,7 +108,7 @@ WellControls::WellControls( string const & name, Group * const parent ) setDefaultValue( -1 ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Global component densities of the injection stream [moles/m^3 or kg/m^3]" ); + setDescription( "Defines the global component of the injected fluid in the reservoir as a fraction of its components [moles/m^3 or kg/m^3]" ); registerWrapper( viewKeyStruct::injectionTemperatureString(), &m_injectionTemperature ). setDefaultValue( -1 ). From 3b4c1add0818526a3e6458867f0d598ce978a5a4 Mon Sep 17 00:00:00 2001 From: arng40 Date: Mon, 15 Sep 2025 10:36:59 +0200 Subject: [PATCH 02/16] add paramter description to CO2brineFluid --- .../constitutive/docs/CO2BrineFluid.rst | 51 ++++++++++++++----- 1 file changed, 37 insertions(+), 14 deletions(-) diff --git a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst index 5bd223494f9..e6e4ece8892 100644 --- a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst +++ b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst @@ -40,21 +40,17 @@ The user can parameterize the construction of the table by specifying the salini | FlashModel | CO2Solubility | :math:`p_{min}` | :math:`p_{max}` | :math:`\Delta p` | :math:`T_{min}` | :math:`T_{max}` | :math:`\Delta T` | Salinity | +------------+---------------+-----------------+-----------------+------------------+-----------------+-----------------+------------------+----------+ -Note that the pressures are in Pascal, temperatures are in Kelvin, and the salinity is a molality (moles of NaCl per kg of brine). -The temperature must be between 283.15 and 623.15 Kelvin. - -p_min: The minimum pressure value [Pa] for which the density table is defined. It sets the lower boundary of the pressure range. - -p_max: The maximum pressure value [Pa] for the density table. It sets the upper boundary of the pressure range. - -Δp (Delta p): The increment in pressure [Pa] between successive values in the pressure axis of the table. It defines the resolution of the pressure dimension. +**Parameter Descriptions**: -T_min: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. - -T_max: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. - -ΔT (Delta T): The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. +- **p_min**: The minimum pressure value [Pa] for which the density table is defined. It sets the lower boundary of the pressure range. +- **p_max**: The maximum pressure value [Pa] for the density table. It sets the upper boundary of the pressure range. +- **Δp (Delta p)**: The increment in pressure [Pa] between successive values in the pressure axis of the table. It defines the resolution of the pressure dimension. +- **T_min**: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. +- **T_max**: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. +- **ΔT (Delta T)**: The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. +- **Salinity**: alinity is expressed in molality (moles of NaCl per kg of brine). +The temperature must be between 283.15 and 623.15 Kelvin. The table is populated using the model of Duan and Sun (2003). Specifically, we solve the following nonlinear CO2 equation of state (equation (A1) in Duan and Sun, 2003) for each pair :math:`(p,T)` to obtain the reduced volume, :math:`V_r`. @@ -105,6 +101,15 @@ The user defines the pressure (in Pascal) and temperature (in Kelvin) axis of th | DensityFun | SpanWagnerCO2Density | :math:`p_{min}` | :math:`p_{max}` | :math:`\Delta p` | :math:`T_{min}` | :math:`T_{max}` | :math:`\Delta T` | +------------+----------------------+-----------------+-----------------+------------------+-----------------+-----------------+------------------+ +**Parameter Descriptions**: + +- **p_min**: The minimum pressure value [Pa] for which the density table is defined. It sets the lower boundary of the pressure range. +- **p_max**: The maximum pressure value [Pa] for the density table. It sets the upper boundary of the pressure range. +- **Δp (Delta p)**: The increment in pressure [Pa] between successive values in the pressure axis of the table. It defines the resolution of the pressure dimension. +- **T_min**: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. +- **T_max**: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. +- **ΔT (Delta T)**: The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. + This correlation is valid for pressures less than :math:`8 \times 10^8` Pascal and temperatures less than 1073.15 Kelvin. Using these parameters, GEOS internally constructs a two-dimensional table storing the values of density as a function of pressure and temperature. This table is populated as explained in the work of Span and Wagner (1996) by solving the following nonlinear Helmholtz energy equation for each pair :math:`(p,T)` to obtain the value of density, :math:`\rho_{g}`: @@ -123,6 +128,15 @@ The pressure and temperature axis of the viscosity table can be parameterized in | ViscosityFun | FenghourCO2Viscosity | :math:`p_{min}` | :math:`p_{max}` | :math:`\Delta p` | :math:`T_{min}` | :math:`T_{max}` | :math:`\Delta T` | +--------------+----------------------+-----------------+-----------------+------------------+-----------------+-----------------+------------------+ +**Parameter Descriptions**: + +- **p_min**: The minimum pressure value [Pa] for which the density table is defined. It sets the lower boundary of the pressure range. +- **p_max**: The maximum pressure value [Pa] for the density table. It sets the upper boundary of the pressure range. +- **Δp (Delta p)**: The increment in pressure [Pa] between successive values in the pressure axis of the table. It defines the resolution of the pressure dimension. +- **T_min**: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. +- **T_max**: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. +- **ΔT (Delta T)**: The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. + This correlation is valid for pressures less than :math:`3 \times 10^8` Pascal and temperatures less than 1493.15 Kelvin. This table is populated as explained in the work of Fenghour and Wakeham (1998) by computing the CO2 phase viscosity, :math:`\mu_g`, as follows: @@ -146,9 +160,18 @@ The user specifies the (constant) salinity and defines the pressure and temperat | DensityFun | PhillipsBrineDensity | :math:`p_{min}` | :math:`p_{max}` | :math:`\Delta p` | :math:`T_{min}` | :math:`T_{max}` | :math:`\Delta T` | Salinity | +------------+----------------------+-----------------+-----------------+------------------+-----------------+-----------------+------------------+----------+ +**Parameter Descriptions**: + +- **p_min**: The minimum pressure value [Pa] for which the density table is defined. It sets the lower boundary of the pressure range. +- **p_max**: The maximum pressure value [Pa] for the density table. It sets the upper boundary of the pressure range. +- **Δp (Delta p)**: The increment in pressure [Pa] between successive values in the pressure axis of the table. It defines the resolution of the pressure dimension. +- **T_min**: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. +- **T_max**: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. +- **ΔT (Delta T)**: The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. +- **Salinity**: alinity is expressed in molality (moles of NaCl per kg of brine). + The pressure must be in Pascal and must be less than :math:`5 \times 10^7` Pascal. The temperature must be in Kelvin and must be between 283.15 and 623.15 Kelvin. -The salinity is a molality (moles of NaCl per kg of brine). Using these parameters, GEOS performs a preprocessing step to construct a two-dimensional table storing the brine density, :math:`\rho_{\ell,table}` for the specified salinity as a function of pressure and temperature using the expression: .. math:: From 5a2193a18aace03e828d8f37c622878e320e91eb Mon Sep 17 00:00:00 2001 From: arng40 Date: Mon, 15 Sep 2025 10:37:24 +0200 Subject: [PATCH 03/16] add default value to description to writeCSV --- .../constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp | 3 ++- .../fluid/multifluid/reactive/ReactiveBrineFluid.cpp | 3 ++- src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp | 3 ++- src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp | 3 ++- .../physicsSolvers/fluidFlow/wells/WellSolverBase.cpp | 3 ++- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index 6915df28649..8bbc81f9120 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -106,7 +106,8 @@ CO2BrineFluid( string const & name, Group * const parent ): setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "When set to 1, write PVT tables into a CSV file.\n " - "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." ). + "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." + "Set to 0 by default" ). setDefaultValue( 0 ); registerWrapper( viewKeyStruct::checkPhasePresenceString(), &m_checkPhasePresence ). diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 65214e56ab5..84b3966a152 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -76,7 +76,8 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "When set to 1, write PVT tables into a CSV file.\n" - "If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." ); + "If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." + "Set to 0 by default" ); // if this is a thermal model, we need to make sure that the arrays will be properly displayed and saved to restart if( isThermal() ) diff --git a/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp b/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp index 340a6865fb7..6dd20a9b2ca 100644 --- a/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp +++ b/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp @@ -42,7 +42,8 @@ MemoryStatsOutput::MemoryStatsOutput( string const & name, this->registerWrapper( viewKeysStruct::writeCSV, &m_writeCSV ). setApplyDefaultValue( csvOutputDefault ? 1 : 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the same statistics as the 'logLevel' allows to output in a CSV file" ); + setDescription( "When set to 1, write the same statistics as the 'logLevel' allows to output in a CSV file" + "If the umpire statistics log is enabled, set to 1 by default, otherwise set to 0" ); } void MemoryStatsOutput::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp index c67eed1c217..b3456a18d29 100644 --- a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp +++ b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp @@ -59,7 +59,8 @@ class FieldStatisticsBase : public TaskBase this->registerWrapper( viewKeyStruct::writeCSVFlagString(), &m_writeCSV ). setApplyDefaultValue( 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the statistics into a CSV file" ); + setDescription( "When set to 1, write the statistics into a CSV file" + "Set to 0 by default" ); } /** diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp index e470984d7cd..af15ea606ad 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp @@ -56,7 +56,8 @@ WellSolverBase::WellSolverBase( string const & name, this->registerWrapper( viewKeyStruct::writeCSVFlagString(), &m_writeCSV ). setApplyDefaultValue( 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the rates into a CSV file" ); + setDescription( "When set to 1, write the rates into a CSV file" + "Set to 0 by default" ); this->registerWrapper( viewKeyStruct::timeStepFromTablesFlagString(), &m_timeStepFromTables ). setApplyDefaultValue( 0 ). From 0cbeeab4b4d5f0b693faee0b66898cc47815f83c Mon Sep 17 00:00:00 2001 From: arng40 Date: Mon, 15 Sep 2025 15:01:32 +0200 Subject: [PATCH 04/16] 1st iteration description wrapper of fieldSpecificationBase --- .../fieldSpecification/FieldSpecificationBase.cpp | 12 ++++++++---- src/coreComponents/functions/TableFunction.cpp | 3 ++- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index 8321d341b63..4d27032cfe8 100644 --- a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp +++ b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp @@ -30,7 +30,9 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par setRTTypeName( rtTypes::CustomTypes::groupNameRefArray ). setInputFlag( InputFlags::REQUIRED ). setSizedFromParent( 0 ). - setDescription( "Name of sets that boundary condition is applied to." ); + setDescription( "Names of sets that boundary condition is applied to." + "A set can contains heterogeneous elements in the mesh (volumnes, nodes, faces, edges)." + "A set can be defined by a `Geometry` component, or can be targeted with externalSet in cases of external mesh" ); registerWrapper( viewKeyStruct::objectPathString(), &m_objectPath ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). @@ -40,12 +42,14 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par registerWrapper( viewKeyStruct::fieldNameString(), &m_fieldName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Name of field that boundary condition is applied to." ); + setDescription( "Name of field that boundary condition is applied to." + "A field can represent a physical variable. (pressure, temperature, global composition fraction of the fluid, ...)" ); registerWrapper( viewKeyStruct::componentString(), &m_component ). setApplyDefaultValue( -1 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Component of field (if tensor) to apply boundary condition to." ); + setDescription( "Component of field (if tensor) to apply boundary condition to." + "The component must use the order in which the phaseNames have been defined in the Constitutive Element." ); registerWrapper( viewKeyStruct::directionString(), &m_direction ). setApplyDefaultValue( {0, 0, 0} ). @@ -65,7 +69,7 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par registerWrapper( viewKeyStruct::scaleString(), &m_scale ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Scale factor for value of the boundary condition." ); + setDescription( "Apply a scaling factor for the value of the boundary condition." ); registerWrapper( viewKeyStruct::initialConditionString(), &m_initialCondition ). setApplyDefaultValue( 0 ). diff --git a/src/coreComponents/functions/TableFunction.cpp b/src/coreComponents/functions/TableFunction.cpp index 1bb752fbebe..9a363cdd22a 100644 --- a/src/coreComponents/functions/TableFunction.cpp +++ b/src/coreComponents/functions/TableFunction.cpp @@ -69,7 +69,8 @@ TableFunction::TableFunction( const string & name, setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "When set to 1, write PVT tables into a CSV file.\n " - "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." ); + "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." + "Set to 0 by default" ); addLogLevel< logInfo::TableLogOutput >(); } From ef9ac904eb964cd3e318fc496f7289068bc357cb Mon Sep 17 00:00:00 2001 From: arng40 Date: Mon, 15 Sep 2025 15:44:05 +0200 Subject: [PATCH 05/16] update setName description --- .../fieldSpecification/FieldSpecificationBase.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index 4d27032cfe8..a7e81898db0 100644 --- a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp +++ b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp @@ -30,9 +30,9 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par setRTTypeName( rtTypes::CustomTypes::groupNameRefArray ). setInputFlag( InputFlags::REQUIRED ). setSizedFromParent( 0 ). - setDescription( "Names of sets that boundary condition is applied to." - "A set can contains heterogeneous elements in the mesh (volumnes, nodes, faces, edges)." - "A set can be defined by a `Geometry` component, or can be targeted with externalSet in cases of external mesh" ); + setDescription( "Name of sets that boundary condition is applied to." + "A set can contain heterogeneous elements in the mesh (volumes, nodes, faces, edges)." + "A set can contain by a 'Geometry' component, or correspond to imported sets in case of an external mesh" ); registerWrapper( viewKeyStruct::objectPathString(), &m_objectPath ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). From e41cf472452d8ec6e64407161f8f693df3bbe2da Mon Sep 17 00:00:00 2001 From: arng40 Date: Tue, 16 Sep 2025 11:13:48 +0200 Subject: [PATCH 06/16] syntax and review --- .../VanGenuchtenCapillaryPressure.cpp | 2 +- .../constitutive/docs/CO2BrineFluid.rst | 2 +- .../multifluid/CO2Brine/CO2BrineFluid.cpp | 5 +- .../reactive/ReactiveBrineFluid.cpp | 3 +- .../BrooksCoreyBakerRelativePermeability.cpp | 2 +- .../BrooksCoreyRelativePermeability.cpp | 4 +- .../solid/porosity/PorosityBase.cpp | 2 +- .../solid/porosity/PressurePorosity.cpp | 2 +- .../FieldSpecificationBase.cpp | 10 +- .../fileIO/Outputs/MemoryStatsOutput.cpp | 2 +- .../functions/TableFunction.cpp | 3 +- .../physicsSolvers/FieldStatisticsBase.hpp | 3 +- .../fluidFlow/CompositionalMultiphaseBase.cpp | 2 +- .../CompositionalMultiphaseStatistics.cpp | 2 +- .../fluidFlow/ImmiscibleMultiphaseFlow.cpp | 2 +- .../ReactiveCompositionalMultiphaseOBL.cpp | 2 +- .../fluidFlow/wells/WellControls.cpp | 2 +- .../fluidFlow/wells/WellSolverBase.cpp | 3 +- .../CoupledReservoirAndWellsBase.cpp | 1 + src/coreComponents/schema/schema.xsd | 262 +++++++++--------- src/coreComponents/schema/schema.xsd.other | 22 +- 21 files changed, 173 insertions(+), 165 deletions(-) diff --git a/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp b/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp index 6bc44cf97af..180d91b2667 100644 --- a/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp +++ b/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp @@ -36,7 +36,7 @@ VanGenuchtenCapillaryPressure::VanGenuchtenCapillaryPressure( string const & nam registerWrapper( viewKeyStruct::phaseMinVolumeFractionString(), &m_phaseMinVolumeFraction ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Minimum volume fraction value for each phase (expressed as a percentage) used to compute the relative permeability " ); + setDescription( "Minimum volume fraction value for each phase (between 0 and 1) used to compute the capillary pressure" ); registerWrapper( viewKeyStruct::phaseCapPressureExponentInvString(), &m_phaseCapPressureExponentInv ). setApplyDefaultValue( 0.5 ). diff --git a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst index e6e4ece8892..89bd56b0ea0 100644 --- a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst +++ b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst @@ -48,7 +48,7 @@ The user can parameterize the construction of the table by specifying the salini - **T_min**: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. - **T_max**: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. - **ΔT (Delta T)**: The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. -- **Salinity**: alinity is expressed in molality (moles of NaCl per kg of brine). +- **Salinity**: Salinity is expressed in molality (moles of NaCl per kg of brine). The temperature must be between 283.15 and 623.15 Kelvin. The table is populated using the model of Duan and Sun (2003). diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index 8bbc81f9120..fc78b83c8cc 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -105,9 +105,8 @@ CO2BrineFluid( string const & name, Group * const parent ): registerWrapper( viewKeyStruct::writeCSVFlagString(), &m_writeCSV ). setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). - setDescription( "When set to 1, write PVT tables into a CSV file.\n " - "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." - "Set to 0 by default" ). + setDescription( "When set to 1, write PVT tables into a CSV file.\n" + "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." ). setDefaultValue( 0 ); registerWrapper( viewKeyStruct::checkPhasePresenceString(), &m_checkPhasePresence ). diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 84b3966a152..08b173a5516 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -76,8 +76,7 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "When set to 1, write PVT tables into a CSV file.\n" - "If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." - "Set to 0 by default" ); + "If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0."); // if this is a thermal model, we need to make sure that the arrays will be properly displayed and saved to restart if( isThermal() ) diff --git a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp index a650908e334..42d895b69b9 100644 --- a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp +++ b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyBakerRelativePermeability.cpp @@ -34,7 +34,7 @@ BrooksCoreyBakerRelativePermeability::BrooksCoreyBakerRelativePermeability( stri registerWrapper( viewKeyStruct::phaseMinVolumeFractionString(), &m_phaseMinVolumeFraction ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Minimum volume fraction value for each phase (expressed as a percentage) used to compute the relative permeability " ); + setDescription( "Minimum volume fraction value for each phase (between 0 and 1) used to compute the relative permeability " ); registerWrapper( viewKeyStruct::waterOilRelPermExponentString(), &m_waterOilRelPermExponent ). setApplyDefaultValue( 1.0 ). diff --git a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp index 5b51f8ae277..4212cde703a 100644 --- a/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp +++ b/src/coreComponents/constitutive/relativePermeability/BrooksCoreyRelativePermeability.cpp @@ -38,7 +38,7 @@ BrooksCoreyRelativePermeability::BrooksCoreyRelativePermeability( string const & registerWrapper( viewKeyStruct::phaseMinVolumeFractionString(), &m_phaseMinVolumeFraction ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Minimum volume fraction value for each phase (expressed as a percentage) used to compute the relative permeability " ); + setDescription( "Minimum volume fraction value for each phase (between 0 and 1) used to compute the relative permeability " ); registerWrapper( viewKeyStruct::phaseRelPermExponentString(), &m_phaseRelPermExponent ). setApplyDefaultValue( 1.0 ). @@ -49,7 +49,7 @@ BrooksCoreyRelativePermeability::BrooksCoreyRelativePermeability( string const & registerWrapper( viewKeyStruct::phaseRelPermMaxValueString(), &m_phaseRelPermMaxValue ). setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Ratio between a phase's permeability and the maximum permeability of the rock, for each phase." ); + setDescription( "Maximum relative permeability value for each phase" ); registerWrapper( viewKeyStruct::volFracScaleString(), &m_volFracScale ). setApplyDefaultValue( 1.0 ). diff --git a/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp b/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp index 82ed50730a7..1c2cf876aff 100644 --- a/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp +++ b/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp @@ -34,7 +34,7 @@ PorosityBase::PorosityBase( string const & name, Group * const parent ): { registerWrapper( viewKeyStruct::defaultReferencePorosityString(), &m_defaultReferencePorosity ). setInputFlag( InputFlags::REQUIRED ). - setDescription( "The default porosity value of the rock at the referencePressure" ); + setDescription( "The default porosity value of the rock at the reference pressure" ); registerField< fields::porosity::porosity >( &m_newPorosity ); diff --git a/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp b/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp index 6c7e1998717..249b669c66a 100644 --- a/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp +++ b/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp @@ -32,7 +32,7 @@ PressurePorosity::PressurePorosity( string const & name, Group * const parent ): { registerWrapper( viewKeyStruct::referencePressureString(), &m_referencePressure ). setInputFlag( InputFlags::REQUIRED ). - setDescription( "Reference pressure for solid compressibility[Pa]" ); + setDescription( "Reference pressure for solid compressibility [Pa]" ); registerWrapper( viewKeyStruct::compressibilityString(), &m_compressibility ). setInputFlag( InputFlags::REQUIRED ). diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index a7e81898db0..5eecceb6df2 100644 --- a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp +++ b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp @@ -30,9 +30,9 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par setRTTypeName( rtTypes::CustomTypes::groupNameRefArray ). setInputFlag( InputFlags::REQUIRED ). setSizedFromParent( 0 ). - setDescription( "Name of sets that boundary condition is applied to." - "A set can contain heterogeneous elements in the mesh (volumes, nodes, faces, edges)." - "A set can contain by a 'Geometry' component, or correspond to imported sets in case of an external mesh" ); + setDescription( "Name of sets that the boundary condition is applied to.\n" + "A set can contain heterogeneous elements in the mesh (volumes, nodes, faces, edges).\n" + "A set can be created by a 'Geometry' component, or correspond to imported sets in case of an external mesh" ); registerWrapper( viewKeyStruct::objectPathString(), &m_objectPath ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). @@ -42,13 +42,13 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par registerWrapper( viewKeyStruct::fieldNameString(), &m_fieldName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Name of field that boundary condition is applied to." + setDescription( "Name of field that boundary condition is applied to.\n" "A field can represent a physical variable. (pressure, temperature, global composition fraction of the fluid, ...)" ); registerWrapper( viewKeyStruct::componentString(), &m_component ). setApplyDefaultValue( -1 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Component of field (if tensor) to apply boundary condition to." + setDescription( "Component of field (if tensor) to apply boundary condition to.\n" "The component must use the order in which the phaseNames have been defined in the Constitutive Element." ); registerWrapper( viewKeyStruct::directionString(), &m_direction ). diff --git a/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp b/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp index 6dd20a9b2ca..b974f095209 100644 --- a/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp +++ b/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp @@ -42,7 +42,7 @@ MemoryStatsOutput::MemoryStatsOutput( string const & name, this->registerWrapper( viewKeysStruct::writeCSV, &m_writeCSV ). setApplyDefaultValue( csvOutputDefault ? 1 : 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the same statistics as the 'logLevel' allows to output in a CSV file" + setDescription( "When set to 1, write the same statistics as the 'logLevel' allows to output in a CSV file\n" "If the umpire statistics log is enabled, set to 1 by default, otherwise set to 0" ); } diff --git a/src/coreComponents/functions/TableFunction.cpp b/src/coreComponents/functions/TableFunction.cpp index 9a363cdd22a..828724315ba 100644 --- a/src/coreComponents/functions/TableFunction.cpp +++ b/src/coreComponents/functions/TableFunction.cpp @@ -69,8 +69,7 @@ TableFunction::TableFunction( const string & name, setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "When set to 1, write PVT tables into a CSV file.\n " - "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." - "Set to 0 by default" ); + "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0."); addLogLevel< logInfo::TableLogOutput >(); } diff --git a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp index b3456a18d29..c67eed1c217 100644 --- a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp +++ b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp @@ -59,8 +59,7 @@ class FieldStatisticsBase : public TaskBase this->registerWrapper( viewKeyStruct::writeCSVFlagString(), &m_writeCSV ). setApplyDefaultValue( 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the statistics into a CSV file" - "Set to 0 by default" ); + setDescription( "When set to 1, write the statistics into a CSV file" ); } /** diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index 5b08ea6d556..ae8fbcaae8d 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -115,7 +115,7 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); + setDescription( "Target (absolute) change in the phase volume fraction within a single time step." ); this->registerWrapper( viewKeyStruct::targetRelativeCompDensChangeString(), &m_targetRelativeCompDensChange ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp index 244bb884c42..ed8d8e5eb80 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp @@ -51,7 +51,7 @@ CompositionalMultiphaseStatistics::CompositionalMultiphaseStatistics( const stri registerWrapper( viewKeyStruct::computeCFLNumbersString(), &m_computeCFLNumbers ). setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Flag to decide whether CFL numbers are computed or not, used to calculate a safe time-step for the simulation" ); + setDescription( "Flag to decide whether CFL numbers are computed or not" ); registerWrapper( viewKeyStruct::computeRegionStatisticsString(), &m_computeRegionStatistics ). setApplyDefaultValue( 1 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp index 7af524e8787..8d911c7815c 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp @@ -90,7 +90,7 @@ ImmiscibleMultiphaseFlow::ImmiscibleMultiphaseFlow( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); + setDescription( "Target (absolute) change in the phase volume fraction within a single time step." ); } void ImmiscibleMultiphaseFlow::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index cf59d9751b2..7345925e7b2 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -94,7 +94,7 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st this->registerWrapper( viewKeyStruct::maxCompFracChangeString(), &m_maxCompFracChange ). setApplyDefaultValue( 1.0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Maximum (absolute) allowed change in the composition fraction of any component within a single time step, in a Newton iteration" ); + setDescription( "Maximum (absolute) change in the composition fraction of any component within a single time step, in a Newton iteration" ); this->registerWrapper( viewKeyStruct::transMultExpString(), &m_transMultExp ). setApplyDefaultValue( 1.0 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index f84138f12f4..3c74e239ded 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -72,7 +72,7 @@ WellControls::WellControls( string const & name, Group * const parent ) setDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::WRITE_AND_READ ). - setDescription( "The Bottom Hole Pressure [Pa] being targeted during the injection." ); + setDescription( "The target bottom-hole pressure [Pa] for the well." ); registerWrapper( viewKeyStruct::targetTotalRateString(), &m_targetTotalRate ). setDefaultValue( 0.0 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp index af15ea606ad..0c768111656 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp @@ -56,8 +56,7 @@ WellSolverBase::WellSolverBase( string const & name, this->registerWrapper( viewKeyStruct::writeCSVFlagString(), &m_writeCSV ). setApplyDefaultValue( 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the rates into a CSV file" - "Set to 0 by default" ); + setDescription( "When set to 1, write the rates into a CSV file"); this->registerWrapper( viewKeyStruct::timeStepFromTablesFlagString(), &m_timeStepFromTables ). setApplyDefaultValue( 0 ). diff --git a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp index 0c01d00945c..03d77d5fff5 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp @@ -154,6 +154,7 @@ bool validateWellPerforations( PhysicsSolverBase const * const reservoirSolver, localIndex const hasBadPerforations = MpiWrapper::max( badPerforation.first.empty() ? 0 : 1 ); + std::cout << "badPerforation "<< LvArray::system::demangle( typeid(decltype(badPerforation.second)::value_type).name()) << std::endl; GEOS_THROW_IF( !badPerforation.first.empty(), GEOS_FMT( "{}: The well {} has a connection to the region {} which is not targeted by the flow solver", wellSolver->getDataContext(), badPerforation.first, badPerforation.second ), diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index 64de5523946..b3babd66fc3 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -1238,9 +1238,9 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1250,13 +1250,13 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1264,9 +1264,9 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1276,13 +1276,13 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1290,9 +1290,9 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1326,7 +1326,7 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1338,7 +1338,7 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1350,9 +1350,9 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1374,7 +1374,7 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1388,7 +1388,7 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1412,11 +1412,11 @@ This keyword is ignored for single-phase flow simulations--> - + - + + if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.Set to 0 by default--> @@ -2164,6 +2164,16 @@ Information output from lower logLevels is added with the desired log level + + + + + + + + + + - + @@ -2572,7 +2582,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -2623,7 +2633,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -2711,7 +2721,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -2800,7 +2810,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -2888,7 +2898,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -2937,7 +2947,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -2971,7 +2981,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -2996,7 +3006,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3057,7 +3067,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3081,7 +3091,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3104,7 +3114,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3145,7 +3155,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3196,7 +3206,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -3237,7 +3247,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3255,12 +3265,12 @@ Information output from lower logLevels is added with the desired log level - + +When set to 2 also output convergence information to a csv--> @@ -3281,7 +3291,7 @@ When set to 2 output convergence information to a csv--> - Injector pressure at reference depth initialized as: (1+initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) - Producer pressure at reference depth initialized as: (1-initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) --> - + @@ -3303,7 +3313,7 @@ If the status function evaluates to a positive value at the current time, the we - + @@ -3425,7 +3435,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3521,7 +3531,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3564,7 +3574,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3606,7 +3616,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3646,7 +3656,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3686,7 +3696,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3754,7 +3764,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -3803,7 +3813,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3818,7 +3828,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3862,7 +3872,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3904,7 +3914,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -3947,7 +3957,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4003,7 +4013,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -4054,7 +4064,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -4095,7 +4105,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4135,7 +4145,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4184,7 +4194,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4234,7 +4244,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4274,7 +4284,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4335,7 +4345,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4379,7 +4389,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -4402,7 +4412,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4447,7 +4457,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4501,7 +4511,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4555,7 +4565,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4608,7 +4618,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -4661,7 +4671,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -4701,7 +4711,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4754,7 +4764,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -4794,7 +4804,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4848,7 +4858,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4888,7 +4898,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -4941,7 +4951,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -4994,7 +5004,7 @@ Local- Add jump stabilization on interior of macro elements--> +When set to 2 also output convergence information to a csv--> @@ -5034,12 +5044,12 @@ Information output from lower logLevels is added with the desired log level - + +When set to 2 also output convergence information to a csv--> @@ -5115,7 +5125,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -5182,7 +5192,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -5202,6 +5212,8 @@ When set to 2 output convergence information to a csv--> + + + + +When set to 2 also output convergence information to a csv--> @@ -5306,7 +5320,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -5368,7 +5382,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -5450,7 +5464,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -5508,7 +5522,7 @@ Information output from lower logLevels is added with the desired log level +When set to 2 also output convergence information to a csv--> @@ -5565,7 +5579,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5579,7 +5593,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5781,7 +5795,7 @@ Information output from lower logLevels is added with the desired log level 1 - Print statistics--> - + @@ -5794,7 +5808,7 @@ Information output from lower logLevels is added with the desired log level 1 - Information on solver execution 2 - - More precise information on solver execution--> + - More precise information on solver execution, including iterations statistics after every cycle--> @@ -5811,7 +5825,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5830,7 +5844,7 @@ Information output from lower logLevels is added with the desired log level 3 - Print statistics for each source flux in each regions--> - + @@ -5974,7 +5988,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5984,7 +5998,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -6020,7 +6034,7 @@ The expected format is "{ gasExp, oilExp }", in that order--> - + @@ -6048,13 +6062,13 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + - + @@ -6084,7 +6098,7 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + @@ -6103,7 +6117,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will + if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.Set to 0 by default--> @@ -6113,7 +6127,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6132,7 +6146,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will + if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.Set to 0 by default--> @@ -6142,7 +6156,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6161,7 +6175,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will + if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.Set to 0 by default--> @@ -6171,7 +6185,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6190,7 +6204,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will + if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.Set to 0 by default--> @@ -6240,7 +6254,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6268,7 +6282,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6328,7 +6342,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6369,7 +6383,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6413,7 +6427,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6455,7 +6469,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6468,7 +6482,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6636,7 +6650,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6712,7 +6726,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6948,7 +6962,7 @@ For instance, if "oil" is before "gas" in "phaseNames", the table order should b - + @@ -7282,7 +7296,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7293,11 +7307,11 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + - + - + @@ -7311,7 +7325,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7321,7 +7335,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7337,7 +7351,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7393,7 +7407,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7408,7 +7422,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.Set to 0 by default--> @@ -7416,7 +7430,7 @@ If the table is requested to be output in the log, and it is too large, a CSV fi - + @@ -7431,7 +7445,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.Set to 0 by default--> @@ -7554,7 +7568,7 @@ To neglect hysteresis on this phase, just use the same table name for the draina - + @@ -7574,7 +7588,7 @@ To neglect hysteresis on this phase, just use the same table name for the draina - + @@ -7635,7 +7649,7 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + diff --git a/src/coreComponents/schema/schema.xsd.other b/src/coreComponents/schema/schema.xsd.other index e3d4e22da8a..d9514b13ad7 100644 --- a/src/coreComponents/schema/schema.xsd.other +++ b/src/coreComponents/schema/schema.xsd.other @@ -302,11 +302,11 @@ - + - + @@ -314,29 +314,29 @@ - + - + - + - + - + - + - + @@ -1587,7 +1587,7 @@ - + @@ -2614,8 +2614,6 @@ - - From 7072f3279d456124fcad1377e3af1a2c132ab01f Mon Sep 17 00:00:00 2001 From: arng40 Date: Tue, 16 Sep 2025 11:21:13 +0200 Subject: [PATCH 07/16] remove debug print fix description --- .../physicsSolvers/fluidFlow/wells/WellControls.cpp | 2 +- .../multiphysics/CoupledReservoirAndWellsBase.cpp | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index 3c74e239ded..292599460d4 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -108,7 +108,7 @@ WellControls::WellControls( string const & name, Group * const parent ) setDefaultValue( -1 ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Defines the global component of the injected fluid in the reservoir as a fraction of its components [moles/m^3 or kg/m^3]" ); + setDescription( "Defines the global component densities of the injected fluid in the reservoir as a fraction of its components [moles/m^3 or kg/m^3]" ); registerWrapper( viewKeyStruct::injectionTemperatureString(), &m_injectionTemperature ). setDefaultValue( -1 ). diff --git a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp index 03d77d5fff5..0c01d00945c 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.cpp @@ -154,7 +154,6 @@ bool validateWellPerforations( PhysicsSolverBase const * const reservoirSolver, localIndex const hasBadPerforations = MpiWrapper::max( badPerforation.first.empty() ? 0 : 1 ); - std::cout << "badPerforation "<< LvArray::system::demangle( typeid(decltype(badPerforation.second)::value_type).name()) << std::endl; GEOS_THROW_IF( !badPerforation.first.empty(), GEOS_FMT( "{}: The well {} has a connection to the region {} which is not targeted by the flow solver", wellSolver->getDataContext(), badPerforation.first, badPerforation.second ), From a3f15285861fa0757023439fb2c31cb0f7fd7ddb Mon Sep 17 00:00:00 2001 From: arng40 Date: Wed, 24 Sep 2025 14:35:50 +0200 Subject: [PATCH 08/16] xsd --- src/coreComponents/schema/schema.xsd | 101 ++++++++++++--------- src/coreComponents/schema/schema.xsd.other | 28 ++++-- 2 files changed, 79 insertions(+), 50 deletions(-) diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index b3babd66fc3..f3fc78a82b5 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -1240,7 +1240,9 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1250,13 +1252,15 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1266,7 +1270,9 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1276,13 +1282,15 @@ This keyword is ignored for single-phase flow simulations--> - + - + @@ -1292,7 +1300,9 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1338,7 +1348,8 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1352,7 +1363,9 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1374,7 +1387,8 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1388,7 +1402,9 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1416,7 +1432,9 @@ This keyword is ignored for single-phase flow simulations--> - + + if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -2312,7 +2330,8 @@ Information output from lower logLevels is added with the desired log level - Output timing information - The statistics (minimal, maximal, average and sum) of memory usage of each Umpire memory pool across all ranks.--> - + @@ -2981,7 +3000,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3091,7 +3110,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3265,7 +3284,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3291,7 +3310,7 @@ When set to 2 also output convergence information to a csv--> - Injector pressure at reference depth initialized as: (1+initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) - Producer pressure at reference depth initialized as: (1-initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) --> - + @@ -3313,7 +3332,7 @@ If the status function evaluates to a positive value at the current time, the we - + @@ -3813,7 +3832,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -4389,7 +4408,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5044,7 +5063,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5579,7 +5598,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5593,7 +5612,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5795,7 +5814,7 @@ Information output from lower logLevels is added with the desired log level 1 - Print statistics--> - + @@ -5825,7 +5844,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5844,7 +5863,7 @@ Information output from lower logLevels is added with the desired log level 3 - Print statistics for each source flux in each regions--> - + @@ -5988,7 +6007,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -6034,7 +6053,7 @@ The expected format is "{ gasExp, oilExp }", in that order--> - + @@ -6062,13 +6081,13 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + - + @@ -6117,7 +6136,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -6146,7 +6165,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -6175,7 +6194,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -6204,7 +6223,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -7309,9 +7328,9 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + - + @@ -7325,7 +7344,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7422,7 +7441,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -7445,7 +7464,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -7649,7 +7668,7 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + diff --git a/src/coreComponents/schema/schema.xsd.other b/src/coreComponents/schema/schema.xsd.other index d9514b13ad7..015c9c4f90a 100644 --- a/src/coreComponents/schema/schema.xsd.other +++ b/src/coreComponents/schema/schema.xsd.other @@ -302,11 +302,13 @@ - + - + @@ -314,29 +316,37 @@ - + - + - + - + - + - + - + From a6e620fa79634bef941d4157b6f0b65208212218 Mon Sep 17 00:00:00 2001 From: arng40 Date: Thu, 16 Oct 2025 17:40:16 +0200 Subject: [PATCH 09/16] 2nd pass of review --- .../fluid/multifluid/reactive/ReactiveBrineFluid.cpp | 3 ++- .../fieldSpecification/FieldSpecificationBase.cpp | 4 ++-- .../physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp | 2 +- .../physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp | 2 +- .../physicsSolvers/fluidFlow/wells/WellSolverBase.cpp | 2 +- 5 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 08b173a5516..70dca0007d6 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -76,7 +76,8 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "When set to 1, write PVT tables into a CSV file.\n" - "If the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0."); + "If the table is requested to be output in the log, and it is too large," + "a CSV file will be generated even if `writeCSV` is set to 0." ); // if this is a thermal model, we need to make sure that the arrays will be properly displayed and saved to restart if( isThermal() ) diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index f00a5f2ab90..83831c4e77c 100644 --- a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp +++ b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp @@ -30,9 +30,9 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par setRTTypeName( rtTypes::CustomTypes::groupNameRefArray ). setInputFlag( InputFlags::REQUIRED ). setSizedFromParent( 0 ). - setDescription( "Name of sets that the boundary condition is applied to.\n" + setDescription( "Names of sets that the boundary condition is applied to.\n" "A set can contain heterogeneous elements in the mesh (volumes, nodes, faces, edges).\n" - "A set can be created by a 'Geometry' component, or correspond to imported sets in case of an external mesh" ); + "A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh" ); registerWrapper( viewKeyStruct::objectPathString(), &m_objectPath ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index ae8fbcaae8d..5b08ea6d556 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -115,7 +115,7 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) change in the phase volume fraction within a single time step." ); + setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); this->registerWrapper( viewKeyStruct::targetRelativeCompDensChangeString(), &m_targetRelativeCompDensChange ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp index 8d911c7815c..7af524e8787 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp @@ -90,7 +90,7 @@ ImmiscibleMultiphaseFlow::ImmiscibleMultiphaseFlow( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) change in the phase volume fraction within a single time step." ); + setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); } void ImmiscibleMultiphaseFlow::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp index 0c768111656..1273260b70f 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp @@ -56,7 +56,7 @@ WellSolverBase::WellSolverBase( string const & name, this->registerWrapper( viewKeyStruct::writeCSVFlagString(), &m_writeCSV ). setApplyDefaultValue( 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the rates into a CSV file"); + setDescription( "When set to 1, write the rates into a CSV file."); this->registerWrapper( viewKeyStruct::timeStepFromTablesFlagString(), &m_timeStepFromTables ). setApplyDefaultValue( 0 ). From ecafd3d961ffb0b3dfd0def0695f7df7aa34bbd4 Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 17 Oct 2025 09:54:01 +0200 Subject: [PATCH 10/16] remove allowable --- .../physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp | 4 ++-- .../physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index 0322a6ee873..a0df9b8870a 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -104,7 +104,7 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, this->registerWrapper( viewKeyStruct::targetRelativePresChangeString(), &m_targetRelativePresChange ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setApplyDefaultValue( 0.2 ). + setApplyDefaultValue( 0.2 ). setDescription( "Target (relative) change in pressure in a time step (expected value between 0 and 1)" ); this->registerWrapper( viewKeyStruct::targetRelativeTempChangeString(), &m_targetRelativeTempChange ). setSizedFromParent( 0 ). @@ -115,7 +115,7 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); + setDescription( "Target (absolute) change in the phase volume fraction within a single time step." ); this->registerWrapper( viewKeyStruct::targetRelativeCompDensChangeString(), &m_targetRelativeCompDensChange ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp index 93dfefec933..a198a78cb17 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp @@ -90,7 +90,7 @@ ImmiscibleMultiphaseFlow::ImmiscibleMultiphaseFlow( const string & name, setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.2 ). - setDescription( "Target (absolute) allowable change in the phase volume fraction within a single time step." ); + setDescription( "Target (absolute) change in the phase volume fraction within a single time step." ); } void ImmiscibleMultiphaseFlow::postInputInitialization() From 3b1ae644b2362b8ccd9b93eb9c30f98f9edca0b2 Mon Sep 17 00:00:00 2001 From: arng40 Date: Mon, 20 Oct 2025 14:17:29 +0200 Subject: [PATCH 11/16] coordinates convention --- src/coreComponents/mesh/docs/Mesh.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/coreComponents/mesh/docs/Mesh.rst b/src/coreComponents/mesh/docs/Mesh.rst index 829d4a9a59d..23892c2d84c 100644 --- a/src/coreComponents/mesh/docs/Mesh.rst +++ b/src/coreComponents/mesh/docs/Mesh.rst @@ -13,6 +13,9 @@ or by importing meshes from various common mesh file formats. This latter options allows one to work with more complex geometries, such as unstructured meshes comprised of a variety of element types (polyhedral elements). +.. note:: + GEOS is a right-handed coordinate system: x: right, y: forward, z: upward. + ************************ Internal Mesh Generation ************************ From 55d45f7d5f11b7a0cd7c8f41d546202f72cecdad Mon Sep 17 00:00:00 2001 From: arng40 Date: Tue, 21 Oct 2025 15:04:05 +0200 Subject: [PATCH 12/16] updates review --- src/coreComponents/constitutive/docs/CO2BrineFluid.rst | 2 +- src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp | 3 +-- src/coreComponents/mesh/docs/Mesh.rst | 3 ++- .../physicsSolvers/fluidFlow/wells/WellControls.cpp | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst index 89bd56b0ea0..b3f2cff81e4 100644 --- a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst +++ b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst @@ -168,7 +168,7 @@ The user specifies the (constant) salinity and defines the pressure and temperat - **T_min**: The minimum temperature value [K] for the density table. This sets the lower boundary of the temperature range. - **T_max**: The maximum temperature value [K] for the density table. It sets the upper boundary of the temperature range. - **ΔT (Delta T)**: The increment in temperature [K] between successive values in the temperature axis of the table. It defines the resolution of the temperature dimension. -- **Salinity**: alinity is expressed in molality (moles of NaCl per kg of brine). +- **Salinity**: Salinity is expressed in molality (moles of NaCl per kg of brine). The pressure must be in Pascal and must be less than :math:`5 \times 10^7` Pascal. The temperature must be in Kelvin and must be between 283.15 and 623.15 Kelvin. diff --git a/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp b/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp index b974f095209..f35719d27d3 100644 --- a/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp +++ b/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp @@ -42,8 +42,7 @@ MemoryStatsOutput::MemoryStatsOutput( string const & name, this->registerWrapper( viewKeysStruct::writeCSV, &m_writeCSV ). setApplyDefaultValue( csvOutputDefault ? 1 : 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the same statistics as the 'logLevel' allows to output in a CSV file\n" - "If the umpire statistics log is enabled, set to 1 by default, otherwise set to 0" ); + setDescription( "When set to 1, write the statistics into a CSV file.\nWhen set to 0, no output" ); } void MemoryStatsOutput::postInputInitialization() diff --git a/src/coreComponents/mesh/docs/Mesh.rst b/src/coreComponents/mesh/docs/Mesh.rst index 23892c2d84c..d74635c849c 100644 --- a/src/coreComponents/mesh/docs/Mesh.rst +++ b/src/coreComponents/mesh/docs/Mesh.rst @@ -14,7 +14,8 @@ This latter options allows one to work with more complex geometries, such as unstructured meshes comprised of a variety of element types (polyhedral elements). .. note:: - GEOS is a right-handed coordinate system: x: right, y: forward, z: upward. + GEOS uses a right-handed Cartesian coordinate system (X: right, Y: forward, Z: upward) that is consistently applied throughout the mesh definition and discretization processes. + This convention affects mesh topology, and finite element / volume computations. ************************ Internal Mesh Generation diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index 292599460d4..e47c1711e1e 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -108,7 +108,7 @@ WellControls::WellControls( string const & name, Group * const parent ) setDefaultValue( -1 ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Defines the global component densities of the injected fluid in the reservoir as a fraction of its components [moles/m^3 or kg/m^3]" ); + setDescription( "Defines the global component fractions of the injected fluid." ); registerWrapper( viewKeyStruct::injectionTemperatureString(), &m_injectionTemperature ). setDefaultValue( -1 ). From 487ef130dad9fd29e60a1d504d17d20705cb0956 Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 24 Oct 2025 09:52:16 +0200 Subject: [PATCH 13/16] code style --- src/coreComponents/functions/TableFunction.cpp | 2 +- .../physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp | 2 +- .../physicsSolvers/fluidFlow/wells/WellSolverBase.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/coreComponents/functions/TableFunction.cpp b/src/coreComponents/functions/TableFunction.cpp index 828724315ba..1bb752fbebe 100644 --- a/src/coreComponents/functions/TableFunction.cpp +++ b/src/coreComponents/functions/TableFunction.cpp @@ -69,7 +69,7 @@ TableFunction::TableFunction( const string & name, setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "When set to 1, write PVT tables into a CSV file.\n " - "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0."); + "if the table is requested to be output in the log, and it is too large, a CSV file will be generated even if `writeCSV` is set to 0." ); addLogLevel< logInfo::TableLogOutput >(); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index a0df9b8870a..70d803f6c0c 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -104,7 +104,7 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, this->registerWrapper( viewKeyStruct::targetRelativePresChangeString(), &m_targetRelativePresChange ). setSizedFromParent( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setApplyDefaultValue( 0.2 ). + setApplyDefaultValue( 0.2 ). setDescription( "Target (relative) change in pressure in a time step (expected value between 0 and 1)" ); this->registerWrapper( viewKeyStruct::targetRelativeTempChangeString(), &m_targetRelativeTempChange ). setSizedFromParent( 0 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp index 1273260b70f..b74ac5c6907 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp @@ -56,7 +56,7 @@ WellSolverBase::WellSolverBase( string const & name, this->registerWrapper( viewKeyStruct::writeCSVFlagString(), &m_writeCSV ). setApplyDefaultValue( 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). - setDescription( "When set to 1, write the rates into a CSV file."); + setDescription( "When set to 1, write the rates into a CSV file." ); this->registerWrapper( viewKeyStruct::timeStepFromTablesFlagString(), &m_timeStepFromTables ). setApplyDefaultValue( 0 ). From 3a4c60b3edc483ab877a295699879fe0a01099f5 Mon Sep 17 00:00:00 2001 From: arng40 Date: Wed, 29 Oct 2025 14:48:44 +0100 Subject: [PATCH 14/16] xsd --- src/coreComponents/schema/schema.xsd | 42 +++++++++++----------- src/coreComponents/schema/schema.xsd.other | 8 ++--- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index 72c35ec44af..5422816f2af 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -1294,9 +1294,9 @@ When set to "error", output a throw. - +A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh--> @@ -1335,9 +1335,9 @@ A field can represent a physical variable. (pressure, temperature, global compos - +A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh--> @@ -1371,9 +1371,9 @@ A field can represent a physical variable. (pressure, temperature, global compos - +A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh--> @@ -1446,9 +1446,9 @@ When set to "error", output a throw. - +A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh--> @@ -1491,9 +1491,9 @@ When set to "error", output a throw. - +A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh--> @@ -1527,9 +1527,9 @@ When set to "error", output a throw. - +A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh--> - + @@ -3535,7 +3535,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3562,7 +3562,7 @@ When set to `all` output both convergence & iteration information to a csv.--> - Injector pressure at reference depth initialized as: (1+initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) - Producer pressure at reference depth initialized as: (1-initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) --> - + @@ -5347,7 +5347,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -6804,7 +6804,7 @@ if the table is requested to be output in the log, and it is too large, a CSV fi - + @@ -6844,7 +6844,7 @@ if the table is requested to be output in the log, and it is too large, a CSV fi - + @@ -7945,7 +7945,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +If the table is requested to be output in the log, and it is too large,a CSV file will be generated even if `writeCSV` is set to 0.--> @@ -7968,7 +7968,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will +If the table is requested to be output in the log, and it is too large,a CSV file will be generated even if `writeCSV` is set to 0.--> diff --git a/src/coreComponents/schema/schema.xsd.other b/src/coreComponents/schema/schema.xsd.other index 4bffcbe478b..985679156d9 100644 --- a/src/coreComponents/schema/schema.xsd.other +++ b/src/coreComponents/schema/schema.xsd.other @@ -324,9 +324,9 @@ A field can represent a physical variable. (pressure, temperature, global compos - +A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh--> @@ -526,7 +526,7 @@ A field can represent a physical variable. (pressure, temperature, global compos - + @@ -1512,7 +1512,7 @@ A field can represent a physical variable. (pressure, temperature, global compos - + From c330bacbe55fdf6a513dd99c26d471c36487cec6 Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 21 Nov 2025 15:57:44 +0100 Subject: [PATCH 15/16] regenerate readthedoc --- src/main/main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/main.cpp b/src/main/main.cpp index 14750a4d4a1..62c9b2449f0 100644 --- a/src/main/main.cpp +++ b/src/main/main.cpp @@ -75,7 +75,7 @@ int main( int argc, char *argv[] ) return 0; } catch( std::exception const & e ) - { + { GEOS_LOG( e.what() ); if( ErrorLogger::global().isOutputFileEnabled() ) { From 04bc5496c04355d9745dceb94ef7a9cbd21e0a53 Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 21 Nov 2025 16:42:33 +0100 Subject: [PATCH 16/16] style --- src/main/main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/main.cpp b/src/main/main.cpp index 62c9b2449f0..14750a4d4a1 100644 --- a/src/main/main.cpp +++ b/src/main/main.cpp @@ -75,7 +75,7 @@ int main( int argc, char *argv[] ) return 0; } catch( std::exception const & e ) - { + { GEOS_LOG( e.what() ); if( ErrorLogger::global().isOutputFileEnabled() ) {