diff --git a/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp b/src/coreComponents/constitutive/capillaryPressure/VanGenuchtenCapillaryPressure.cpp index 6d830c59ef9..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" ); + 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 2a3e001fc46..b3f2cff81e4 100644 --- a/src/coreComponents/constitutive/docs/CO2BrineFluid.rst +++ b/src/coreComponents/constitutive/docs/CO2BrineFluid.rst @@ -40,7 +40,16 @@ 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). +**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**: 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). 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`. @@ -92,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}`: @@ -110,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: @@ -133,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**: 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. -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:: diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index 58322520aff..470cc72f920 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -105,7 +105,7 @@ 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 " + 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 ); diff --git a/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp b/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp index 3deec40ea99..818185519f0 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/MultiFluidBase.cpp @@ -41,7 +41,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/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index b400a5124f1..7371e60d080 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/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp b/src/coreComponents/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp index 343f220f155..db5e2733f97 100644 --- a/src/coreComponents/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp +++ b/src/coreComponents/constitutive/fluid/singlefluid/CompressibleSinglePhaseFluid.cpp @@ -43,7 +43,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 ). @@ -53,7 +53,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 b39cba9d6bf..6a996fd89d0 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 ecffd7ccab0..319cc204531 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 5893bc00d61..71e9bf5269e 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 (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 9e19941f1e7..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" ); + 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 ). diff --git a/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp b/src/coreComponents/constitutive/solid/porosity/PorosityBase.cpp index fcc2cd610c2..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( "Default value of the reference porosity" ); + 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 2e090fa0ec8..249b669c66a 100644 --- a/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp +++ b/src/coreComponents/constitutive/solid/porosity/PressurePorosity.cpp @@ -32,11 +32,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]" ); } REGISTER_CATALOG_ENTRY( ConstitutiveBase, PressurePorosity, string const &, Group * const ) diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index 841ec1abcc0..47209289471 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 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 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 ). @@ -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.\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 ). 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/fileIO/Outputs/MemoryStatsOutput.cpp b/src/coreComponents/fileIO/Outputs/MemoryStatsOutput.cpp index 340a6865fb7..f35719d27d3 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 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 829d4a9a59d..d74635c849c 100644 --- a/src/coreComponents/mesh/docs/Mesh.rst +++ b/src/coreComponents/mesh/docs/Mesh.rst @@ -13,6 +13,10 @@ 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 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/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index 8089089777f..290fbed04ab 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) 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/ImmiscibleMultiphaseFlow.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ImmiscibleMultiphaseFlow.cpp index 389a33357b7..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) change in phase volume fraction in a 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 48f6b85b6af..0d73fce12dd 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) 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 3b8184a1a38..35a4e16e8ce 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 098d80beac0..b4810fcf845 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 target bottom-hole pressure [Pa] for the well." ); 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 fractions of the injected fluid." ); registerWrapper( viewKeyStruct::injectionTemperatureString(), &m_injectionTemperature ). setDefaultValue( -1 ). diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellSolverBase.cpp index daeeffef3c1..ae3c853e9a0 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 ). diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index e29fdc5fd0b..0d6554b6eef 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -1300,9 +1300,11 @@ When set to "error", output a throw. - + - + @@ -1317,7 +1319,8 @@ When set to "error", output a throw. - + @@ -1329,7 +1332,8 @@ When set to "warning", output a warning. When set to "error", output a throw. --> - + @@ -1337,9 +1341,11 @@ When set to "error", output a throw. - + - + @@ -1349,7 +1355,8 @@ When set to "error", output a throw. - + @@ -1361,7 +1368,8 @@ When set to "warning", output a warning. When set to "error", output a throw. --> - + @@ -1369,9 +1377,11 @@ When set to "error", output a throw. - + - + @@ -1411,7 +1421,7 @@ When set to "error", output a throw. - + @@ -1423,7 +1433,8 @@ When set to "error", output a throw. - + @@ -1441,9 +1452,11 @@ When set to "error", output a throw. - + - + @@ -1465,7 +1478,8 @@ When set to "error", output a throw. - + @@ -1485,7 +1499,9 @@ When set to "error", output a throw. - + @@ -1515,11 +1531,13 @@ When set to "error", output a throw. - + - + - + @@ -3203,7 +3222,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3237,7 +3256,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3324,7 +3343,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3348,7 +3367,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3559,7 +3578,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3577,7 +3596,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -3604,7 +3623,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 ) --> - + @@ -3626,7 +3645,7 @@ If the status function evaluates to a positive value at the current time, the we - + @@ -4133,7 +4152,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -4721,7 +4740,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -5389,7 +5408,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -6367,7 +6386,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -6377,7 +6396,7 @@ Information output from lower logLevels is added with the desired log level - + @@ -6413,7 +6432,7 @@ The expected format is "{ gasExp, oilExp }", in that order--> - + @@ -6441,7 +6460,7 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + @@ -6477,7 +6496,7 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + @@ -6496,7 +6515,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.--> @@ -6506,7 +6525,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6525,7 +6544,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.--> @@ -6535,7 +6554,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6554,7 +6573,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.--> @@ -6564,7 +6583,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6583,7 +6602,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.--> @@ -6633,7 +6652,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6661,7 +6680,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6721,7 +6740,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6762,7 +6781,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6806,7 +6825,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6860,7 +6879,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6900,7 +6919,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6934,7 +6953,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -6947,7 +6966,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -7185,7 +7204,7 @@ Even if `writeCSV ="0"`, if the table is too large for the log, a csv file will - + @@ -7421,7 +7440,7 @@ For instance, if "oil" is before "gas" in "phaseNames", the table order should b - + @@ -7875,7 +7894,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7886,11 +7905,11 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + - + - + @@ -7904,7 +7923,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7914,7 +7933,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7930,7 +7949,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -7986,7 +8005,7 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - + @@ -8001,7 +8020,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.--> @@ -8009,7 +8028,7 @@ If the table is requested to be output in the log, and it is too large, a CSV fi - + @@ -8024,7 +8043,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.--> @@ -8147,7 +8166,7 @@ To neglect hysteresis on this phase, just use the same table name for the draina - + @@ -8167,7 +8186,7 @@ To neglect hysteresis on this phase, just use the same table name for the draina - + @@ -8228,7 +8247,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 33a2ec00f2c..bea55da9276 100644 --- a/src/coreComponents/schema/schema.xsd.other +++ b/src/coreComponents/schema/schema.xsd.other @@ -302,11 +302,13 @@ - + - + @@ -314,29 +316,37 @@ - + - + - + - + - + - + - +