From fbe608585b3d5d1ef1ee942c08c6f9d5cefd6112 Mon Sep 17 00:00:00 2001 From: MelReyCG Date: Wed, 3 Apr 2024 17:18:25 +0200 Subject: [PATCH 01/18] Add a way to expend the description of a wrapper --- src/coreComponents/dataRepository/Group.cpp | 8 ++++---- src/coreComponents/dataRepository/Group.hpp | 9 +++++++++ src/coreComponents/dataRepository/Wrapper.hpp | 9 +++++++++ src/coreComponents/dataRepository/WrapperBase.hpp | 11 +++++++++++ 4 files changed, 33 insertions(+), 4 deletions(-) diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index 5be399e8449..c5980bad952 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -644,12 +644,12 @@ void Group::postRestartInitializationRecursive() void Group::enableLogLevelInput() { - string const logLevelString = "logLevel"; - - registerWrapper( logLevelString, &m_logLevel ). + // TODO : Improve the Log Level description to clearly assign a usecase per log level (incoming PR). + registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ). setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Log level" ); + setDescription( "Sets the level of information to write in the standard output (the console typically).\n" + "A level of 0 outputs minimal information, higher levels require more." ); } Group const & Group::getBaseGroupByPath( string const & path ) const diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index 6192f3cddab..84a26c1af6b 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -1414,6 +1414,15 @@ class Group */ void setInputFlags( InputFlags flags ) { m_input_flags = flags; } + /** + * @struct viewKeyStruct holds char strings and viewKeys for fast lookup + */ + struct viewKeyStruct + { + /// String for the logLevel wrapper + constexpr static char const * logLevelString() { return "logLevel"; } + }; + ///@} /** diff --git a/src/coreComponents/dataRepository/Wrapper.hpp b/src/coreComponents/dataRepository/Wrapper.hpp index 404225490af..b3193af0ee5 100644 --- a/src/coreComponents/dataRepository/Wrapper.hpp +++ b/src/coreComponents/dataRepository/Wrapper.hpp @@ -893,6 +893,15 @@ class Wrapper final : public WrapperBase return *this; } + /** + * @copydoc WrapperBase::appendDescription(string const &) + */ + Wrapper< T > & appendDescription( string const & description ) + { + WrapperBase::appendDescription( description ); + return *this; + } + /** * @copydoc WrapperBase::setRegisteringObjects(string const &) */ diff --git a/src/coreComponents/dataRepository/WrapperBase.hpp b/src/coreComponents/dataRepository/WrapperBase.hpp index 542863e03b9..d44e24c2e6b 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -508,6 +508,17 @@ class WrapperBase return *this; } + /** + * @brief Add up more text to the existing description string of the wrapper. + * @param description the description to add to the end of the previous one. + * @return a pointer to this wrapper + */ + WrapperBase & appendDescription( string const & description ) + { + m_description += description; + return *this; + } + /** * @brief Get the description string of the wrapper. * @return this wrapper's description string From de6c78ef4f0060b5102c3f60a5f8f45472693ccc Mon Sep 17 00:00:00 2001 From: arng40 Date: Thu, 25 Apr 2024 14:33:34 +0200 Subject: [PATCH 02/18] loglevel first iteration --- .../multifluid/CO2Brine/CO2BrineFluid.cpp | 2 + .../fluid/multifluid/PVTDriver.cpp | 5 + .../reactive/ReactiveBrineFluid.cpp | 5 + .../reactive/ReactiveFluidDriver.cpp | 5 + .../relativePermeability/RelpermDriver.cpp | 5 + .../constitutive/solid/TriaxialDriver.cpp | 5 + src/coreComponents/dataRepository/Group.cpp | 2 +- src/coreComponents/mesh/MeshManager.cpp | 4 + .../mesh/generators/VTKMeshGenerator.cpp | 10 + .../mesh/generators/WellGeneratorBase.cpp | 5 + .../mesh/simpleGeometricObjects/Rectangle.cpp | 4 + .../NonlinearSolverParameters.cpp | 3 + .../physicsSolvers/SolverBase.cpp | 9 + .../contact/ContactSolverBase.cpp | 5 + .../SolidMechanicsEmbeddedFractures.cpp | 3 + .../contact/SolidMechanicsLagrangeContact.cpp | 3 + .../fluidFlow/CompositionalMultiphaseBase.cpp | 6 + .../fluidFlow/CompositionalMultiphaseFVM.cpp | 8 + .../CompositionalMultiphaseHybridFVM.cpp | 4 + .../fluidFlow/FlowSolverBase.cpp | 3 + .../ReactiveCompositionalMultiphaseOBL.cpp | 8 + .../fluidFlow/SinglePhaseBase.cpp | 8 + .../fluidFlow/SinglePhaseFVM.cpp | 11 +- .../fluidFlow/SinglePhaseHybridFVM.cpp | 6 + .../proppantTransport/ProppantTransport.cpp | 3 + .../wells/CompositionalMultiphaseWell.cpp | 11 + .../fluidFlow/wells/SinglePhaseWell.cpp | 11 + ...mpositionalMultiphaseReservoirAndWells.cpp | 8 +- .../CoupledReservoirAndWellsBase.hpp | 5 + .../multiphysics/HydrofractureSolver.cpp | 5 + ...ePhasePoromechanicsConformingFractures.cpp | 5 + .../simplePDE/PhaseFieldDamageFEM.cpp | 11 +- .../SolidMechanicsLagrangianFEM.cpp | 6 + .../surfaceGeneration/SurfaceGenerator.cpp | 14 +- .../schema/docs/AcousticElasticSEM.rst | 36 +- .../schema/docs/AcousticFirstOrderSEM.rst | 66 +- .../schema/docs/AcousticSEM.rst | 66 +- .../schema/docs/AcousticVTISEM.rst | 66 +- src/coreComponents/schema/docs/Aquifer.rst | 3 +- .../schema/docs/CO2BrineEzrokhiFluid.rst | 29 +- .../docs/CO2BrineEzrokhiThermalFluid.rst | 29 +- .../schema/docs/CO2BrinePhillipsFluid.rst | 29 +- .../docs/CO2BrinePhillipsThermalFluid.rst | 29 +- .../docs/CompositionalMultiphaseFVM.rst | 101 ++- .../docs/CompositionalMultiphaseHybridFVM.rst | 80 +- .../docs/CompositionalMultiphaseReservoir.rst | 5 +- ...tionalMultiphaseReservoirPoromechanics.rst | 48 +- ...seReservoirPoromechanicsInitialization.rst | 17 +- .../CompositionalMultiphaseStatistics.rst | 3 +- .../docs/CompositionalMultiphaseWell.rst | 56 +- src/coreComponents/schema/docs/Dirichlet.rst | 35 +- .../schema/docs/ElasticFirstOrderSEM.rst | 66 +- src/coreComponents/schema/docs/ElasticSEM.rst | 70 +- .../schema/docs/EmbeddedSurfaceGenerator.rst | 38 +- src/coreComponents/schema/docs/Events.rst | 25 +- .../schema/docs/FieldSpecification.rst | 35 +- .../schema/docs/FlowProppantTransport.rst | 34 +- src/coreComponents/schema/docs/HaltEvent.rst | 35 +- .../schema/docs/Hydrofracture.rst | 6 +- .../schema/docs/HydrostaticEquilibrium.rst | 45 +- .../schema/docs/InternalWell.rst | 31 +- src/coreComponents/schema/docs/LaplaceFEM.rst | 40 +- .../schema/docs/LinearSolverParameters.rst | 3 +- src/coreComponents/schema/docs/Mesh.rst | 20 +- .../schema/docs/MultiphasePoromechanics.rst | 48 +- .../MultiphasePoromechanicsInitialization.rst | 17 +- .../docs/MultiphasePoromechanicsReservoir.rst | 5 +- .../schema/docs/NonlinearSolverParameters.rst | 5 +- src/coreComponents/schema/docs/PML.rst | 45 +- src/coreComponents/schema/docs/PVTDriver.rst | 34 +- .../schema/docs/PeriodicEvent.rst | 3 +- .../schema/docs/PhaseFieldDamageFEM.rst | 47 +- .../schema/docs/PhaseFieldFracture.rst | 34 +- .../schema/docs/ProppantTransport.rst | 61 +- .../schema/docs/ReactiveBrine.rst | 24 +- .../schema/docs/ReactiveBrineThermal.rst | 24 +- .../ReactiveCompositionalMultiphaseOBL.rst | 71 +- .../schema/docs/ReactiveFluidDriver.rst | 30 +- src/coreComponents/schema/docs/Rectangle.rst | 26 +- .../schema/docs/RelpermDriver.rst | 24 +- .../schema/docs/SinglePhaseFVM.rst | 43 +- .../schema/docs/SinglePhaseHybridFVM.rst | 59 +- .../schema/docs/SinglePhasePoromechanics.rst | 36 +- ...ePhasePoromechanicsConformingFractures.rst | 6 +- ...glePhasePoromechanicsEmbeddedFractures.rst | 36 +- ...SinglePhasePoromechanicsInitialization.rst | 17 +- .../SinglePhasePoromechanicsReservoir.rst | 34 +- .../schema/docs/SinglePhaseProppantFVM.rst | 43 +- .../schema/docs/SinglePhaseReservoir.rst | 34 +- .../SinglePhaseReservoirPoromechanics.rst | 36 +- ...seReservoirPoromechanicsInitialization.rst | 17 +- .../schema/docs/SinglePhaseStatistics.rst | 17 +- .../schema/docs/SinglePhaseWell.rst | 46 +- .../docs/SolidMechanicsEmbeddedFractures.rst | 7 +- .../docs/SolidMechanicsLagrangeContact.rst | 55 +- .../docs/SolidMechanicsLagrangianSSLE.rst | 65 +- .../schema/docs/SolidMechanicsStateReset.rst | 19 +- .../schema/docs/SolidMechanicsStatistics.rst | 17 +- .../docs/SolidMechanics_LagrangianFEM.rst | 65 +- .../schema/docs/SolidMechanics_MPM.rst | 82 +- src/coreComponents/schema/docs/SoloEvent.rst | 3 +- src/coreComponents/schema/docs/SourceFlux.rst | 33 +- .../schema/docs/SurfaceGenerator.rst | 49 +- src/coreComponents/schema/docs/Traction.rst | 3 +- .../schema/docs/TriaxialDriver.rst | 32 +- src/coreComponents/schema/docs/VTK.rst | 3 +- src/coreComponents/schema/docs/VTKMesh.rst | 11 +- src/coreComponents/schema/docs/VTKWell.rst | 30 +- .../schema/docs/WellControls.rst | 3 +- src/coreComponents/schema/schema.xsd | 734 ++++++++++++++---- 110 files changed, 2289 insertions(+), 1198 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index 01e210d20a1..af4414e1732 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -112,6 +112,8 @@ CO2BrineFluid( string const & name, Group * const parent ): setPlotLevel( PlotLevel::LEVEL_0 ). setRestartFlags( RestartFlags::WRITE_AND_READ ); } + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display PVT phase table" ); } template< typename PHASE1, typename PHASE2, typename FLASH > diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index ebee0639d42..580bc90dcb1 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -85,6 +85,11 @@ PVTDriver::PVTDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Display informations about PVTDriver\n" + "- Indicate at the end if the internal results are consistent" ); } void PVTDriver::postProcessInput() diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 93b463ccdd3..9e1be14d05c 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -63,6 +63,8 @@ ReactiveBrineFluid< PHASE > :: ReactiveBrineFluid( string const & name, Group * const parent ): ReactiveMultiFluid( name, parent ) { + enableLogLevelInput(); + registerWrapper( viewKeyStruct::phasePVTParaFilesString(), &m_phasePVTParaFiles ). setInputFlag( InputFlags::REQUIRED ). setRestartFlags( RestartFlags::NO_WRITE ). @@ -79,6 +81,9 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setPlotLevel( PlotLevel::LEVEL_0 ). setRestartFlags( RestartFlags::WRITE_AND_READ ); } + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display phase PVT Table" ); } template< typename PHASE > diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index e0e826b0f2e..e0a5e46f3ed 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -66,6 +66,11 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Print informations about ReactiveFluidDriver\n" + "- Indicate at the end if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index 0689c2b86d8..4cff6059e37 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -52,6 +52,11 @@ RelpermDriver::RelpermDriver( const geos::string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Print informations about ReactiveFluidDriver \n" + "- Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index 4a02fe0e9d7..106fc7a8401 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -67,6 +67,11 @@ TriaxialDriver::TriaxialDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Print informations about TriaxialDriver\n" + "- Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index c5980bad952..f66f3317b0b 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -646,7 +646,7 @@ void Group::enableLogLevelInput() { // TODO : Improve the Log Level description to clearly assign a usecase per log level (incoming PR). registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ). - setApplyDefaultValue( 0 ). + setApplyDefaultValue( 1 ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "Sets the level of information to write in the standard output (the console typically).\n" "A level of 0 outputs minimal information, higher levels require more." ); diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index d1e48b4f419..f3e834baab8 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -34,7 +34,11 @@ MeshManager::MeshManager( string const & name, Group * const parent ): Group( name, parent ) { + enableLogLevelInput(); setInputFlags( InputFlags::REQUIRED ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display informations about imported field name on region/subRegion" ); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index b45ed3f9e30..cdaa84009b9 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -34,6 +34,8 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, Group * const parent ) : ExternalMeshGeneratorBase( name, parent ) { + enableLogLevelInput(); + registerWrapper( viewKeyStruct::regionAttributeString(), &m_attributeName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::OPTIONAL ). @@ -74,6 +76,14 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, " If set to 0 (default value), the GlobalId arrays in the input mesh are used if available, and generated otherwise." " If set to a negative value, the GlobalId arrays in the input mesh are not used, and generated global Ids are automatically generated." " If set to a positive value, the GlobalId arrays in the input mesh are used and required, and the simulation aborts if they are not available" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Display cell block names\n" + "\n2 :\n" + "- Display node sets names\n" + "\n5 :\n" + "- Display informations about redistribution" ); } void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index 554f4530bf7..1ac4d1db735 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -37,6 +37,8 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent , m_nDims( 3 ) , m_polylineHeadNodeId( -1 ) { + enableLogLevelInput(); + setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); registerWrapper( viewKeyStruct::radiusString(), &m_radius ). @@ -70,6 +72,9 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setInputFlag( InputFlags::REQUIRED ). setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display informations about Internal wells and their perforations" ); } Group * WellGeneratorBase::createChild( string const & childKey, string const & childName ) diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 71cb893e757..0494ab5c09b 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -28,6 +28,8 @@ Rectangle::Rectangle( const string & name, Group * const parent ): m_origin{ 0.0, 0.0, 0.0 }, m_tolerance() { + enableLogLevelInput(); + registerWrapper( viewKeyStruct::originString(), &m_origin ). setInputFlag( InputFlags::REQUIRED ). setDescription( "Origin point (x,y,z) of the plane (basically, any point on the plane)" ); @@ -42,6 +44,8 @@ Rectangle::Rectangle( const string & name, Group * const parent ): setDescription( "Tolerance to determine if a point sits on the plane or not. " "It is relative to the maximum dimension of the plane." ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n2 :\n- Display informations about length and width of the bounded plane" ); m_points.resize( 4, 3 ); } diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index 05946aa15b8..add40103a9a 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -165,6 +165,9 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display informations about NonLinearSolver parameters" ); + } void NonlinearSolverParameters::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index 6a71ae08f54..418f40cac8e 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -89,6 +89,15 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Initial time-step value required by the solver to the event manager." ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Display information about line search\n" + "- Display global solution scaling factor" + "\n1 and step remaining :\n" + "- Display informations about timestep" + "\nonly with loglevel = 2 :\n" + "- Display informations about linear algebra objects (matrices and vectors)" ); + registerGroup( groupKeyStruct::linearSolverParametersString(), &m_linearSolverParameters ); registerGroup( groupKeyStruct::nonlinearSolverParametersString(), &m_nonlinearSolverParameters ); registerGroup( groupKeyStruct::solverStatisticsString(), &m_solverStatistics ); diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index b9f0e1d8645..c25b253184d 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -42,11 +42,16 @@ ContactSolverBase::ContactSolverBase( const string & name, Group * const parent ): SolidMechanicsLagrangianFEM( name, parent ) { + enableLogLevelInput(); + this->getWrapper< string >( viewKeyStruct::contactRelationNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n - Display informations about number of elements for each fracture states:" ); } void ContactSolverBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp index 0a082067cfa..9ab9b54d4f2 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp @@ -50,6 +50,9 @@ SolidMechanicsEmbeddedFractures::SolidMechanicsEmbeddedFractures( const string & setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0 ). setDescription( "Defines whether to use static condensation or not." ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n - Display informations about residual norm for each fractures" ); } SolidMechanicsEmbeddedFractures::~SolidMechanicsEmbeddedFractures() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp index 2f690495827..b67d92c14c5 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp @@ -64,6 +64,9 @@ SolidMechanicsLagrangeContact::SolidMechanicsLagrangeContact( const string & nam setInputFlag( InputFlags::REQUIRED ). setDescription( "Name of the stabilization to use in the lagrangian contact solver" ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n - Display informations about risidual norm (Rdisplacement, Rtraction, Rtotal)" ); + LinearSolverParameters & linSolParams = m_linearSolverParameters.get(); linSolParams.mgr.strategy = LinearSolverParameters::MGR::StrategyType::lagrangianContactMechanics; linSolParams.mgr.separateComponents = true; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index f023c1a9ec3..f4341509256 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -151,6 +151,12 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 1.0 ). setDescription( "Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n 1 and first nonlinear iteration :\n" + "- Display the residuals values" + "\n1 :\n" + "- Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); } void CompositionalMultiphaseBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index 2387a59291b..b76a2025db5 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -86,6 +86,12 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setApplyDefaultValue( ScalingType::Global ). setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Display the residual values\n" + "\n1: and non first nonlinear iteration\n" + "- Display face boundary conditions log" ); } void CompositionalMultiphaseFVM::postProcessInput() @@ -434,6 +440,7 @@ real64 CompositionalMultiphaseFVM::calculateResidualNorm( real64 const & GEOS_UN } residualNorm = sqrt( globalResidualNorm[0] * globalResidualNorm[0] + globalResidualNorm[1] * globalResidualNorm[1] ); + if( getLogLevel() >= 1 && logger::internal::rank == 0 ) { std::cout << GEOS_FMT( " ( R{} ) = ( {:4.2e} ) ( Renergy ) = ( {:4.2e} )", @@ -1050,6 +1057,7 @@ void CompositionalMultiphaseFVM::applyAquiferBC( real64 const time, string const & ) { BoundaryStencil const & stencil = fluxApprox.getStencil< BoundaryStencil >( mesh, setName ); + // number of nonlinear iteration == 0 if( bc.getLogLevel() >= 1 && m_nonlinearSolverParameters.m_numNewtonIterations == 0 ) { globalIndex const numTargetFaces = MpiWrapper::sum< globalIndex >( stencil.size() ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp index b83902dcf0b..a95e5d8adb4 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,6 +49,10 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display the residual values" ); + m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::compositionalMultiphaseHybridFVM; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp index a116226a893..0c18e353f59 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -119,6 +119,9 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display the boundary conditions" ); + // allow the user to select a norm getNonlinearSolverParameters().getWrapper< solverBaseKernels::NormType >( NonlinearSolverParameters::viewKeysStruct::normTypeString() ).setInputFlag( InputFlags::OPTIONAL ); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index 2eb5c29eac4..395f4ec1acf 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -115,6 +115,14 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n 1 and first nonlinear iteration :\n" + "- Display the source flux boundary conditions\n" + "- Display the Dirichlet pressure boundary conditions\n" + "- Display the Dirichlet temperature boundary conditions\n" + "\n1 :\n" + "- Display the residuals values" ); + m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp index 4c2538c4d67..1df746a153b 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -58,6 +58,14 @@ SinglePhaseBase::SinglePhaseBase( const string & name, setApplyDefaultValue( 0.0 ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "Temperature" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n 1 and first nonlinear iteration :\n" + "- Display the boundary conditions log message\n" + "\n 1 and number of nonlinear iterations > 0 :\n" + "- Display the boundary conditions log message\n" + "\n1 :\n" + "- Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 565a4621fbe..1b53584fd60 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -58,7 +58,16 @@ template< typename BASE > SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, Group * const parent ): BASE( name, parent ) -{} +{ + SinglePhaseBase::enableLogLevelInput(); + + SinglePhaseBase::getWrapperBase( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n 1 :\n" + "- Display the residual values\n" + "\n1 and first nonlinear iterations :\n" + "- Display the face boundary condition defined with pressure\n" + "- Display the face boundary condition defined with temperature" ); +} template< typename BASE > void SinglePhaseFVM< BASE >::initializePreSubGroups() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index 1ce44237606..c65aacc6da8 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -47,6 +47,12 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, m_areaRelTol( 1e-8 ) { + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n 1 :\n" + "- Display the residuals values\n" + "\n1 : and first nonlinear iteration :\n" + "- Display the face boundary conditions definied with pressure" ); + // one cell-centered dof per cell m_numDofPerCell = 1; m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhaseHybridFVM; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp index be24ccd834d..86348915808 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp @@ -78,6 +78,9 @@ ProppantTransport::ProppantTransport( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag that enables/disables proppant-packing update" ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display the residuals norm values\n" ); + } void ProppantTransport::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 6620d93c277..43f077d7b04 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -101,6 +101,17 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 1 ). setDescription( "Flag indicating whether local (cell-wise) chopping of negative compositions is allowed" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n 0 :\n" + "- Display the residuals norm values\n" + "\n 1 :\n" + "- Output well rates to a simple csv file\n" + "\n 2 :\n" + "- Display the BHP pressure\n" + "- Display the surface density\n" + "\n 2 and use surface conditions:\n" + "- Display phase and total density in the reference element" ); } void CompositionalMultiphaseWell::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index a1f1777c5e3..4a6102ba0f9 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -46,6 +46,17 @@ SinglePhaseWell::SinglePhaseWell( const string & name, Group * const parent ): WellSolverBase( name, parent ) { + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n 0 :\n" + "- Display the residuals norm values\n" + "\n 1 :\n" + "- Output well rates to a simple csv file\n" + "\n 2 :\n" + "- Display the BHP pressure\n" + "- Display the surface density\n" + "\n 2 and use surface conditions:\n" + "- Display phase and total density in the reference element" ); + m_numDofPerWellElement = 2; m_numDofPerResElement = 1; } diff --git a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp index ef75ab18317..096727f8a35 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -75,7 +75,13 @@ CompositionalMultiphaseReservoirAndWells< COMPOSITIONAL_RESERVOIR_SOLVER >:: CompositionalMultiphaseReservoirAndWells( const string & name, Group * const parent ) : Base( name, parent ) -{} +{ + Base::enableLogLevelInput(); + + Base::getWrapperBase( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 and if the well is injector and crossflow enbled:\n" + "Display warnings about crossflow for injectors" ); +} template< typename COMPOSITIONAL_RESERVOIR_SOLVER > CompositionalMultiphaseReservoirAndWells< COMPOSITIONAL_RESERVOIR_SOLVER >:: diff --git a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp index 0a5d2f4eff4..4c5c4dc1e87 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp @@ -101,8 +101,13 @@ class CoupledReservoirAndWellsBase : public CoupledSolver< RESERVOIR_SOLVER, WEL : Base( name, parent ), m_isWellTransmissibilityComputed( false ) { + // enableLogLevelInput(); + this->template getWrapper< string >( Base::viewKeyStruct::discretizationString() ). setInputFlag( dataRepository::InputFlags::FALSE ); + + // getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + // appendDescription( "\n2 :\n Display the value of the transmissibilities" ); } /** diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index 858d9c55585..eff5a4ce29a 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -78,6 +78,8 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & m_isMatrixPoroelastic(), m_newFractureInitializationType() { + Base::enableLogLevelInput(); + registerWrapper( viewKeyStruct::surfaceGeneratorNameString(), &m_surfaceGeneratorName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). @@ -107,6 +109,9 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); + Base::getWrapperBase( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n- Display whether or not we Re-entering Newton Solve \n" ); + m_numResolves[0] = 0; // This may need to be different depending on whether poroelasticity is on or not. diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index 86d04ed2cf1..8696c3f2470 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -40,6 +40,11 @@ SinglePhasePoromechanicsConformingFractures::SinglePhasePoromechanicsConformingF Group * const parent ) : Base( name, parent ) { + enableLogLevelInput(); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n3 :\n- Display the summary of declared fields and coupling.\n" ); + LinearSolverParameters & params = m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; params.mgr.separateComponents = false; diff --git a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp index d314092bebc..70b067bc960 100644 --- a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp +++ b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp @@ -80,6 +80,12 @@ PhaseFieldDamageFEM::PhaseFieldDamageFEM( const string & name, setApplyDefaultValue( 1.5 ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "The upper bound of the damage" ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n2 :\n" + "- Display the jacobian matrix\n" + "\n2 :\n" + "- Display the residuals values" ); } PhaseFieldDamageFEM::~PhaseFieldDamageFEM() @@ -451,8 +457,9 @@ void PhaseFieldDamageFEM::applyBoundaryConditions( { applyIrreversibilityConstraint( dofManager, domain, localMatrix, localRhs ); } - - if( getLogLevel() == 2 ) + // Display jacobian matrix + // Display residuals values + if( getLogLevel() >= 2 ) { GEOS_LOG_RANK_0( "After PhaseFieldDamageFEM::applyBoundaryConditions" ); GEOS_LOG_RANK_0( "\nJacobian:\n" ); diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp index 92faf16b5b5..63f91f269af 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp @@ -120,6 +120,12 @@ SolidMechanicsLagrangianFEM::SolidMechanicsLagrangianFEM( const string & name, setInputFlag( InputFlags::FALSE ). setDescription( "The maximum force contribution in the problem domain." ); + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n2 :\n" + "Display a warning about boundary conditions\n" + "\n2 :\n" + "Display residuals values" ); + } void SolidMechanicsLagrangianFEM::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index cae283b4241..fc854f4f1e9 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -219,6 +219,15 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); + + getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + appendDescription( "\n1 :\n" + "- Display informations about splitting node/edge/faces\n" + "\n2 :\n" + "- Display informations about all elements attached to the nodeID\n" + "- Display informations about all faces on their element\n" + "\n3 :\n" + "- Display consistency checking of the maps" ); } void SurfaceGenerator::postProcessInput() @@ -1771,7 +1780,6 @@ void SurfaceGenerator::performFracture( const localIndex nodeID, // >("usedFaces")[newNodeIndex]; // usedFacesNew = usedFaces[nodeID]; - if( getLogLevel() > 0 ) { GEOS_LOG_RANK( GEOS_FMT( "Done splitting node {} into nodes {} and {}", nodeID, nodeID, newNodeIndex ) ); @@ -2063,8 +2071,6 @@ void SurfaceGenerator::performFracture( const localIndex nodeID, } } - - // 2b) loop over all faces on element. if( getLogLevel() > 1 ) { @@ -2333,7 +2339,6 @@ void SurfaceGenerator::mapConsistencyCheck( localIndex const GEOS_UNUSED_PARAM( arrayView2d< localIndex const > const & faceToSubRegionMap = faceManager.elementSubRegionList(); arrayView2d< localIndex const > const & faceToElementMap = faceManager.elementList(); - #if 1 if( getLogLevel() > 2 ) { @@ -2364,7 +2369,6 @@ void SurfaceGenerator::mapConsistencyCheck( localIndex const GEOS_UNUSED_PARAM( std::cout << " elementToFaces->edges->nodes = "; - // Now we do a loop over the facelist and process all the faces for( int kf=0; kf`_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -elasticSolverName groupNameRef required Name of the elastic solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +acousticSolverName groupNameRef required Name of the acoustic solver used by the coupled solver +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +elasticSolverName groupNameRef required Name of the elastic solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst index 22d9753df98..1ca8ddb6e7b 100644 --- a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst @@ -1,33 +1,41 @@ -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/AcousticSEM.rst b/src/coreComponents/schema/docs/AcousticSEM.rst index 22d9753df98..1ca8ddb6e7b 100644 --- a/src/coreComponents/schema/docs/AcousticSEM.rst +++ b/src/coreComponents/schema/docs/AcousticSEM.rst @@ -1,33 +1,41 @@ -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/AcousticVTISEM.rst b/src/coreComponents/schema/docs/AcousticVTISEM.rst index 22d9753df98..1ca8ddb6e7b 100644 --- a/src/coreComponents/schema/docs/AcousticVTISEM.rst +++ b/src/coreComponents/schema/docs/AcousticVTISEM.rst @@ -1,33 +1,41 @@ -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Aquifer.rst b/src/coreComponents/schema/docs/Aquifer.rst index 20c477d38bc..c23befdd3c7 100644 --- a/src/coreComponents/schema/docs/Aquifer.rst +++ b/src/coreComponents/schema/docs/Aquifer.rst @@ -27,7 +27,8 @@ direction R1Tensor {0,0,0} Direction to appl endTime real64 1e+99 Time at which the boundary condition will stop being applied. functionName groupNameRef Name of function that specifies variation of the boundary condition. initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. name groupName required A name is required for any non-unique nodes pressureInfluenceFunctionName groupNameRef | Name of the table describing the pressure influence function | . If not provided, we use a default pressure influence function diff --git a/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst b/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst index 8d5cb05986a..56cbe6beff2 100644 --- a/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst @@ -1,17 +1,20 @@ -==================== ================== ======== ============================================================================================================ -Name Type Default Description -==================== ================== ======== ============================================================================================================ -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================ +==================== ================== ======== ============================================================================================================================================================================================= +Name Type Default Description +==================== ================== ======== ============================================================================================================================================================================================= +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ============================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst b/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst index 8d5cb05986a..56cbe6beff2 100644 --- a/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst @@ -1,17 +1,20 @@ -==================== ================== ======== ============================================================================================================ -Name Type Default Description -==================== ================== ======== ============================================================================================================ -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================ +==================== ================== ======== ============================================================================================================================================================================================= +Name Type Default Description +==================== ================== ======== ============================================================================================================================================================================================= +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ============================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst b/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst index 8d5cb05986a..56cbe6beff2 100644 --- a/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst @@ -1,17 +1,20 @@ -==================== ================== ======== ============================================================================================================ -Name Type Default Description -==================== ================== ======== ============================================================================================================ -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================ +==================== ================== ======== ============================================================================================================================================================================================= +Name Type Default Description +==================== ================== ======== ============================================================================================================================================================================================= +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ============================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst b/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst index 8d5cb05986a..56cbe6beff2 100644 --- a/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst @@ -1,17 +1,20 @@ -==================== ================== ======== ============================================================================================================ -Name Type Default Description -==================== ================== ======== ============================================================================================================ -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================ +==================== ================== ======== ============================================================================================================================================================================================= +Name Type Default Description +==================== ================== ======== ============================================================================================================================================================================================= +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ============================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst index 7202cd18e81..ba45cce4388 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst @@ -1,45 +1,64 @@ -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used -continuationDBC integer 1 Flag for enabling continuation parameter -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility -name groupName required A name is required for any non-unique nodes -omegaDBC real64 1 Factor by which DBC flux is multiplied -scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: - | * Global - | * Local -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useDBC integer 0 Enable Dissipation-based continuation flux -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================== +========================================= =========================================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================================= =========================================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used +continuationDBC integer 1 Flag for enabling continuation parameter +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 1 : + | - Display the boundary conditions + | 1 and first nonlinear iteration : + | - Display the residuals values + | 1 : + | - Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | 1 : + | - Display the residual values + | + | 1: and non first nonlinear iteration + | - Display face boundary conditions log +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility +name groupName required A name is required for any non-unique nodes +omegaDBC real64 1 Factor by which DBC flux is multiplied +scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: + | * Global + | * Local +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useDBC integer 0 Enable Dissipation-based continuation flux +useMass integer 0 Use mass formulation instead of molar +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= =========================================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst index 4cdd10dd766..8f2e1a23f37 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst @@ -1,36 +1,52 @@ -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -name groupName required A name is required for any non-unique nodes -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================== +========================================= ================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================================= ================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 1 : + | - Display the boundary conditions + | 1 and first nonlinear iteration : + | - Display the residuals values + | 1 : + | - Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | 1 : + | - Display the residual values +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +name groupName required A name is required for any non-unique nodes +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useMass integer 0 Use mass formulation instead of molar +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= ================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst index f25a13fb960..ab6df335a34 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst @@ -6,7 +6,10 @@ Name Type Default Description cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] flowSolverName groupNameRef required Name of the flow solver used by the coupled solver initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 and if the well is injector and crossflow enbled: + | Display warnings about crossflow for injectors name groupName required A name is required for any non-unique nodes targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. wellSolverName groupNameRef required Name of the well solver used by the coupled solver diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst index c85eff65ff8..0c3f259254a 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst @@ -1,24 +1,32 @@ -=========================== ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -=========================== ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. -stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -=========================== ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== +=========================== ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=========================== ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: + | None - Add no stabilization to mass equation, + | Global - Add stabilization to all faces, + | Local - Add stabilization only to interiors of macro elements. +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +=========================== ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst index 27129634c0b..7fae6d809b6 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst @@ -1,12 +1,13 @@ -=========================== ============ ======== ========================================================================== -Name Type Default Description -=========================== ============ ======== ========================================================================== -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ========================================================================== +=========================== ============ ======== ============================================================================================================================================================= +Name Type Default Description +=========================== ============ ======== ============================================================================================================================================================= +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +=========================== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst index 4a386d1d1c3..e09bd239254 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst @@ -6,7 +6,8 @@ Name Type Default Description computeCFLNumbers integer 0 Flag to decide whether CFL numbers are computed or not computeRegionStatistics integer 1 Flag to decide whether region statistics are computed or not flowSolverName groupNameRef required Name of the flow solver -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. name groupName required A name is required for any non-unique nodes relpermThreshold real64 1e-06 Flag to decide whether a phase is considered mobile (when the relperm is above the threshold) or immobile (when the relperm is below the threshold) in metric 2 writeCSV integer 0 Write statistics into a CSV file diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst index b072785ff00..ef01c30f7e8 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst @@ -1,22 +1,42 @@ -============================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations -maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -useMass integer 0 Use total mass equation -writeCSV integer 0 Write rates into a CSV file -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -WellControls node :ref:`XML_WellControls` -============================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +============================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 0 : + | - Display the residuals norm values + | + | 1 : + | - Output well rates to a simple csv file + | + | 2 : + | - Display the BHP pressure + | - Display the surface density + | + | 2 and use surface conditions: + | - Display phase and total density in the reference element +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations +maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +useMass integer 0 Use total mass equation +writeCSV integer 0 Write rates into a CSV file +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +WellControls node :ref:`XML_WellControls` +============================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Dirichlet.rst b/src/coreComponents/schema/docs/Dirichlet.rst index 81d6fead75e..86abc981fdd 100644 --- a/src/coreComponents/schema/docs/Dirichlet.rst +++ b/src/coreComponents/schema/docs/Dirichlet.rst @@ -1,21 +1,22 @@ -====================== ================== ======== ============================================================================== -Name Type Default Description -====================== ================== ======== ============================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -fieldName groupNameRef Name of field that boundary condition is applied to. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ============================================================================== +====================== ================== ======== ============================================================================================================================================================= +Name Type Default Description +====================== ================== ======== ============================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +fieldName groupNameRef Name of field that boundary condition is applied to. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialCondition integer 0 Boundary condition is applied as an initial condition. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +====================== ================== ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst index 22d9753df98..1ca8ddb6e7b 100644 --- a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst @@ -1,33 +1,41 @@ -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ElasticSEM.rst b/src/coreComponents/schema/docs/ElasticSEM.rst index 6cc28146502..595b678ddf5 100644 --- a/src/coreComponents/schema/docs/ElasticSEM.rst +++ b/src/coreComponents/schema/docs/ElasticSEM.rst @@ -1,35 +1,43 @@ -========================= ============================ ============= ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ============= ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). -sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ============= ======================================================================================================================================================================================================================================================================================================================== +========================= ============================ ============= ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================ ============= ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). +sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ============= ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst index 32ce1ed3490..0a85cfc597e 100644 --- a/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst +++ b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst @@ -1,19 +1,27 @@ -========================= ================== ============== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ============== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fractureRegion groupNameRef FractureRegion (no description available) -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering -name groupName required A name is required for any non-unique nodes -targetObjects groupNameRef_array required List of geometric objects that will be used to initialized the embedded surfaces/fractures. -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ============== ======================================================================================================================================================================================================================================================================================================================== +========================= ================== ============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fractureRegion groupNameRef FractureRegion (no description available) +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering +name groupName required A name is required for any non-unique nodes +targetObjects groupNameRef_array required List of geometric objects that will be used to initialized the embedded surfaces/fractures. +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Events.rst b/src/coreComponents/schema/docs/Events.rst index 4073b6fdc2c..c7cd27fb469 100644 --- a/src/coreComponents/schema/docs/Events.rst +++ b/src/coreComponents/schema/docs/Events.rst @@ -1,16 +1,17 @@ -================ ================================== ============ =================================================== -Name Type Default Description -================ ================================== ============ =================================================== -logLevel integer 0 Log level -maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. -maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. -minTime real64 0 Start simulation time for the global event loop. -timeOutputFormat geos_EventManager_TimeOutputFormat seconds Format of the time in the GEOS log. -HaltEvent node :ref:`XML_HaltEvent` -PeriodicEvent node :ref:`XML_PeriodicEvent` -SoloEvent node :ref:`XML_SoloEvent` -================ ================================== ============ =================================================== +================ ================================== ============ ============================================================================================================================================================= +Name Type Default Description +================ ================================== ============ ============================================================================================================================================================= +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. +maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. +minTime real64 0 Start simulation time for the global event loop. +timeOutputFormat geos_EventManager_TimeOutputFormat seconds Format of the time in the GEOS log. +HaltEvent node :ref:`XML_HaltEvent` +PeriodicEvent node :ref:`XML_PeriodicEvent` +SoloEvent node :ref:`XML_SoloEvent` +================ ================================== ============ ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/FieldSpecification.rst b/src/coreComponents/schema/docs/FieldSpecification.rst index 81d6fead75e..86abc981fdd 100644 --- a/src/coreComponents/schema/docs/FieldSpecification.rst +++ b/src/coreComponents/schema/docs/FieldSpecification.rst @@ -1,21 +1,22 @@ -====================== ================== ======== ============================================================================== -Name Type Default Description -====================== ================== ======== ============================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -fieldName groupNameRef Name of field that boundary condition is applied to. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ============================================================================== +====================== ================== ======== ============================================================================================================================================================= +Name Type Default Description +====================== ================== ======== ============================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +fieldName groupNameRef Name of field that boundary condition is applied to. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialCondition integer 0 Boundary condition is applied as an initial condition. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +====================== ================== ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/FlowProppantTransport.rst b/src/coreComponents/schema/docs/FlowProppantTransport.rst index c9f1110c6fa..4d90536762c 100644 --- a/src/coreComponents/schema/docs/FlowProppantTransport.rst +++ b/src/coreComponents/schema/docs/FlowProppantTransport.rst @@ -1,17 +1,25 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -proppantSolverName groupNameRef required Name of the proppant solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +proppantSolverName groupNameRef required Name of the proppant solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/HaltEvent.rst b/src/coreComponents/schema/docs/HaltEvent.rst index de2a154b525..d62af56a529 100644 --- a/src/coreComponents/schema/docs/HaltEvent.rst +++ b/src/coreComponents/schema/docs/HaltEvent.rst @@ -1,21 +1,22 @@ -==================== ============ ======== ===================================================================================================================== -Name Type Default Description -==================== ============ ======== ===================================================================================================================== -beginTime real64 0 Start time of this event. -endTime real64 1e+100 End time of this event. -finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. -forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). -logLevel integer 0 Log level -maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). -maxRuntime real64 required The maximum allowable runtime for the job. -name groupName required A name is required for any non-unique nodes -target groupNameRef Name of the object to be executed when the event criteria are met. -targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. -HaltEvent node :ref:`XML_HaltEvent` -PeriodicEvent node :ref:`XML_PeriodicEvent` -SoloEvent node :ref:`XML_SoloEvent` -==================== ============ ======== ===================================================================================================================== +==================== ============ ======== ============================================================================================================================================================= +Name Type Default Description +==================== ============ ======== ============================================================================================================================================================= +beginTime real64 0 Start time of this event. +endTime real64 1e+100 End time of this event. +finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. +forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). +maxRuntime real64 required The maximum allowable runtime for the job. +name groupName required A name is required for any non-unique nodes +target groupNameRef Name of the object to be executed when the event criteria are met. +targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. +HaltEvent node :ref:`XML_HaltEvent` +PeriodicEvent node :ref:`XML_PeriodicEvent` +SoloEvent node :ref:`XML_SoloEvent` +==================== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/Hydrofracture.rst b/src/coreComponents/schema/docs/Hydrofracture.rst index 2c63529e0c0..72b144f36c2 100644 --- a/src/coreComponents/schema/docs/Hydrofracture.rst +++ b/src/coreComponents/schema/docs/Hydrofracture.rst @@ -9,7 +9,11 @@ flowSolverName groupNameRef initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. isMatrixPoroelastic integer 0 (no description available) isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display whether or not we Re-entering Newton Solve + | maxNumResolves integer 10 Value to indicate how many resolves may be executed to perform surface generation after the execution of flow and mechanics solver. name groupName required A name is required for any non-unique nodes newFractureInitializationType geos_HydrofractureSolver >_InitializationType Pressure Type of new fracture element initialization. Can be Pressure or Displacement. diff --git a/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst b/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst index 3b1f86b4003..4b4abbb2c73 100644 --- a/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst +++ b/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst @@ -1,26 +1,27 @@ -============================================ ================== ======== ==================================================================================================== -Name Type Default Description -============================================ ================== ======== ==================================================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -componentFractionVsElevationTableNames groupNameRef_array {} Names of the tables specifying the (component fraction vs elevation) relationship for each component -componentNames string_array {} Names of the fluid components -datumElevation real64 required Datum elevation [m] -datumPressure real64 required Datum pressure [Pa] -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -elevationIncrementInHydrostaticPressureTable real64 0.6096 Elevation increment [m] in the hydrostatic pressure table constructed internally -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -equilibrationTolerance real64 0.001 Tolerance in the fixed-point iteration scheme used for hydrostatic initialization -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialPhaseName groupNameRef Name of the phase initially saturating the reservoir -logLevel integer 0 Log level -maxNumberOfEquilibrationIterations integer 5 Maximum number of equilibration iterations -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -temperatureVsElevationTableName groupNameRef Name of the table specifying the (temperature [K] vs elevation) relationship -============================================ ================== ======== ==================================================================================================== +============================================ ================== ======== ============================================================================================================================================================= +Name Type Default Description +============================================ ================== ======== ============================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +componentFractionVsElevationTableNames groupNameRef_array {} Names of the tables specifying the (component fraction vs elevation) relationship for each component +componentNames string_array {} Names of the fluid components +datumElevation real64 required Datum elevation [m] +datumPressure real64 required Datum pressure [Pa] +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +elevationIncrementInHydrostaticPressureTable real64 0.6096 Elevation increment [m] in the hydrostatic pressure table constructed internally +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +equilibrationTolerance real64 0.001 Tolerance in the fixed-point iteration scheme used for hydrostatic initialization +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialPhaseName groupNameRef Name of the phase initially saturating the reservoir +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +maxNumberOfEquilibrationIterations integer 5 Maximum number of equilibration iterations +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +temperatureVsElevationTableName groupNameRef Name of the table specifying the (temperature [K] vs elevation) relationship +============================================ ================== ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/InternalWell.rst b/src/coreComponents/schema/docs/InternalWell.rst index bb26958fc59..8b37a5409bf 100644 --- a/src/coreComponents/schema/docs/InternalWell.rst +++ b/src/coreComponents/schema/docs/InternalWell.rst @@ -1,19 +1,20 @@ -===================== =================== ======== ==================================================================================================== -Name Type Default Description -===================== =================== ======== ==================================================================================================== -logLevel integer 0 Log level -minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] -minSegmentLength real64 0.01 Minimum length of a well segment [m] -name groupName required A name is required for any non-unique nodes -numElementsPerSegment integer required Number of well elements per polyline segment -polylineNodeCoords real64_array2d required Physical coordinates of the well polyline nodes -polylineSegmentConn globalIndex_array2d required Connectivity of the polyline segments -radius real64 required Radius of the well [m] -wellControlsName string required Name of the set of constraints associated with this well -wellRegionName string required Name of the well element region -Perforation node :ref:`XML_Perforation` -===================== =================== ======== ==================================================================================================== +===================== =================== ======== ============================================================================================================================================================= +Name Type Default Description +===================== =================== ======== ============================================================================================================================================================= +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] +minSegmentLength real64 0.01 Minimum length of a well segment [m] +name groupName required A name is required for any non-unique nodes +numElementsPerSegment integer required Number of well elements per polyline segment +polylineNodeCoords real64_array2d required Physical coordinates of the well polyline nodes +polylineSegmentConn globalIndex_array2d required Connectivity of the polyline segments +radius real64 required Radius of the well [m] +wellControlsName string required Name of the set of constraints associated with this well +wellRegionName string required Name of the well element region +Perforation node :ref:`XML_Perforation` +===================== =================== ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/LaplaceFEM.rst b/src/coreComponents/schema/docs/LaplaceFEM.rst index 2353f6bde5f..bc04a0493f9 100644 --- a/src/coreComponents/schema/docs/LaplaceFEM.rst +++ b/src/coreComponents/schema/docs/LaplaceFEM.rst @@ -1,20 +1,28 @@ -========================= ======================================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ======================================== ======== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fieldName groupNameRef required Name of field variable -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_LaplaceBaseH1_TimeIntegrationOption required | Time integration method. Options are: - | * SteadyState - | * ImplicitTransient -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ======================================== ======== ======================================================================================================================================================================================================================================================================================================================== +========================= ======================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ======================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fieldName groupNameRef required Name of field variable +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_LaplaceBaseH1_TimeIntegrationOption required | Time integration method. Options are: + | * SteadyState + | * ImplicitTransient +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ======================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/LinearSolverParameters.rst b/src/coreComponents/schema/docs/LinearSolverParameters.rst index 67d62e850dd..0486315e51a 100644 --- a/src/coreComponents/schema/docs/LinearSolverParameters.rst +++ b/src/coreComponents/schema/docs/LinearSolverParameters.rst @@ -34,7 +34,8 @@ krylovTol real64 1e- | the relative residual norm satisfies: | :math:`\left\lVert \mathsf{b} - \mathsf{A} \mathsf{x}_k \right\rVert_2` < ``krylovTol`` * :math:`\left\lVert\mathsf{b}\right\rVert_2` krylovWeakestTol real64 0.001 Weakest-allowed tolerance for adaptive method -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. preconditionerType geos_LinearSolverParameters_PreconditionerType iluk Preconditioner type. Available options are: ``none\|jacobi\|l1jacobi\|fgs\|sgs\|l1sgs\|chebyshev\|iluk\|ilut\|icc\|ict\|amg\|mgr\|block\|direct\|bgs`` solverType geos_LinearSolverParameters_SolverType direct Linear solver type. Available options are: ``direct\|cg\|gmres\|fgmres\|bicgstab\|preconditioner`` stopIfError integer 1 Whether to stop the simulation if the linear solver reports an error diff --git a/src/coreComponents/schema/docs/Mesh.rst b/src/coreComponents/schema/docs/Mesh.rst index b64bf1d9e19..daca929392e 100644 --- a/src/coreComponents/schema/docs/Mesh.rst +++ b/src/coreComponents/schema/docs/Mesh.rst @@ -1,12 +1,16 @@ -================ ==== ======= =========================== -Name Type Default Description -================ ==== ======= =========================== -InternalMesh node :ref:`XML_InternalMesh` -InternalWellbore node :ref:`XML_InternalWellbore` -ParticleMesh node :ref:`XML_ParticleMesh` -VTKMesh node :ref:`XML_VTKMesh` -================ ==== ======= =========================== +================ ======= ======= ======================================================================================================================================================================================================================================== +Name Type Default Description +================ ======= ======= ======================================================================================================================================================================================================================================== +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display informations about imported field name on region/subRegion +InternalMesh node :ref:`XML_InternalMesh` +InternalWellbore node :ref:`XML_InternalWellbore` +ParticleMesh node :ref:`XML_ParticleMesh` +VTKMesh node :ref:`XML_VTKMesh` +================ ======= ======= ======================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst index 8ce423105cc..3b5b8eb2631 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst @@ -1,24 +1,32 @@ -========================= ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. -stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: + | None - Add no stabilization to mass equation, + | Global - Add stabilization to all faces, + | Local - Add stabilization only to interiors of macro elements. +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst b/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst index 27129634c0b..7fae6d809b6 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst @@ -1,12 +1,13 @@ -=========================== ============ ======== ========================================================================== -Name Type Default Description -=========================== ============ ======== ========================================================================== -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ========================================================================== +=========================== ============ ======== ============================================================================================================================================================= +Name Type Default Description +=========================== ============ ======== ============================================================================================================================================================= +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +=========================== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst index b2ccf01c20b..3f3f25116f9 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst @@ -5,7 +5,10 @@ Name Type Default Description ========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 and if the well is injector and crossflow enbled: + | Display warnings about crossflow for injectors name groupName required A name is required for any non-unique nodes poromechanicsSolverName groupNameRef required Name of the poromechanics solver used by the coupled solver targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. diff --git a/src/coreComponents/schema/docs/NonlinearSolverParameters.rst b/src/coreComponents/schema/docs/NonlinearSolverParameters.rst index 0a48c42e401..9dcdf9b49c4 100644 --- a/src/coreComponents/schema/docs/NonlinearSolverParameters.rst +++ b/src/coreComponents/schema/docs/NonlinearSolverParameters.rst @@ -17,7 +17,10 @@ lineSearchInterpolationType geos_NonlinearSolverParameters_LineSearchInterpol | * Parabolic lineSearchMaxCuts integer 4 Maximum number of line search cuts. lineSearchStartingIteration integer 0 Iteration when line search starts. -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display informations about NonLinearSolver parameters maxAllowedResidualNorm real64 1e+09 Maximum value of residual norm that is allowed in a Newton loop maxNumConfigurationAttempts integer 10 Max number of times that the configuration can be changed maxSubSteps integer 10 Maximum number of time sub-steps allowed for the solver diff --git a/src/coreComponents/schema/docs/PML.rst b/src/coreComponents/schema/docs/PML.rst index 7aa79ed39a6..ca9c41cfb6d 100644 --- a/src/coreComponents/schema/docs/PML.rst +++ b/src/coreComponents/schema/docs/PML.rst @@ -1,26 +1,27 @@ -====================== ================== ======================================== ================================================================================================== -Name Type Default Description -====================== ================== ======================================== ================================================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -reflectivity real32 0.001 Desired reflectivity of the PML region, used to compute the damping profile -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -thicknessMaxXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at right, back, and bottom sides, used to compute the damping profile -thicknessMinXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at left, front, and top sides, used to compute the damping profile -waveSpeedMaxXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at right, back, and bottom sides, used to compute the damping profile -waveSpeedMinXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at left, front, and top sides, used to compute the damping profile -xMax R1Tensor32 {3.40282e+38,3.40282e+38,3.40282e+38} Maximum (x,y,z) coordinates of the inner PML boundaries -xMin R1Tensor32 {-3.40282e+38,-3.40282e+38,-3.40282e+38} Minimum (x,y,z) coordinates of the inner PML boundaries -====================== ================== ======================================== ================================================================================================== +====================== ================== ======================================== ============================================================================================================================================================= +Name Type Default Description +====================== ================== ======================================== ============================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +reflectivity real32 0.001 Desired reflectivity of the PML region, used to compute the damping profile +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +thicknessMaxXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at right, back, and bottom sides, used to compute the damping profile +thicknessMinXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at left, front, and top sides, used to compute the damping profile +waveSpeedMaxXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at right, back, and bottom sides, used to compute the damping profile +waveSpeedMinXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at left, front, and top sides, used to compute the damping profile +xMax R1Tensor32 {3.40282e+38,3.40282e+38,3.40282e+38} Maximum (x,y,z) coordinates of the inner PML boundaries +xMin R1Tensor32 {-3.40282e+38,-3.40282e+38,-3.40282e+38} Minimum (x,y,z) coordinates of the inner PML boundaries +====================== ================== ======================================== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/PVTDriver.rst b/src/coreComponents/schema/docs/PVTDriver.rst index 6faf196ec68..187db2887d4 100644 --- a/src/coreComponents/schema/docs/PVTDriver.rst +++ b/src/coreComponents/schema/docs/PVTDriver.rst @@ -1,19 +1,23 @@ -====================== ============ ======== ================================================================ -Name Type Default Description -====================== ============ ======== ================================================================ -baseline path none Baseline file -feedComposition real64_array required Feed composition array [mol fraction] -fluid groupNameRef required Fluid to test -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -output string none Output file -outputCompressibility integer 0 Flag to indicate that the total compressibility should be output -outputPhaseComposition integer 0 Flag to indicate that phase compositions should be output -pressureControl groupNameRef required Function controlling pressure time history -steps integer required Number of load steps to take -temperatureControl groupNameRef required Function controlling temperature time history -====================== ============ ======== ================================================================ +====================== ============ ======== ======================================================================================================================================================================================================================================================================== +Name Type Default Description +====================== ============ ======== ======================================================================================================================================================================================================================================================================== +baseline path none Baseline file +feedComposition real64_array required Feed composition array [mol fraction] +fluid groupNameRef required Fluid to test +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display informations about PVTDriver + | - Indicate at the end if the internal results are consistent +name groupName required A name is required for any non-unique nodes +output string none Output file +outputCompressibility integer 0 Flag to indicate that the total compressibility should be output +outputPhaseComposition integer 0 Flag to indicate that phase compositions should be output +pressureControl groupNameRef required Function controlling pressure time history +steps integer required Number of load steps to take +temperatureControl groupNameRef required Function controlling temperature time history +====================== ============ ======== ======================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/PeriodicEvent.rst b/src/coreComponents/schema/docs/PeriodicEvent.rst index 3f1c9b21b88..ecf3561ddd9 100644 --- a/src/coreComponents/schema/docs/PeriodicEvent.rst +++ b/src/coreComponents/schema/docs/PeriodicEvent.rst @@ -9,7 +9,8 @@ endTime real64 1e+100 End time of this event. finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). function groupNameRef Name of an optional function to evaluate when the time/cycle criteria are met.If the result is greater than the specified eventThreshold, the function will continue to execute. -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). name groupName required A name is required for any non-unique nodes object groupNameRef If the optional function requires an object as an input, specify its path here. diff --git a/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst b/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst index d0d26cc6fb3..b605130f3b2 100644 --- a/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst +++ b/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst @@ -1,21 +1,34 @@ -========================= ============================================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================================== ======== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -damageUpperBound real64 1.5 The upper bound of the damage -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fieldName groupNameRef required name of field variable -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -irreversibilityFlag integer 0 The flag to indicate whether to apply the irreversibility constraint -localDissipation geos_PhaseFieldDamageFEM_LocalDissipation required Type of local dissipation function. Can be Linear or Quadratic -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_PhaseFieldDamageFEM_TimeIntegrationOption required option for default time integration method -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================================== ======== ======================================================================================================================================================================================================================================================================================================================== +========================= ============================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +damageUpperBound real64 1.5 The upper bound of the damage +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fieldName groupNameRef required name of field variable +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +irreversibilityFlag integer 0 The flag to indicate whether to apply the irreversibility constraint +localDissipation geos_PhaseFieldDamageFEM_LocalDissipation required Type of local dissipation function. Can be Linear or Quadratic +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 2 : + | - Display the jacobian matrix + | + | 2 : + | - Display the residuals values +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_PhaseFieldDamageFEM_TimeIntegrationOption required option for default time integration method +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/PhaseFieldFracture.rst b/src/coreComponents/schema/docs/PhaseFieldFracture.rst index 0c7e530a888..0bd35ae5eec 100644 --- a/src/coreComponents/schema/docs/PhaseFieldFracture.rst +++ b/src/coreComponents/schema/docs/PhaseFieldFracture.rst @@ -1,17 +1,25 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -damageSolverName groupNameRef required Name of the damage solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +damageSolverName groupNameRef required Name of the damage solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ProppantTransport.rst b/src/coreComponents/schema/docs/ProppantTransport.rst index c7b0b39c500..4dc9b15c718 100644 --- a/src/coreComponents/schema/docs/ProppantTransport.rst +++ b/src/coreComponents/schema/docs/ProppantTransport.rst @@ -1,28 +1,41 @@ -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -bridgingFactor real64 0 Bridging factor used for bridging/screen-out calculation -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -criticalShieldsNumber real64 0 Critical Shields number -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -frictionCoefficient real64 0.03 Friction coefficient -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxProppantConcentration real64 0.6 Maximum proppant concentration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -proppantDensity real64 2500 Proppant density -proppantDiameter real64 0.0004 Proppant diameter -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -updateProppantPacking integer 0 Flag that enables/disables proppant-packing update -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +bridgingFactor real64 0 Bridging factor used for bridging/screen-out calculation +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +criticalShieldsNumber real64 0 Critical Shields number +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +frictionCoefficient real64 0.03 Friction coefficient +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 1 : + | - Display the boundary conditions + | 1 : + | - Display the residuals norm values + | +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxProppantConcentration real64 0.6 Maximum proppant concentration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +proppantDensity real64 2500 Proppant density +proppantDiameter real64 0.0004 Proppant diameter +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +updateProppantPacking integer 0 Flag that enables/disables proppant-packing update +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ReactiveBrine.rst b/src/coreComponents/schema/docs/ReactiveBrine.rst index d710c396a38..d31e604d12b 100644 --- a/src/coreComponents/schema/docs/ReactiveBrine.rst +++ b/src/coreComponents/schema/docs/ReactiveBrine.rst @@ -1,14 +1,18 @@ -==================== ================== ======== ============================================================================================================ -Name Type Default Description -==================== ================== ======== ============================================================================================================ -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -==================== ================== ======== ============================================================================================================ +==================== ================== ======== ============================================================================================================================================================================================= +Name Type Default Description +==================== ================== ======== ============================================================================================================================================================================================= +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display phase PVT Table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +==================== ================== ======== ============================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ReactiveBrineThermal.rst b/src/coreComponents/schema/docs/ReactiveBrineThermal.rst index d710c396a38..d31e604d12b 100644 --- a/src/coreComponents/schema/docs/ReactiveBrineThermal.rst +++ b/src/coreComponents/schema/docs/ReactiveBrineThermal.rst @@ -1,14 +1,18 @@ -==================== ================== ======== ============================================================================================================ -Name Type Default Description -==================== ================== ======== ============================================================================================================ -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -==================== ================== ======== ============================================================================================================ +==================== ================== ======== ============================================================================================================================================================================================= +Name Type Default Description +==================== ================== ======== ============================================================================================================================================================================================= +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display phase PVT Table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +==================== ================== ======== ============================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst b/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst index da7fa66a198..cfd5f6bc402 100644 --- a/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst +++ b/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst @@ -1,31 +1,48 @@ -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -OBLOperatorsTableFile path required File containing OBL operator values -allowLocalOBLChopping integer 1 Allow keeping solution within OBL limits -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -componentNames string_array {} List of component names -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -enableEnergyBalance integer required Enable energy balance calculation and temperature degree of freedom -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -numComponents integer required Number of components -numPhases integer required Number of phases -phaseNames groupNameRef_array {} List of fluid phases -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -transMultExp real64 1 Exponent of dynamic transmissibility multiplier -useDARTSL2Norm integer 1 Use L2 norm calculation similar to one used DARTS -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +OBLOperatorsTableFile path required File containing OBL operator values +allowLocalOBLChopping integer 1 Allow keeping solution within OBL limits +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +componentNames string_array {} List of component names +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +enableEnergyBalance integer required Enable energy balance calculation and temperature degree of freedom +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 1 : + | - Display the boundary conditions + | 1 and first nonlinear iteration : + | - Display the source flux boundary conditions + | - Display the Dirichlet pressure boundary conditions + | - Display the Dirichlet temperature boundary conditions + | + | 1 : + | - Display the residuals values +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +numComponents integer required Number of components +numPhases integer required Number of phases +phaseNames groupNameRef_array {} List of fluid phases +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +transMultExp real64 1 Exponent of dynamic transmissibility multiplier +useDARTSL2Norm integer 1 Use L2 norm calculation similar to one used DARTS +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ReactiveFluidDriver.rst b/src/coreComponents/schema/docs/ReactiveFluidDriver.rst index b2c089baae6..b2f8296b046 100644 --- a/src/coreComponents/schema/docs/ReactiveFluidDriver.rst +++ b/src/coreComponents/schema/docs/ReactiveFluidDriver.rst @@ -1,17 +1,21 @@ -================== ============ ======== =================================================================== -Name Type Default Description -================== ============ ======== =================================================================== -baseline path none Baseline file -feedComposition real64_array required Feed composition array: total concentration of the primary species -fluid groupNameRef required Fluid to test -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -output string none Output file -pressureControl groupNameRef required Function controlling pressure time history -steps integer required Number of load steps to take -temperatureControl groupNameRef required Function controlling temperature time history -================== ============ ======== =================================================================== +================== ============ ======== ================================================================================================================================================================================================================================================================================ +Name Type Default Description +================== ============ ======== ================================================================================================================================================================================================================================================================================ +baseline path none Baseline file +feedComposition real64_array required Feed composition array: total concentration of the primary species +fluid groupNameRef required Fluid to test +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Print informations about ReactiveFluidDriver + | - Indicate at the end if the internal results are consistent +name groupName required A name is required for any non-unique nodes +output string none Output file +pressureControl groupNameRef required Function controlling pressure time history +steps integer required Number of load steps to take +temperatureControl groupNameRef required Function controlling temperature time history +================== ============ ======== ================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/Rectangle.rst b/src/coreComponents/schema/docs/Rectangle.rst index 2413e9f671b..f27ef28a511 100644 --- a/src/coreComponents/schema/docs/Rectangle.rst +++ b/src/coreComponents/schema/docs/Rectangle.rst @@ -1,15 +1,19 @@ -============ ============ ======== ================================================================================================================= -Name Type Default Description -============ ============ ======== ================================================================================================================= -dimensions real64_array required Length and width of the bounded plane -lengthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. -name groupName required A name is required for any non-unique nodes -normal R1Tensor required Normal (n_x,n_y,n_z) to the plane (will be normalized automatically) -origin R1Tensor required Origin point (x,y,z) of the plane (basically, any point on the plane) -tolerance real64 1e-05 Tolerance to determine if a point sits on the plane or not. It is relative to the maximum dimension of the plane. -widthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. -============ ============ ======== ================================================================================================================= +============ ============ ======== ====================================================================================================================================================================================================================================== +Name Type Default Description +============ ============ ======== ====================================================================================================================================================================================================================================== +dimensions real64_array required Length and width of the bounded plane +lengthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 2 : + | - Display informations about length and width of the bounded plane +name groupName required A name is required for any non-unique nodes +normal R1Tensor required Normal (n_x,n_y,n_z) to the plane (will be normalized automatically) +origin R1Tensor required Origin point (x,y,z) of the plane (basically, any point on the plane) +tolerance real64 1e-05 Tolerance to determine if a point sits on the plane or not. It is relative to the maximum dimension of the plane. +widthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. +============ ============ ======== ====================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/RelpermDriver.rst b/src/coreComponents/schema/docs/RelpermDriver.rst index 090a04d2c45..43705b99755 100644 --- a/src/coreComponents/schema/docs/RelpermDriver.rst +++ b/src/coreComponents/schema/docs/RelpermDriver.rst @@ -1,14 +1,18 @@ -======== ============ ======== =========================================== -Name Type Default Description -======== ============ ======== =========================================== -baseline path none Baseline file -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -output string none Output file -relperm groupNameRef required Relperm model to test -steps integer required Number of saturation steps to take -======== ============ ======== =========================================== +======== ============ ======== ====================================================================================================================================================================================================================================================================== +Name Type Default Description +======== ============ ======== ====================================================================================================================================================================================================================================================================== +baseline path none Baseline file +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Print informations about ReactiveFluidDriver + | - Indicate if the internal results are consistent +name groupName required A name is required for any non-unique nodes +output string none Output file +relperm groupNameRef required Relperm model to test +steps integer required Number of saturation steps to take +======== ============ ======== ====================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseFVM.rst b/src/coreComponents/schema/docs/SinglePhaseFVM.rst index 6000056c728..6379daa4deb 100644 --- a/src/coreComponents/schema/docs/SinglePhaseFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseFVM.rst @@ -1,22 +1,29 @@ -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display the residual values + | + | 1 and first nonlinear iterations : + | - Display the face boundary condition defined with pressure + | - Display the face boundary condition defined with temperature +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst index 6000056c728..7e9d1db10d6 100644 --- a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst @@ -1,22 +1,45 @@ -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 1 : + | - Display the boundary conditions + | 1 and first nonlinear iteration : + | - Display the boundary conditions log message + | + | 1 and number of nonlinear iterations > 0 : + | - Display the boundary conditions log message + | + | 1 : + | - Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | 1 : + | - Display the residuals values + | + | 1 : and first nonlinear iteration : + | - Display the face boundary conditions definied with pressure +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst index 89d7b79139b..b2db7efd740 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst @@ -1,18 +1,26 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst index 89d7b79139b..7a5c65074bb 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst @@ -7,7 +7,11 @@ cflFactor real64 0.5 Factor to apply to the `CF flowSolverName groupNameRef required Name of the flow solver used by the coupled solver initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 3 : + | - Display the summary of declared fields and coupling. + | name groupName required A name is required for any non-unique nodes solidSolverName groupNameRef required Name of the solid solver used by the coupled solver targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst index 89d7b79139b..b2db7efd740 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst @@ -1,18 +1,26 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst index 27129634c0b..7fae6d809b6 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst @@ -1,12 +1,13 @@ -=========================== ============ ======== ========================================================================== -Name Type Default Description -=========================== ============ ======== ========================================================================== -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ========================================================================== +=========================== ============ ======== ============================================================================================================================================================= +Name Type Default Description +=========================== ============ ======== ============================================================================================================================================================= +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +=========================== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst index b2ccf01c20b..d4e4395ae2f 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst @@ -1,17 +1,25 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -poromechanicsSolverName groupNameRef required Name of the poromechanics solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -wellSolverName groupNameRef required Name of the well solver used by the coupled solver -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst index 6000056c728..6379daa4deb 100644 --- a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst @@ -1,22 +1,29 @@ -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display the residual values + | + | 1 and first nonlinear iterations : + | - Display the face boundary condition defined with pressure + | - Display the face boundary condition defined with temperature +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoir.rst b/src/coreComponents/schema/docs/SinglePhaseReservoir.rst index f25a13fb960..03ae85cf577 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoir.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoir.rst @@ -1,17 +1,25 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -wellSolverName groupNameRef required Name of the well solver used by the coupled solver -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst index e19bd9b1ac7..a60a5a925e8 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst @@ -1,18 +1,26 @@ -=========================== ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -=========================== ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -=========================== ================== ======== ====================================================================================================================================================================================================================================================================================================================== +=========================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=========================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +=========================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst index 27129634c0b..7fae6d809b6 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst @@ -1,12 +1,13 @@ -=========================== ============ ======== ========================================================================== -Name Type Default Description -=========================== ============ ======== ========================================================================== -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ========================================================================== +=========================== ============ ======== ============================================================================================================================================================= +Name Type Default Description +=========================== ============ ======== ============================================================================================================================================================= +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +=========================== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhaseStatistics.rst b/src/coreComponents/schema/docs/SinglePhaseStatistics.rst index ff3105519bd..9234e338ad2 100644 --- a/src/coreComponents/schema/docs/SinglePhaseStatistics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseStatistics.rst @@ -1,12 +1,13 @@ -============== ============ ======== =========================================== -Name Type Default Description -============== ============ ======== =========================================== -flowSolverName groupNameRef required Name of the flow solver -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -writeCSV integer 0 Write statistics into a CSV file -============== ============ ======== =========================================== +============== ============ ======== ============================================================================================================================================================= +Name Type Default Description +============== ============ ======== ============================================================================================================================================================= +flowSolverName groupNameRef required Name of the flow solver +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +writeCSV integer 0 Write statistics into a CSV file +============== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhaseWell.rst b/src/coreComponents/schema/docs/SinglePhaseWell.rst index ba2a66c6297..a934fd9334a 100644 --- a/src/coreComponents/schema/docs/SinglePhaseWell.rst +++ b/src/coreComponents/schema/docs/SinglePhaseWell.rst @@ -1,17 +1,37 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -writeCSV integer 0 Write rates into a CSV file -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -WellControls node :ref:`XML_WellControls` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 0 : + | - Display the residuals norm values + | + | 1 : + | - Output well rates to a simple csv file + | + | 2 : + | - Display the BHP pressure + | - Display the surface density + | + | 2 and use surface conditions: + | - Display phase and total density in the reference element +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +writeCSV integer 0 Write rates into a CSV file +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +WellControls node :ref:`XML_WellControls` +========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst index c51f1d33c6b..816f21abec1 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst @@ -6,7 +6,12 @@ Name Type cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display informations about number of elements for each fracture states: + | 1 : + | - Display informations about residual norm for each fractures massDamping real64 0 Value of mass based damping coefficient. maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. name groupName required A name is required for any non-unique nodes diff --git a/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst b/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst index dcc17ebc657..0ff25c4ba1d 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst @@ -1,29 +1,34 @@ -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -massDamping real64 0 Value of mass based damping coefficient. -maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. -name groupName required A name is required for any non-unique nodes -newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. -newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option -stabilizationName groupNameRef required Name of the stabilization to use in the lagrangian contact solver -stiffnessDamping real64 0 Value of stiffness based damping coefficient. -strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: - | 0 - Infinitesimal Strain - | 1 - Finite Strain -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================== =============== =================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ====================================================== =============== =================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display informations about number of elements for each fracture states: + | 1 : + | - Display informations about risidual norm (Rdisplacement, Rtraction, Rtotal) +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stabilizationName groupNameRef required Name of the stabilization to use in the lagrangian contact solver +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== =================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst b/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst index 21cdc11d22d..511f50b3191 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst @@ -1,30 +1,43 @@ -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -massDamping real64 0 Value of mass based damping coefficient. -maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. -name groupName required A name is required for any non-unique nodes -newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. -newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option -stiffnessDamping real64 0 Value of stiffness based damping coefficient. -strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: - | 0 - Infinitesimal Strain - | 1 - Finite Strain -surfaceGeneratorName string Name of the surface generator to use -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 2 : + | Display a warning about boundary conditions + | + | 2 : + | Display residuals values +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +surfaceGeneratorName string Name of the surface generator to use +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst b/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst index c8483e51e88..ba6f587b61e 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst @@ -1,13 +1,14 @@ -=================== ============ ======== ============================================ -Name Type Default Description -=================== ============ ======== ============================================ -disableInelasticity integer 0 Flag to enable/disable inelastic behavior -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -resetDisplacements integer 1 Flag to reset displacements (and velocities) -solidSolverName groupNameRef required Name of the solid mechanics solver -=================== ============ ======== ============================================ +=================== ============ ======== ============================================================================================================================================================= +Name Type Default Description +=================== ============ ======== ============================================================================================================================================================= +disableInelasticity integer 0 Flag to enable/disable inelastic behavior +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +resetDisplacements integer 1 Flag to reset displacements (and velocities) +solidSolverName groupNameRef required Name of the solid mechanics solver +=================== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst b/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst index 2395830a112..fe77de7e265 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst @@ -1,12 +1,13 @@ -=============== ============ ======== =========================================== -Name Type Default Description -=============== ============ ======== =========================================== -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver -writeCSV integer 0 Write statistics into a CSV file -=============== ============ ======== =========================================== +=============== ============ ======== ============================================================================================================================================================= +Name Type Default Description +=============== ============ ======== ============================================================================================================================================================= +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver +writeCSV integer 0 Write statistics into a CSV file +=============== ============ ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst b/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst index 21cdc11d22d..511f50b3191 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst @@ -1,30 +1,43 @@ -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -massDamping real64 0 Value of mass based damping coefficient. -maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. -name groupName required A name is required for any non-unique nodes -newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. -newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option -stiffnessDamping real64 0 Value of stiffness based damping coefficient. -strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: - | 0 - Infinitesimal Strain - | 1 - Finite Strain -surfaceGeneratorName string Name of the surface generator to use -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 2 : + | Display a warning about boundary conditions + | + | 2 : + | Display residuals values +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +surfaceGeneratorName string Name of the surface generator to use +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SolidMechanics_MPM.rst b/src/coreComponents/schema/docs/SolidMechanics_MPM.rst index 2c7d14f5866..da7df8e05d4 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_MPM.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_MPM.rst @@ -1,41 +1,49 @@ -============================== ============================================ =============== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ============================================ =============== ======================================================================================================================================================================================================================================================================================================================== -boundaryConditionTypes integer_array {0} | Boundary conditions on x-, x+, y-, y+, z- and z+ faces. Options are: - | * Outflow - | * Symmetry -boxAverageHistory integer 0 Flag for whether to output box average history -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactGapCorrection integer 0 Flag for mitigating contact gaps -cpdiDomainScaling integer 0 Option for CPDI domain scaling -damageFieldPartitioning integer 0 Flag for using the gradient of the particle damage field to partition material into separate velocity fields -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fTableInterpType integer 0 The type of F table interpolation. Options are 0 (linear), 1 (cosine), 2 (quintic polynomial). -fTablePath path Path to f-table -frictionCoefficient real64 0 Coefficient of friction, currently assumed to be the same everywhere -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -needsNeighborList integer 0 Flag for whether to construct neighbor list -neighborRadius real64 -1 Neighbor radius for SPH-type calculations -planeStrain integer 0 Flag for performing plane strain calculations -prescribedBcTable integer 0 Flag for whether to have time-dependent boundary condition types -prescribedBoundaryFTable integer 0 Flag for whether to have time-dependent boundary conditions described by a global background grid F -reactionHistory integer 0 Flag for whether to output face reaction history -separabilityMinDamage real64 0.5 Damage threshold for field separability -solverProfiling integer 0 Flag for timing subroutines in the solver -surfaceDetection integer 0 Flag for automatic surface detection on the 1st cycle -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsMPM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -treatFullyDamagedAsSingleField integer 1 Whether to consolidate fully damaged fields into a single field. Nice for modeling damaged mush. -useDamageAsSurfaceFlag integer 0 Indicates whether particle damage at the beginning of the simulation should be interpreted as a surface flag -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ============================================ =============== ======================================================================================================================================================================================================================================================================================================================== +============================== ============================================ =============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ============================================ =============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +boundaryConditionTypes integer_array {0} | Boundary conditions on x-, x+, y-, y+, z- and z+ faces. Options are: + | * Outflow + | * Symmetry +boxAverageHistory integer 0 Flag for whether to output box average history +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactGapCorrection integer 0 Flag for mitigating contact gaps +cpdiDomainScaling integer 0 Option for CPDI domain scaling +damageFieldPartitioning integer 0 Flag for using the gradient of the particle damage field to partition material into separate velocity fields +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fTableInterpType integer 0 The type of F table interpolation. Options are 0 (linear), 1 (cosine), 2 (quintic polynomial). +fTablePath path Path to f-table +frictionCoefficient real64 0 Coefficient of friction, currently assumed to be the same everywhere +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) +name groupName required A name is required for any non-unique nodes +needsNeighborList integer 0 Flag for whether to construct neighbor list +neighborRadius real64 -1 Neighbor radius for SPH-type calculations +planeStrain integer 0 Flag for performing plane strain calculations +prescribedBcTable integer 0 Flag for whether to have time-dependent boundary condition types +prescribedBoundaryFTable integer 0 Flag for whether to have time-dependent boundary conditions described by a global background grid F +reactionHistory integer 0 Flag for whether to output face reaction history +separabilityMinDamage real64 0.5 Damage threshold for field separability +solverProfiling integer 0 Flag for timing subroutines in the solver +surfaceDetection integer 0 Flag for automatic surface detection on the 1st cycle +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsMPM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +treatFullyDamagedAsSingleField integer 1 Whether to consolidate fully damaged fields into a single field. Nice for modeling damaged mush. +useDamageAsSurfaceFlag integer 0 Indicates whether particle damage at the beginning of the simulation should be interpreted as a surface flag +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ============================================ =============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SoloEvent.rst b/src/coreComponents/schema/docs/SoloEvent.rst index de9a7ad86ee..2c63976fbad 100644 --- a/src/coreComponents/schema/docs/SoloEvent.rst +++ b/src/coreComponents/schema/docs/SoloEvent.rst @@ -7,7 +7,8 @@ beginTime real64 0 Start time of this event. endTime real64 1e+100 End time of this event. finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). name groupName required A name is required for any non-unique nodes target groupNameRef Name of the object to be executed when the event criteria are met. diff --git a/src/coreComponents/schema/docs/SourceFlux.rst b/src/coreComponents/schema/docs/SourceFlux.rst index c227dcbd7d8..e45ea333e5d 100644 --- a/src/coreComponents/schema/docs/SourceFlux.rst +++ b/src/coreComponents/schema/docs/SourceFlux.rst @@ -1,20 +1,21 @@ -====================== ================== ======== ============================================================================== -Name Type Default Description -====================== ================== ======== ============================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ============================================================================== +====================== ================== ======== ============================================================================================================================================================= +Name Type Default Description +====================== ================== ======== ============================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialCondition integer 0 Boundary condition is applied as an initial condition. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +====================== ================== ======== ============================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SurfaceGenerator.rst b/src/coreComponents/schema/docs/SurfaceGenerator.rst index 36b64dffb8b..c491beabdd6 100644 --- a/src/coreComponents/schema/docs/SurfaceGenerator.rst +++ b/src/coreComponents/schema/docs/SurfaceGenerator.rst @@ -1,20 +1,37 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -fractureRegion groupNameRef Fracture (no description available) -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isPoroelastic integer 0 Flag that defines whether the material is poroelastic or not. -logLevel integer 0 Log level -mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering -name groupName required A name is required for any non-unique nodes -nodeBasedSIF integer 0 Flag for choosing between node or edge based criteria: 1 for node based criterion -rockToughness real64 required Rock toughness of the solid material -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +Name Type Default Description +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +fractureRegion groupNameRef Fracture (no description available) +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isPoroelastic integer 0 Flag that defines whether the material is poroelastic or not. +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display information about line search + | - Display global solution scaling factor + | 1 and step remaining : + | - Display informations about timestep + | only with loglevel = 2 : + | - Display informations about linear algebra objects (matrices and vectors) + | 1 : + | - Display informations about splitting node/edge/faces + | + | 2 : + | - Display informations about all elements attached to the nodeID + | - Display informations about all faces on their element + | + | 3 : + | - Display consistency checking of the maps +mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering +name groupName required A name is required for any non-unique nodes +nodeBasedSIF integer 0 Flag for choosing between node or edge based criteria: 1 for node based criterion +rockToughness real64 required Rock toughness of the solid material +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/Traction.rst b/src/coreComponents/schema/docs/Traction.rst index 58522e086bc..f31a5a7342f 100644 --- a/src/coreComponents/schema/docs/Traction.rst +++ b/src/coreComponents/schema/docs/Traction.rst @@ -10,7 +10,8 @@ endTime real64 1e+99 functionName groupNameRef Name of function that specifies variation of the boundary condition. initialCondition integer 0 Boundary condition is applied as an initial condition. inputStress R2SymTensor {0,0,0,0,0,0} Input stress for tractionType = stress -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. name groupName required A name is required for any non-unique nodes objectPath groupNameRef Path to the target field scale real64 0 Scale factor for value of the boundary condition. diff --git a/src/coreComponents/schema/docs/TriaxialDriver.rst b/src/coreComponents/schema/docs/TriaxialDriver.rst index d8144999bee..371f0d67f96 100644 --- a/src/coreComponents/schema/docs/TriaxialDriver.rst +++ b/src/coreComponents/schema/docs/TriaxialDriver.rst @@ -1,18 +1,22 @@ -============= ======================== ======== ===================================================================== -Name Type Default Description -============= ======================== ======== ===================================================================== -axialControl groupNameRef required Function controlling axial stress or strain (depending on test mode) -baseline path none Baseline file -initialStress real64 required Initial stress (scalar used to set an isotropic stress state) -logLevel integer 0 Log level -material groupNameRef required Solid material to test -mode geos_TriaxialDriver_Mode required Test mode [stressControl, strainControl, mixedControl] -name groupName required A name is required for any non-unique nodes -output string none Output file -radialControl groupNameRef required Function controlling radial stress or strain (depending on test mode) -steps integer required Number of load steps to take -============= ======================== ======== ===================================================================== +============= ======================== ======== ================================================================================================================================================================================================================================================================ +Name Type Default Description +============= ======================== ======== ================================================================================================================================================================================================================================================================ +axialControl groupNameRef required Function controlling axial stress or strain (depending on test mode) +baseline path none Baseline file +initialStress real64 required Initial stress (scalar used to set an isotropic stress state) +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Print informations about TriaxialDriver + | - Indicate if the internal results are consistent +material groupNameRef required Solid material to test +mode geos_TriaxialDriver_Mode required Test mode [stressControl, strainControl, mixedControl] +name groupName required A name is required for any non-unique nodes +output string none Output file +radialControl groupNameRef required Function controlling radial stress or strain (depending on test mode) +steps integer required Number of load steps to take +============= ======================== ======== ================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/VTK.rst b/src/coreComponents/schema/docs/VTK.rst index 3a376546ee3..25eeb14615f 100644 --- a/src/coreComponents/schema/docs/VTK.rst +++ b/src/coreComponents/schema/docs/VTK.rst @@ -7,7 +7,8 @@ childDirectory string Child directory pat fieldNames groupNameRef_array {} Names of the fields to output. If this attribute is specified, GEOSX outputs all the fields specified by the user, regardless of their `plotLevel` format geos_vtk_VTKOutputMode binary Output data format. Valid options: ``binary``, ``ascii`` levelNames string_array {} Names of mesh levels to output. -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. name groupName required A name is required for any non-unique nodes onlyPlotSpecifiedFieldNames integer 0 If this flag is equal to 1, then we only plot the fields listed in `fieldNames`. Otherwise, we plot all the fields with the required `plotLevel`, plus the fields listed in `fieldNames` outputRegionType geos_vtk_VTKRegionTypes all Output region types. Valid options: ``cell``, ``well``, ``surface``, ``particle``, ``all`` diff --git a/src/coreComponents/schema/docs/VTKMesh.rst b/src/coreComponents/schema/docs/VTKMesh.rst index 688b0d98319..c18077338ed 100644 --- a/src/coreComponents/schema/docs/VTKMesh.rst +++ b/src/coreComponents/schema/docs/VTKMesh.rst @@ -7,7 +7,16 @@ faceBlocks groupNameRef_array {} For multi-block files, fieldNamesInGEOSX groupNameRef_array {} Names of the volumic fields in GEOSX to import into fieldsToImport groupNameRef_array {} Volumic fields to be imported from the external mesh file file path required Path to the mesh file -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display cell block names + | + | 2 : + | - Display node sets names + | + | 5 : + | - Display informations about redistribution mainBlockName groupNameRef main For multi-block files, name of the 3d mesh block. name groupName required A name is required for any non-unique nodes nodesetNames groupNameRef_array {} Names of the VTK nodesets to import diff --git a/src/coreComponents/schema/docs/VTKWell.rst b/src/coreComponents/schema/docs/VTKWell.rst index 0df45b1798d..2f458ebe9e0 100644 --- a/src/coreComponents/schema/docs/VTKWell.rst +++ b/src/coreComponents/schema/docs/VTKWell.rst @@ -1,17 +1,21 @@ -===================== ========= ======== ==================================================================================================== -Name Type Default Description -===================== ========= ======== ==================================================================================================== -file path required Path to the well file -minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] -minSegmentLength real64 0.01 Minimum length of a well segment [m] -name groupName required A name is required for any non-unique nodes -numElementsPerSegment integer required Number of well elements per polyline segment -radius real64 required Radius of the well [m] -wellControlsName string required Name of the set of constraints associated with this well -wellRegionName string required Name of the well element region -Perforation node :ref:`XML_Perforation` -===================== ========= ======== ==================================================================================================== +===================== ========= ======== ====================================================================================================================================================================================================================================== +Name Type Default Description +===================== ========= ======== ====================================================================================================================================================================================================================================== +file path required Path to the well file +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | 1 : + | - Display informations about Internal wells and their perforations +minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] +minSegmentLength real64 0.01 Minimum length of a well segment [m] +name groupName required A name is required for any non-unique nodes +numElementsPerSegment integer required Number of well elements per polyline segment +radius real64 required Radius of the well [m] +wellControlsName string required Name of the set of constraints associated with this well +wellRegionName string required Name of the well element region +Perforation node :ref:`XML_Perforation` +===================== ========= ======== ====================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/WellControls.rst b/src/coreComponents/schema/docs/WellControls.rst index 6560ae29291..a1b49972142 100644 --- a/src/coreComponents/schema/docs/WellControls.rst +++ b/src/coreComponents/schema/docs/WellControls.rst @@ -16,7 +16,8 @@ initialPressureCoefficient real64 0.1 | Tuning coefficie | - Producer pressure at reference depth initialized as: (1-initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) injectionStream real64_array {-1} Global component densities of the injection stream [moles/m^3 or kg/m^3] injectionTemperature real64 -1 Temperature of the injection stream [K] -logLevel integer 0 Log level +logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. name groupName required A name is required for any non-unique nodes referenceElevation real64 required Reference elevation where BHP control is enforced [m] statusTableName groupNameRef | Name of the well status table when the status of the well is a time dependent function. diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index 965cf0f3546..150423e2f38 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -904,8 +904,9 @@ - - + + @@ -929,8 +930,9 @@ - - + + @@ -960,8 +962,9 @@ - - + + @@ -997,8 +1000,9 @@ - - + + @@ -1074,8 +1078,9 @@ This keyword is ignored for single-phase flow simulations--> - - + + @@ -1103,8 +1108,9 @@ This keyword is ignored for single-phase flow simulations--> - - + + @@ -1131,8 +1137,9 @@ This keyword is ignored for single-phase flow simulations--> - - + + @@ -1167,8 +1174,9 @@ This keyword is ignored for single-phase flow simulations--> - - + + @@ -1193,8 +1201,9 @@ This keyword is ignored for single-phase flow simulations--> - - + + @@ -1233,8 +1242,9 @@ This keyword is ignored for single-phase flow simulations--> - - + + @@ -1259,8 +1269,9 @@ This keyword is ignored for single-phase flow simulations--> - - + + @@ -1410,6 +1421,11 @@ stress - traction is applied to the faces as specified by the inner product of i + + @@ -1465,6 +1481,11 @@ stress - traction is applied to the faces as specified by the inner product of i + + @@ -1514,8 +1535,9 @@ stress - traction is applied to the faces as specified by the inner product of i - - + + @@ -1551,6 +1573,11 @@ stress - traction is applied to the faces as specified by the inner product of i + + @@ -1657,8 +1684,17 @@ stress - traction is applied to the faces as specified by the inner product of i - - + + @@ -1789,8 +1825,9 @@ the relative residual norm satisfies: - - + + @@ -1870,8 +1907,11 @@ the relative residual norm satisfies: - - + + @@ -2073,8 +2113,9 @@ the relative residual norm satisfies: - - + + @@ -2170,8 +2211,16 @@ the relative residual norm satisfies: - - + + @@ -2204,8 +2253,16 @@ the relative residual norm satisfies: - - + + @@ -2261,8 +2318,16 @@ the relative residual norm satisfies: - - + + @@ -2313,8 +2378,16 @@ the relative residual norm satisfies: - - + + @@ -2361,8 +2434,27 @@ the relative residual norm satisfies: - - + + @@ -2439,8 +2531,24 @@ the relative residual norm satisfies: - - + + @@ -2491,8 +2599,11 @@ the relative residual norm satisfies: - - + + @@ -2511,8 +2622,16 @@ the relative residual norm satisfies: - - + + @@ -2548,8 +2667,28 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -2584,8 +2723,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + - - + + @@ -2708,8 +2856,16 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - - + + @@ -2750,8 +2906,16 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - - + + @@ -2772,8 +2936,16 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - - + + @@ -2798,8 +2970,12 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - - + + @@ -2833,8 +3009,16 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - - + + - - + + @@ -2889,8 +3081,11 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -2919,8 +3114,21 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -2949,8 +3157,16 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -2979,8 +3195,21 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3023,8 +3252,25 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3063,8 +3309,15 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3093,8 +3346,31 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3121,8 +3397,16 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3143,8 +3427,12 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3165,8 +3453,16 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3183,8 +3479,16 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3209,8 +3513,15 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3235,8 +3546,16 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3255,8 +3574,16 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3276,8 +3603,28 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3296,8 +3643,13 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3340,8 +3692,13 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3381,8 +3738,21 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3422,8 +3792,21 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3479,8 +3862,16 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3531,8 +3922,25 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3562,8 +3970,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3578,8 +3987,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3588,8 +3998,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3604,8 +4015,12 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3642,8 +4057,12 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3658,8 +4077,12 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3670,8 +4093,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3680,8 +4104,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3692,8 +4117,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3702,8 +4128,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3712,8 +4139,9 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3728,8 +4156,12 @@ Local - Add stabilization only to interiors of macro elements.--> - - + + @@ -3953,8 +4385,11 @@ The expected format is "{ waterMax, oilMax }", in that order--> - - + + @@ -3973,8 +4408,11 @@ The expected format is "{ waterMax, oilMax }", in that order--> - - + + @@ -3993,8 +4431,11 @@ The expected format is "{ waterMax, oilMax }", in that order--> - - + + @@ -4013,8 +4454,11 @@ The expected format is "{ waterMax, oilMax }", in that order--> - - + + @@ -4988,6 +5432,11 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia + + @@ -5002,6 +5451,11 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia + + From 55ef101928730069101361861ea0f1a46c4860b1 Mon Sep 17 00:00:00 2001 From: arng40 Date: Thu, 16 May 2024 16:56:04 +0200 Subject: [PATCH 03/18] log level documentation sorted --- .../multifluid/CO2Brine/CO2BrineFluid.cpp | 4 +- .../fluid/multifluid/PVTDriver.cpp | 6 +-- .../reactive/ReactiveBrineFluid.cpp | 5 +-- .../reactive/ReactiveFluidDriver.cpp | 8 ++-- .../relativePermeability/RelpermDriver.cpp | 6 +-- .../constitutive/solid/TriaxialDriver.cpp | 8 ++-- src/coreComponents/dataRepository/Group.cpp | 32 ++++++++++++-- src/coreComponents/dataRepository/Group.hpp | 15 +++++++ .../dataRepository/WrapperBase.hpp | 44 ++++++++++++++++++- src/coreComponents/mesh/MeshManager.cpp | 3 +- .../mesh/generators/VTKMeshGenerator.cpp | 10 ++--- .../mesh/generators/WellGeneratorBase.cpp | 3 +- .../mesh/simpleGeometricObjects/Rectangle.cpp | 3 +- .../NonlinearSolverParameters.cpp | 3 +- .../physicsSolvers/SolverBase.cpp | 22 ++++++---- .../contact/ContactSolverBase.cpp | 3 +- .../SolidMechanicsEmbeddedFractures.cpp | 3 +- .../contact/SolidMechanicsLagrangeContact.cpp | 3 +- .../fluidFlow/CompositionalMultiphaseBase.cpp | 7 +-- .../fluidFlow/CompositionalMultiphaseFVM.cpp | 7 +-- .../CompositionalMultiphaseHybridFVM.cpp | 4 +- .../fluidFlow/FlowSolverBase.cpp | 3 +- .../ReactiveCompositionalMultiphaseOBL.cpp | 12 +++-- .../fluidFlow/SinglePhaseBase.cpp | 10 ++--- .../fluidFlow/SinglePhaseFVM.cpp | 9 ++-- .../fluidFlow/SinglePhaseHybridFVM.cpp | 9 ++-- .../proppantTransport/ProppantTransport.cpp | 4 +- .../wells/CompositionalMultiphaseWell.cpp | 15 +++---- .../fluidFlow/wells/SinglePhaseWell.cpp | 15 +++---- ...mpositionalMultiphaseReservoirAndWells.cpp | 4 +- .../multiphysics/HydrofractureSolver.cpp | 3 +- ...ePhasePoromechanicsConformingFractures.cpp | 3 +- .../simplePDE/PhaseFieldDamageFEM.cpp | 7 +-- .../surfaceGeneration/SurfaceGenerator.cpp | 12 ++--- 34 files changed, 164 insertions(+), 141 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index af4414e1732..fc29532fc2c 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -112,8 +112,8 @@ CO2BrineFluid( string const & name, Group * const parent ): setPlotLevel( PlotLevel::LEVEL_0 ). setRestartFlags( RestartFlags::WRITE_AND_READ ); } - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display PVT phase table" ); + + appendLogLevel( { "logLevel >= 1", "Display PVT phase table" } ); } template< typename PHASE1, typename PHASE2, typename FLASH > diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index 580bc90dcb1..49ad7af89a9 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -86,10 +86,8 @@ PVTDriver::PVTDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Display informations about PVTDriver\n" - "- Indicate at the end if the internal results are consistent" ); + appendLogLevel( { "logLevel >= 1", "Display information about test" } ); + appendLogLevel( { "logLevel >= 1", "Indicate at the end if the internal results are consistent" } ); } void PVTDriver::postProcessInput() diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 9e1be14d05c..5812330682a 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -63,7 +63,7 @@ ReactiveBrineFluid< PHASE > :: ReactiveBrineFluid( string const & name, Group * const parent ): ReactiveMultiFluid( name, parent ) { - enableLogLevelInput(); + enableLogLevelInput(); registerWrapper( viewKeyStruct::phasePVTParaFilesString(), &m_phasePVTParaFiles ). setInputFlag( InputFlags::REQUIRED ). @@ -82,8 +82,7 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display phase PVT Table" ); + appendLogLevel( { "logLevel >= 1", "Display phase PVT Table" } ); } template< typename PHASE > diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index e0a5e46f3ed..e3520c8e593 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -66,11 +66,9 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Print informations about ReactiveFluidDriver\n" - "- Indicate at the end if the internal results are consistent" ); + + appendLogLevel( { "logLevel >= 1", "Print informations about ReactiveFluidDriver" } ); + appendLogLevel( { "logLevel >= 1", "Indicate at the end if the internal results are consistent" } ); } diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index 4cff6059e37..561825cc47d 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -53,10 +53,8 @@ RelpermDriver::RelpermDriver( const geos::string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Print informations about ReactiveFluidDriver \n" - "- Indicate if the internal results are consistent" ); + appendLogLevel( { "logLevel >= 1", "Print informations about ReactiveFluidDriver" } ); + appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } ); } diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index 106fc7a8401..32661b34c8f 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -67,11 +67,9 @@ TriaxialDriver::TriaxialDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Print informations about TriaxialDriver\n" - "- Indicate if the internal results are consistent" ); + + appendLogLevel( { "logLevel >= 1", "Print informations about TriaxialDriver" } ); + appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } ); } diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index f66f3317b0b..ab188234c8f 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -79,6 +79,33 @@ void Group::deregisterWrapper( string const & name ) m_conduitNode.remove( name ); } +void Group::appendLogLevel( std::pair< const std::string, const std::string > log ) +{ + // 1. register le wrapper + + //TODO condition pour enable loglevel w description + //rajouter if wrapper existe pas + + std::string const levelToAppend = "\n" + log.first + "\n"; + std::string const descriptionToAppend = log.second; + + string wrapperName = viewKeyStruct::logLevelString(); + try + { + WrapperBase & wrapper = getWrapperBase( wrapperName ); + wrapper.addEntrieLogLevel( levelToAppend, descriptionToAppend ); + wrapper.buildDescription(); + }catch( std::domain_error const & ) + { + WrapperBase & wrapper = registerWrapper( wrapperName, &m_logLevel ); + registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ). + setApplyDefaultValue( 1 ). + setInputFlag( InputFlags::OPTIONAL ); + wrapper.addEntrieLogLevel( levelToAppend, descriptionToAppend ); + wrapper.buildDescription(); + } + +} void Group::resize( indexType const newSize ) { @@ -642,14 +669,13 @@ void Group::postRestartInitializationRecursive() postRestartInitialization(); } +//TODO ARN DELETE void Group::enableLogLevelInput() { // TODO : Improve the Log Level description to clearly assign a usecase per log level (incoming PR). registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ). setApplyDefaultValue( 1 ). - setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Sets the level of information to write in the standard output (the console typically).\n" - "A level of 0 outputs minimal information, higher levels require more." ); + setInputFlag( InputFlags::OPTIONAL ); } Group const & Group::getBaseGroupByPath( string const & path ) const diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index 84a26c1af6b..a311b232a94 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -854,6 +854,18 @@ class Group ///@} //END_SPHINX_INCLUDE_REGISTER_WRAPPER + /** + * @param logs + */ + void appendLogLevel( std::pair< const std::string, const std::string > log ); + + /** + * @return The log levels descriptions for a gtoup + */ + std::string const & getLogLevelDescription(); + + void appendLogLevelDescription( std::string const & description ); + /** * @name Schema generation methods */ @@ -1606,6 +1618,9 @@ class Group /// Verbosity flag for group logs integer m_logLevel; + + std::string m_logLevelDescription; + //END_SPHINX_INCLUDE_02 /// Restart flag for this group... and subsequently all wrappers in this group. diff --git a/src/coreComponents/dataRepository/WrapperBase.hpp b/src/coreComponents/dataRepository/WrapperBase.hpp index d44e24c2e6b..ce7b99225a9 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -515,10 +515,30 @@ class WrapperBase */ WrapperBase & appendDescription( string const & description ) { - m_description += description; + m_description = description; return *this; } + void buildDescription() + { + string descriptionToBuild; + descriptionToBuild.append( "Sets the level of information to write in the standard output (the console typically).\n" + "A level of 0 outputs minimal information, higher levels require more." ); + for( auto const & [logLevel, logDescriptions] : m_logLevelsDescriptions ) + { + descriptionToBuild.append( logLevel ); + size_t idxDescription = 0; + for( const auto & description : logDescriptions ) + { + idxDescription == logDescriptions.size() - 1 ? descriptionToBuild.append( " - " + description ) : + descriptionToBuild.append( " - " + description + "\n" ); + idxDescription++; + } + } + appendDescription( descriptionToBuild ); + } + + /** * @brief Get the description string of the wrapper. * @return this wrapper's description string @@ -528,6 +548,22 @@ class WrapperBase return m_description; } + /** + * @return The map of logs levels description + */ + std::map< std::string, std::vector< std::string > > const & getlogLevelsDescriptions() + { + return m_logLevelsDescriptions; + } + + /** + * @return Add a logLevel/description + */ + void addEntrieLogLevel( std::string levelToAppend, std::string descriptionToAppend ) + { + m_logLevelsDescriptions[levelToAppend].push_back( descriptionToAppend ); + } + /** * @brief @return a table formatted string containing the input options. * @param outputHeader If true outputs the table header, otherwise just @@ -706,6 +742,10 @@ class WrapperBase /// A string description of the wrapped object string m_description; + /// Map for building the log level string for each wrapper + /// key : logLevel, values : description(s) for a level + std::map< std::string, std::vector< std::string > > m_logLevelsDescriptions; + /// A string regex to validate the input values string to parse for the wrapped object string m_rtTypeName; @@ -782,7 +822,7 @@ class WrapperBase parallelDeviceEvents & events ) const = 0; }; -} /// namespace dataRepository +} /// namespace dataRepository } /// namespace geos #endif /* GEOS_DATAREPOSITORY_WRAPPERBASE_HPP_ */ diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index f3e834baab8..104a297a2a1 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -37,8 +37,7 @@ MeshManager::MeshManager( string const & name, enableLogLevelInput(); setInputFlags( InputFlags::REQUIRED ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display informations about imported field name on region/subRegion" ); + appendLogLevel( { "logLevel >= 1", "Display informations about imported field name on region/subRegion" } ); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index cdaa84009b9..14312dad283 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -77,13 +77,9 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, " If set to a negative value, the GlobalId arrays in the input mesh are not used, and generated global Ids are automatically generated." " If set to a positive value, the GlobalId arrays in the input mesh are used and required, and the simulation aborts if they are not available" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Display cell block names\n" - "\n2 :\n" - "- Display node sets names\n" - "\n5 :\n" - "- Display informations about redistribution" ); + appendLogLevel( { "logLevel >= 1", "Display cell block names" } ); + appendLogLevel( { "logLevel >= 2", "Display node sets names" } ); + appendLogLevel( { "logLevel >= 5", "Display informations about redistribution" } ); } void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index 1ac4d1db735..1d05740ccf4 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -73,8 +73,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display informations about Internal wells and their perforations" ); + appendLogLevel( { "logLevel >= 1", "Display informations about Internal wells and their perforations" } ); } Group * WellGeneratorBase::createChild( string const & childKey, string const & childName ) diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 0494ab5c09b..92e0f351a5b 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -44,8 +44,7 @@ Rectangle::Rectangle( const string & name, Group * const parent ): setDescription( "Tolerance to determine if a point sits on the plane or not. " "It is relative to the maximum dimension of the plane." ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n2 :\n- Display informations about length and width of the bounded plane" ); + appendLogLevel( { "logLevel >= 2", "Display informations about length and width of the bounded plane" } ); m_points.resize( 4, 3 ); } diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index add40103a9a..a85e1144bb9 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -165,8 +165,7 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display informations about NonLinearSolver parameters" ); + appendLogLevel( { "logLevel >= 1", "Display informations about NonLinearSolver parameters" } ); } diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index 418f40cac8e..673f5b1829f 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -89,14 +89,20 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Initial time-step value required by the solver to the event manager." ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Display information about line search\n" - "- Display global solution scaling factor" - "\n1 and step remaining :\n" - "- Display informations about timestep" - "\nonly with loglevel = 2 :\n" - "- Display informations about linear algebra objects (matrices and vectors)" ); + // getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). + // appendDescription( "\n1 :\n" + // "- 1: Display information about line search\n" + // "- 1: Display global solution scaling factor" + // "\n1:\n" + // "- 1 : Display informations about timestep" + // "\n - 2 :\n" + // "- Display informations about linear algebra objects (matrices and vectors)" + // "\n- 3 :\n" + // "- Display informations about linear algebra objects (matrices and vectors)" ); + + appendLogLevel( { "logLevel >= 1", "Display information about test" } ); + appendLogLevel( { "logLevel >= 2 and writeCSV = 1", "write a csv of internal data" } ); + appendLogLevel( { "logLevel >= 1", "Display information about line search" } ); registerGroup( groupKeyStruct::linearSolverParametersString(), &m_linearSolverParameters ); registerGroup( groupKeyStruct::nonlinearSolverParametersString(), &m_nonlinearSolverParameters ); diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index c25b253184d..ad6e6cb687b 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -50,8 +50,7 @@ ContactSolverBase::ContactSolverBase( const string & name, this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n - Display informations about number of elements for each fracture states:" ); + appendLogLevel( { "logLevel >= 1", "Display informations about number of elements for each fracture states" } ); } void ContactSolverBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp index 9ab9b54d4f2..5cbb890b32b 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp @@ -51,8 +51,7 @@ SolidMechanicsEmbeddedFractures::SolidMechanicsEmbeddedFractures( const string & setApplyDefaultValue( 0 ). setDescription( "Defines whether to use static condensation or not." ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n - Display informations about residual norm for each fractures" ); + appendLogLevel( { "logLevel >= 1", "Display informations about residual norm for each fractures" } ); } SolidMechanicsEmbeddedFractures::~SolidMechanicsEmbeddedFractures() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp index b67d92c14c5..7abab706940 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp @@ -64,8 +64,7 @@ SolidMechanicsLagrangeContact::SolidMechanicsLagrangeContact( const string & nam setInputFlag( InputFlags::REQUIRED ). setDescription( "Name of the stabilization to use in the lagrangian contact solver" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n - Display informations about risidual norm (Rdisplacement, Rtraction, Rtotal)" ); + appendLogLevel( { "logLevel >= 1", "Display informations about risidual norm (Rdisplacement, Rtraction, Rtotal)" } ); LinearSolverParameters & linSolParams = m_linearSolverParameters.get(); linSolParams.mgr.strategy = LinearSolverParameters::MGR::StrategyType::lagrangianContactMechanics; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index f4341509256..f56336fe920 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -152,11 +152,8 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setApplyDefaultValue( 1.0 ). setDescription( "Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n 1 and first nonlinear iteration :\n" - "- Display the residuals values" - "\n1 :\n" - "- Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); + appendLogLevel( { "logLevel >= 1", "Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); + appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the residuals values" } ); } void CompositionalMultiphaseBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index b76a2025db5..7dfe416ca93 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -87,11 +87,8 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Display the residual values\n" - "\n1: and non first nonlinear iteration\n" - "- Display face boundary conditions log" ); + appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); + appendLogLevel( { "logLevel >= 1 and non first nonlinear iteration", "Display face boundary conditions log" } ); } void CompositionalMultiphaseFVM::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp index a95e5d8adb4..7e6299b2f20 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,9 +49,7 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { - - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display the residual values" ); + appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::compositionalMultiphaseHybridFVM; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp index 0c18e353f59..0752a5a0736 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -119,8 +119,7 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display the boundary conditions" ); + appendLogLevel( { "logLevel >= 1", "Display the boundary conditions" } ); // allow the user to select a norm getNonlinearSolverParameters().getWrapper< solverBaseKernels::NormType >( NonlinearSolverParameters::viewKeysStruct::normTypeString() ).setInputFlag( InputFlags::OPTIONAL ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index 395f4ec1acf..cb2dd7c0776 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -115,13 +115,11 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n 1 and first nonlinear iteration :\n" - "- Display the source flux boundary conditions\n" - "- Display the Dirichlet pressure boundary conditions\n" - "- Display the Dirichlet temperature boundary conditions\n" - "\n1 :\n" - "- Display the residuals values" ); + appendLogLevel( { "logLevel >= 1", "Display the residuals values" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the source flux boundary conditions" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the Dirichlet pressure boundary conditions" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the Dirichlet pressure boundary conditions" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the Dirichlet temperature boundary conditions" } ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp index 1df746a153b..f91258460eb 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -59,13 +59,9 @@ SinglePhaseBase::SinglePhaseBase( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Temperature" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n 1 and first nonlinear iteration :\n" - "- Display the boundary conditions log message\n" - "\n 1 and number of nonlinear iterations > 0 :\n" - "- Display the boundary conditions log message\n" - "\n1 :\n" - "- Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); + appendLogLevel( { "logLevel >= 1", "Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); + appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the boundary conditions log message" } ); + appendLogLevel( { "logLevel >= 1 and number of nonlinear iterations > 0", "Display the boundary conditions log message" } ); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 1b53584fd60..9ddbd0404d5 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -61,12 +61,9 @@ SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, { SinglePhaseBase::enableLogLevelInput(); - SinglePhaseBase::getWrapperBase( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n 1 :\n" - "- Display the residual values\n" - "\n1 and first nonlinear iterations :\n" - "- Display the face boundary condition defined with pressure\n" - "- Display the face boundary condition defined with temperature" ); + SinglePhaseBase::appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); + SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the residual values" } ); + SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the face boundary condition defined with temperature" } ); } template< typename BASE > diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index c65aacc6da8..fcaf46c06ef 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -46,12 +46,9 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, SinglePhaseBase( name, parent ), m_areaRelTol( 1e-8 ) { - - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n 1 :\n" - "- Display the residuals values\n" - "\n1 : and first nonlinear iteration :\n" - "- Display the face boundary conditions definied with pressure" ); + + appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); + appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the face boundary conditions definied with pressure" } ); // one cell-centered dof per cell m_numDofPerCell = 1; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp index 86348915808..008d2f830df 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp @@ -78,9 +78,7 @@ ProppantTransport::ProppantTransport( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag that enables/disables proppant-packing update" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display the residuals norm values\n" ); - + appendLogLevel( { "logLevel >= 1", "Display the residual norm values" } ); } void ProppantTransport::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 43f077d7b04..7649ef243d2 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -102,16 +102,11 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setApplyDefaultValue( 1 ). setDescription( "Flag indicating whether local (cell-wise) chopping of negative compositions is allowed" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n 0 :\n" - "- Display the residuals norm values\n" - "\n 1 :\n" - "- Output well rates to a simple csv file\n" - "\n 2 :\n" - "- Display the BHP pressure\n" - "- Display the surface density\n" - "\n 2 and use surface conditions:\n" - "- Display phase and total density in the reference element" ); + appendLogLevel( { "logLevel >= 0", "Display the residual values" } ); + appendLogLevel( { "logLevel >= 1", "Output well rates to a simple csv file" } ); + appendLogLevel( { "logLevel >= 2", "Display the BHP pressure" } ); + appendLogLevel( { "logLevel >= 2", "Display the surface density" } ); + appendLogLevel( { "logLevel >= 2 and use surface conditions", "Display phase and total density in the reference element" } ); } void CompositionalMultiphaseWell::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index 4a6102ba0f9..5437e5a3712 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -46,16 +46,11 @@ SinglePhaseWell::SinglePhaseWell( const string & name, Group * const parent ): WellSolverBase( name, parent ) { - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n 0 :\n" - "- Display the residuals norm values\n" - "\n 1 :\n" - "- Output well rates to a simple csv file\n" - "\n 2 :\n" - "- Display the BHP pressure\n" - "- Display the surface density\n" - "\n 2 and use surface conditions:\n" - "- Display phase and total density in the reference element" ); + appendLogLevel( { "logLevel >= 0", "Display the residual values" } ); + appendLogLevel( { "logLevel >= 1", "Output well rates to a simple csv file" } ); + appendLogLevel( { "logLevel >= 2", "Display the BHP pressure" } ); + appendLogLevel( { "logLevel >= 2", "Display the surface density" } ); + appendLogLevel( { "logLevel >= 2 and use surface conditions", "Display phase and total density in the reference element" } ); m_numDofPerWellElement = 2; m_numDofPerResElement = 1; diff --git a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp index 096727f8a35..bbf87e97140 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -78,9 +78,7 @@ CompositionalMultiphaseReservoirAndWells( const string & name, { Base::enableLogLevelInput(); - Base::getWrapperBase( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 and if the well is injector and crossflow enbled:\n" - "Display warnings about crossflow for injectors" ); + Base::appendLogLevel( { "logLevel >= 1 and if the well is injector and crossflow enabled", "Display warnings about crossflow for injectors" } ); } template< typename COMPOSITIONAL_RESERVOIR_SOLVER > diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index eff5a4ce29a..71bb7845458 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -109,8 +109,7 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); - Base::getWrapperBase( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n- Display whether or not we Re-entering Newton Solve \n" ); + Base::appendLogLevel( { "logLevel >= 1", "Display whether or not we Re-entering Newton Solve" } ); m_numResolves[0] = 0; diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index 8696c3f2470..d6d77b24698 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -42,8 +42,7 @@ SinglePhasePoromechanicsConformingFractures::SinglePhasePoromechanicsConformingF { enableLogLevelInput(); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n3 :\n- Display the summary of declared fields and coupling.\n" ); + appendLogLevel( { "logLevel >= 3", "Display the summary of declared fields and coupling" } ); LinearSolverParameters & params = m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; diff --git a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp index 70b067bc960..0d0c36d1f0a 100644 --- a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp +++ b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp @@ -81,11 +81,8 @@ PhaseFieldDamageFEM::PhaseFieldDamageFEM( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "The upper bound of the damage" ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n2 :\n" - "- Display the jacobian matrix\n" - "\n2 :\n" - "- Display the residuals values" ); + appendLogLevel( { "logLevel >= 2", "Display the jacobian matrix" } ); + appendLogLevel( { "logLevel >= 2", "Display the residuals values" } ); } PhaseFieldDamageFEM::~PhaseFieldDamageFEM() diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index fc854f4f1e9..2d627ad2e26 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -220,14 +220,10 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n1 :\n" - "- Display informations about splitting node/edge/faces\n" - "\n2 :\n" - "- Display informations about all elements attached to the nodeID\n" - "- Display informations about all faces on their element\n" - "\n3 :\n" - "- Display consistency checking of the maps" ); + appendLogLevel( { "logLevel >= 1", "Display informations about splitting node/edge/faces" } ); + appendLogLevel( { "logLevel >= 2", "Display informations about all elements attached to the nodeID" } ); + appendLogLevel( { "logLevel >= 2", "Display informations about all faces on their element" } ); + appendLogLevel( { "logLevel >= 3", "Display consistency checking of the maps" } ); } void SurfaceGenerator::postProcessInput() From b55bb0458a334f166cbe5e559aab7865d6672448 Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 17 May 2024 11:54:36 +0200 Subject: [PATCH 04/18] log-level doc correction --- .../multifluid/CO2Brine/CO2BrineFluid.cpp | 2 +- .../fluid/multifluid/PVTDriver.cpp | 2 +- .../reactive/ReactiveBrineFluid.cpp | 2 +- .../reactive/ReactiveFluidDriver.cpp | 2 +- .../relativePermeability/RelpermDriver.cpp | 2 +- .../constitutive/solid/TriaxialDriver.cpp | 2 +- src/coreComponents/mesh/MeshManager.cpp | 2 +- .../mesh/generators/VTKMeshGenerator.cpp | 6 +++--- .../mesh/generators/WellGeneratorBase.cpp | 2 +- .../mesh/simpleGeometricObjects/Rectangle.cpp | 2 +- .../NonlinearSolverParameters.cpp | 2 +- .../physicsSolvers/SolverBase.cpp | 21 +++++++------------ .../contact/ContactSolverBase.cpp | 2 +- .../SolidMechanicsEmbeddedFractures.cpp | 2 +- .../contact/SolidMechanicsLagrangeContact.cpp | 2 +- .../fluidFlow/CompositionalMultiphaseBase.cpp | 4 ++-- .../fluidFlow/CompositionalMultiphaseFVM.cpp | 4 ++-- .../CompositionalMultiphaseHybridFVM.cpp | 2 +- .../fluidFlow/FlowSolverBase.cpp | 2 +- .../ReactiveCompositionalMultiphaseOBL.cpp | 10 ++++----- .../fluidFlow/SinglePhaseBase.cpp | 5 ++--- .../fluidFlow/SinglePhaseFVM.cpp | 6 +++--- .../fluidFlow/SinglePhaseHybridFVM.cpp | 6 +++--- .../proppantTransport/ProppantTransport.cpp | 2 +- .../wells/CompositionalMultiphaseWell.cpp | 8 +++---- .../fluidFlow/wells/SinglePhaseWell.cpp | 8 +++---- ...mpositionalMultiphaseReservoirAndWells.cpp | 2 +- .../multiphysics/HydrofractureSolver.cpp | 2 +- ...ePhasePoromechanicsConformingFractures.cpp | 2 +- .../simplePDE/PhaseFieldDamageFEM.cpp | 4 ++-- .../SolidMechanicsLagrangianFEM.cpp | 7 ++----- .../surfaceGeneration/SurfaceGenerator.cpp | 8 +++---- 32 files changed, 62 insertions(+), 73 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index fc29532fc2c..a273065736f 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -113,7 +113,7 @@ CO2BrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevel( { "logLevel >= 1", "Display PVT phase table" } ); + appendLogLevel( { "logLevel >= 1", "Informations on PVT phase table" } ); } template< typename PHASE1, typename PHASE2, typename FLASH > diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index 49ad7af89a9..4f1c47397f5 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -86,7 +86,7 @@ PVTDriver::PVTDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Display information about test" } ); + appendLogLevel( { "logLevel >= 1", "Informations about test" } ); appendLogLevel( { "logLevel >= 1", "Indicate at the end if the internal results are consistent" } ); } diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 5812330682a..23f868a4771 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -82,7 +82,7 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevel( { "logLevel >= 1", "Display phase PVT Table" } ); + appendLogLevel( { "logLevel >= 1", "Infos about phase PVT Table" } ); } template< typename PHASE > diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index e3520c8e593..ef045cd8da8 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -67,7 +67,7 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Print informations about ReactiveFluidDriver" } ); + appendLogLevel( { "logLevel >= 1", "Infos about ReactiveFluidDriver" } ); appendLogLevel( { "logLevel >= 1", "Indicate at the end if the internal results are consistent" } ); } diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index 561825cc47d..8bc0247dda3 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -53,7 +53,7 @@ RelpermDriver::RelpermDriver( const geos::string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Print informations about ReactiveFluidDriver" } ); + appendLogLevel( { "logLevel >= 1", "Infos about RelpermDriver" } ); appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } ); } diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index 32661b34c8f..874234209d0 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -68,7 +68,7 @@ TriaxialDriver::TriaxialDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Print informations about TriaxialDriver" } ); + appendLogLevel( { "logLevel >= 1", "Infos about TriaxialDriver" } ); appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } ); } diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index 104a297a2a1..18be59f08af 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -37,7 +37,7 @@ MeshManager::MeshManager( string const & name, enableLogLevelInput(); setInputFlags( InputFlags::REQUIRED ); - appendLogLevel( { "logLevel >= 1", "Display informations about imported field name on region/subRegion" } ); + appendLogLevel( { "logLevel >= 1", "Infos about imported field name on region/subRegion" } ); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index 14312dad283..35d93ad1fa2 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -77,9 +77,9 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, " If set to a negative value, the GlobalId arrays in the input mesh are not used, and generated global Ids are automatically generated." " If set to a positive value, the GlobalId arrays in the input mesh are used and required, and the simulation aborts if they are not available" ); - appendLogLevel( { "logLevel >= 1", "Display cell block names" } ); - appendLogLevel( { "logLevel >= 2", "Display node sets names" } ); - appendLogLevel( { "logLevel >= 5", "Display informations about redistribution" } ); + appendLogLevel( { "logLevel >= 1", "Infos about cell block names" } ); + appendLogLevel( { "logLevel >= 2", "Infos about node sets names" } ); + appendLogLevel( { "logLevel >= 5", "Infos about redistribution" } ); } void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index 1d05740ccf4..c6ad6fb6bea 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -73,7 +73,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); - appendLogLevel( { "logLevel >= 1", "Display informations about Internal wells and their perforations" } ); + appendLogLevel( { "logLevel >= 1", "Infos about Internal wells and their perforations" } ); } Group * WellGeneratorBase::createChild( string const & childKey, string const & childName ) diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 92e0f351a5b..9a5694b6a7f 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -44,7 +44,7 @@ Rectangle::Rectangle( const string & name, Group * const parent ): setDescription( "Tolerance to determine if a point sits on the plane or not. " "It is relative to the maximum dimension of the plane." ); - appendLogLevel( { "logLevel >= 2", "Display informations about length and width of the bounded plane" } ); + appendLogLevel( { "logLevel >= 2", "Infos about length and width of the bounded plane" } ); m_points.resize( 4, 3 ); } diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index a85e1144bb9..fb009cc2f5a 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -165,7 +165,7 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); - appendLogLevel( { "logLevel >= 1", "Display informations about NonLinearSolver parameters" } ); + appendLogLevel( { "logLevel >= 1", "Infos about NonLinearSolver parameters" } ); } diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index 673f5b1829f..8e0d8b5aa43 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -89,20 +89,13 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Initial time-step value required by the solver to the event manager." ); - // getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - // appendDescription( "\n1 :\n" - // "- 1: Display information about line search\n" - // "- 1: Display global solution scaling factor" - // "\n1:\n" - // "- 1 : Display informations about timestep" - // "\n - 2 :\n" - // "- Display informations about linear algebra objects (matrices and vectors)" - // "\n- 3 :\n" - // "- Display informations about linear algebra objects (matrices and vectors)" ); - - appendLogLevel( { "logLevel >= 1", "Display information about test" } ); - appendLogLevel( { "logLevel >= 2 and writeCSV = 1", "write a csv of internal data" } ); - appendLogLevel( { "logLevel >= 1", "Display information about line search" } ); + appendLogLevel( { "logLevel >= 1", "Infos on line search" } ); + appendLogLevel( { "logLevel >= 1", "Infos global solution scaling factor" } ); + appendLogLevel( { "logLevel >= 1", "Output about the timestep" } ); + appendLogLevel( { "logLevel >= 2", "Output to screen the assembled linear system (matrices and vectors)" } ); + appendLogLevel( { "logLevel >= 2", "Output to screen the assembled linear solutions (matrices and vectors)" } ); + appendLogLevel( { "logLevel >= 3", "Output to file the assembled linear system (matrices and vectors)" } ); + appendLogLevel( { "logLevel >= 3", "Output to file the assembled linear solutions (matrices and vectors)" } ); registerGroup( groupKeyStruct::linearSolverParametersString(), &m_linearSolverParameters ); registerGroup( groupKeyStruct::nonlinearSolverParametersString(), &m_nonlinearSolverParameters ); diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index ad6e6cb687b..5e687772d7f 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -50,7 +50,7 @@ ContactSolverBase::ContactSolverBase( const string & name, this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); - appendLogLevel( { "logLevel >= 1", "Display informations about number of elements for each fracture states" } ); + appendLogLevel( { "logLevel >= 1", "Infos about number of elements for each fracture states" } ); } void ContactSolverBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp index 5cbb890b32b..b511cd15a75 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp @@ -51,7 +51,7 @@ SolidMechanicsEmbeddedFractures::SolidMechanicsEmbeddedFractures( const string & setApplyDefaultValue( 0 ). setDescription( "Defines whether to use static condensation or not." ); - appendLogLevel( { "logLevel >= 1", "Display informations about residual norm for each fractures" } ); + appendLogLevel( { "logLevel >= 1", "Infos on residual norm for each fractures" } ); } SolidMechanicsEmbeddedFractures::~SolidMechanicsEmbeddedFractures() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp index 7abab706940..4d01ff4e31c 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp @@ -64,7 +64,7 @@ SolidMechanicsLagrangeContact::SolidMechanicsLagrangeContact( const string & nam setInputFlag( InputFlags::REQUIRED ). setDescription( "Name of the stabilization to use in the lagrangian contact solver" ); - appendLogLevel( { "logLevel >= 1", "Display informations about risidual norm (Rdisplacement, Rtraction, Rtotal)" } ); + appendLogLevel( { "logLevel >= 1", "Infos on risidual norm (Rdisplacement, Rtraction, Rtotal)" } ); LinearSolverParameters & linSolParams = m_linearSolverParameters.get(); linSolParams.mgr.strategy = LinearSolverParameters::MGR::StrategyType::lagrangianContactMechanics; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index f56336fe920..1c9ec0966bf 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -152,8 +152,8 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setApplyDefaultValue( 1.0 ). setDescription( "Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevel( { "logLevel >= 1", "Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); - appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the residuals values" } ); + appendLogLevel( { "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); + appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about boundary conditions" } ); } void CompositionalMultiphaseBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index 7dfe416ca93..f9924e4d76e 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -87,8 +87,8 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); - appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); - appendLogLevel( { "logLevel >= 1 and non first nonlinear iteration", "Display face boundary conditions log" } ); + appendLogLevel( { "logLevel >= 1", "Informations on the residual values" } ); + appendLogLevel( { "logLevel >= 1 and non first nonlinear iteration", "Infos about the face boundary conditions log" } ); } void CompositionalMultiphaseFVM::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp index 7e6299b2f20..89780cb4a34 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,7 +49,7 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { - appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); + appendLogLevel( { "logLevel >= 1", "Infos on the residual values" } ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::compositionalMultiphaseHybridFVM; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp index 0752a5a0736..506a10bdb4a 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -119,7 +119,7 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevel( { "logLevel >= 1", "Display the boundary conditions" } ); + appendLogLevel( { "logLevel >= 1", "Infos about the boundary conditions" } ); // allow the user to select a norm getNonlinearSolverParameters().getWrapper< solverBaseKernels::NormType >( NonlinearSolverParameters::viewKeysStruct::normTypeString() ).setInputFlag( InputFlags::OPTIONAL ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index cb2dd7c0776..c697f96cb7e 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -115,11 +115,11 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); - appendLogLevel( { "logLevel >= 1", "Display the residuals values" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the source flux boundary conditions" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the Dirichlet pressure boundary conditions" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the Dirichlet pressure boundary conditions" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Display the Dirichlet temperature boundary conditions" } ); + appendLogLevel( { "logLevel >= 1", "Informations on the residuals values" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the boundary conditions" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet pressure boundary conditions" } ); + appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet temperature boundary conditions" } ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp index f91258460eb..e02af17a135 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -59,9 +59,8 @@ SinglePhaseBase::SinglePhaseBase( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Temperature" ); - appendLogLevel( { "logLevel >= 1", "Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); - appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the boundary conditions log message" } ); - appendLogLevel( { "logLevel >= 1 and number of nonlinear iterations > 0", "Display the boundary conditions log message" } ); + appendLogLevel( { "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); + appendLogLevel( { "logLevel >= 1", "Infos about boundary conditions" } ); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 9ddbd0404d5..4ed85cd2d0a 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -61,9 +61,9 @@ SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, { SinglePhaseBase::enableLogLevelInput(); - SinglePhaseBase::appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); - SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the residual values" } ); - SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the face boundary condition defined with temperature" } ); + SinglePhaseBase::appendLogLevel( { "logLevel >= 1", "Infos on the residual values" } ); + SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with pressure" } ); + SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with temperature" } ); } template< typename BASE > diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index fcaf46c06ef..c8bb105f645 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -46,9 +46,9 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, SinglePhaseBase( name, parent ), m_areaRelTol( 1e-8 ) { - - appendLogLevel( { "logLevel >= 1", "Display the residual values" } ); - appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Display the face boundary conditions definied with pressure" } ); + + appendLogLevel( { "logLevel >= 1", "Infos about the residual values" } ); + appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary conditions definied with pressure" } ); // one cell-centered dof per cell m_numDofPerCell = 1; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp index 008d2f830df..5aef8d73a4a 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp @@ -78,7 +78,7 @@ ProppantTransport::ProppantTransport( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag that enables/disables proppant-packing update" ); - appendLogLevel( { "logLevel >= 1", "Display the residual norm values" } ); + appendLogLevel( { "logLevel >= 1", "Infos on residual norm values" } ); } void ProppantTransport::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 7649ef243d2..9c495e968a3 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -102,11 +102,11 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setApplyDefaultValue( 1 ). setDescription( "Flag indicating whether local (cell-wise) chopping of negative compositions is allowed" ); - appendLogLevel( { "logLevel >= 0", "Display the residual values" } ); + appendLogLevel( { "logLevel >= 1", "Infos on residual values" } ); appendLogLevel( { "logLevel >= 1", "Output well rates to a simple csv file" } ); - appendLogLevel( { "logLevel >= 2", "Display the BHP pressure" } ); - appendLogLevel( { "logLevel >= 2", "Display the surface density" } ); - appendLogLevel( { "logLevel >= 2 and use surface conditions", "Display phase and total density in the reference element" } ); + appendLogLevel( { "logLevel >= 2", "Infos on the BHP pressure" } ); + appendLogLevel( { "logLevel >= 2", "Infos on the surface density" } ); + appendLogLevel( { "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" } ); } void CompositionalMultiphaseWell::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index 5437e5a3712..3c549ab8fd6 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -46,11 +46,11 @@ SinglePhaseWell::SinglePhaseWell( const string & name, Group * const parent ): WellSolverBase( name, parent ) { - appendLogLevel( { "logLevel >= 0", "Display the residual values" } ); + appendLogLevel( { "logLevel >= 1", "Infos on residual values" } ); appendLogLevel( { "logLevel >= 1", "Output well rates to a simple csv file" } ); - appendLogLevel( { "logLevel >= 2", "Display the BHP pressure" } ); - appendLogLevel( { "logLevel >= 2", "Display the surface density" } ); - appendLogLevel( { "logLevel >= 2 and use surface conditions", "Display phase and total density in the reference element" } ); + appendLogLevel( { "logLevel >= 2", "Infos on BHP pressure" } ); + appendLogLevel( { "logLevel >= 2", "Infos on surface density" } ); + appendLogLevel( { "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" } ); m_numDofPerWellElement = 2; m_numDofPerResElement = 1; diff --git a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp index bbf87e97140..5fa66860d9a 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -78,7 +78,7 @@ CompositionalMultiphaseReservoirAndWells( const string & name, { Base::enableLogLevelInput(); - Base::appendLogLevel( { "logLevel >= 1 and if the well is injector and crossflow enabled", "Display warnings about crossflow for injectors" } ); + Base::appendLogLevel( { "logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors" } ); } template< typename COMPOSITIONAL_RESERVOIR_SOLVER > diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index 71bb7845458..d3095da425b 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -109,7 +109,7 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); - Base::appendLogLevel( { "logLevel >= 1", "Display whether or not we Re-entering Newton Solve" } ); + Base::appendLogLevel( { "logLevel >= 1", "Output whether or not we Re-entering Newton Solve" } ); m_numResolves[0] = 0; diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index d6d77b24698..5922d7e4e70 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -42,7 +42,7 @@ SinglePhasePoromechanicsConformingFractures::SinglePhasePoromechanicsConformingF { enableLogLevelInput(); - appendLogLevel( { "logLevel >= 3", "Display the summary of declared fields and coupling" } ); + appendLogLevel( { "logLevel >= 3", "The summary of declared fields and coupling" } ); LinearSolverParameters & params = m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; diff --git a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp index 0d0c36d1f0a..c63efd501ab 100644 --- a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp +++ b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp @@ -81,8 +81,8 @@ PhaseFieldDamageFEM::PhaseFieldDamageFEM( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "The upper bound of the damage" ); - appendLogLevel( { "logLevel >= 2", "Display the jacobian matrix" } ); - appendLogLevel( { "logLevel >= 2", "Display the residuals values" } ); + appendLogLevel( { "logLevel >= 2", "Output the jacobian matrix" } ); + appendLogLevel( { "logLevel >= 2", "Output the residuals values" } ); } PhaseFieldDamageFEM::~PhaseFieldDamageFEM() diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp index 63f91f269af..c768f9e6aca 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp @@ -120,11 +120,8 @@ SolidMechanicsLagrangianFEM::SolidMechanicsLagrangianFEM( const string & name, setInputFlag( InputFlags::FALSE ). setDescription( "The maximum force contribution in the problem domain." ); - getWrapper< integer >( Group::viewKeyStruct::logLevelString() ). - appendDescription( "\n2 :\n" - "Display a warning about boundary conditions\n" - "\n2 :\n" - "Display residuals values" ); + appendLogLevel( { "logLevel >= 2 and target set is empty", "Warning about boundary conditions" } ); + appendLogLevel( { "logLevel >= 2", "Infos on residuals values" } ); } diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index 2d627ad2e26..99f0fa643cd 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -220,10 +220,10 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); - appendLogLevel( { "logLevel >= 1", "Display informations about splitting node/edge/faces" } ); - appendLogLevel( { "logLevel >= 2", "Display informations about all elements attached to the nodeID" } ); - appendLogLevel( { "logLevel >= 2", "Display informations about all faces on their element" } ); - appendLogLevel( { "logLevel >= 3", "Display consistency checking of the maps" } ); + appendLogLevel( { "logLevel >= 1", "Infos about splitting node/edge/faces" } ); + appendLogLevel( { "logLevel >= 2", "Infos about all elements attached to the nodeID" } ); + appendLogLevel( { "logLevel >= 2", "Infos about all faces on their element" } ); + appendLogLevel( { "logLevel >= 3", "Infos on the consistency checking of the maps" } ); } void SurfaceGenerator::postProcessInput() From d3336780088e0438ce2735e9f30b9734a36dcb4d Mon Sep 17 00:00:00 2001 From: arng40 Date: Tue, 21 May 2024 10:32:36 +0200 Subject: [PATCH 05/18] enable log level + small corretion appendLogLevel --- .../multifluid/CO2Brine/CO2BrineFluid.cpp | 2 -- .../fluid/multifluid/PVTDriver.cpp | 2 -- .../reactive/ReactiveBrineFluid.cpp | 2 -- .../reactive/ReactiveFluidDriver.cpp | 2 -- .../relativePermeability/RelpermDriver.cpp | 2 -- .../constitutive/solid/TriaxialDriver.cpp | 2 -- src/coreComponents/dataRepository/Group.cpp | 34 ++++++++----------- src/coreComponents/dataRepository/Group.hpp | 12 ++----- .../dataRepository/WrapperBase.hpp | 9 +++-- src/coreComponents/events/EventBase.cpp | 1 - src/coreComponents/events/EventManager.cpp | 1 - .../fileIO/Outputs/VTKOutput.cpp | 2 -- src/coreComponents/mesh/MeshManager.cpp | 2 +- .../generators/ExternalMeshGeneratorBase.cpp | 2 -- .../mesh/generators/InternalWellGenerator.cpp | 2 -- .../mesh/generators/VTKMeshGenerator.cpp | 2 -- .../mesh/generators/WellGeneratorBase.cpp | 2 +- .../mesh/simpleGeometricObjects/Rectangle.cpp | 2 -- .../NonlinearSolverParameters.cpp | 1 - .../contact/ContactSolverBase.cpp | 2 +- .../fluidFlow/wells/WellControls.cpp | 2 +- .../CoupledReservoirAndWellsBase.hpp | 2 +- .../multiphysics/HydrofractureSolver.cpp | 2 +- ...ePhasePoromechanicsConformingFractures.cpp | 2 +- 24 files changed, 31 insertions(+), 63 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index a273065736f..174500b7a21 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -84,8 +84,6 @@ CO2BrineFluid< PHASE1, PHASE2, FLASH >:: CO2BrineFluid( string const & name, Group * const parent ): MultiFluidBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::phasePVTParaFilesString(), &m_phasePVTParaFiles ). setInputFlag( InputFlags::REQUIRED ). setRestartFlags( RestartFlags::NO_WRITE ). diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index 4f1c47397f5..4a8ffe7adba 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -40,8 +40,6 @@ PVTDriver::PVTDriver( const string & name, Group * const parent ): TaskBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::fluidNameString(), &m_fluidName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 23f868a4771..e7695ec7ad3 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -63,8 +63,6 @@ ReactiveBrineFluid< PHASE > :: ReactiveBrineFluid( string const & name, Group * const parent ): ReactiveMultiFluid( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::phasePVTParaFilesString(), &m_phasePVTParaFiles ). setInputFlag( InputFlags::REQUIRED ). setRestartFlags( RestartFlags::NO_WRITE ). diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index ef045cd8da8..10a15697fbe 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -32,8 +32,6 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, Group * const parent ): TaskBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::fluidNameString(), &m_fluidName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index 8bc0247dda3..e54cbcfdf88 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -32,8 +32,6 @@ RelpermDriver::RelpermDriver( const geos::string & name, : TaskBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::relpermNameString(), &m_relpermName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index 874234209d0..c082c9032e2 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -29,8 +29,6 @@ TriaxialDriver::TriaxialDriver( const string & name, Group * const parent ): TaskBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::solidMaterialNameString(), &m_solidMaterialName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index ab188234c8f..addcbf7b10d 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -79,32 +79,28 @@ void Group::deregisterWrapper( string const & name ) m_conduitNode.remove( name ); } -void Group::appendLogLevel( std::pair< const std::string, const std::string > log ) +void appendLogLevelToWrapper( WrapperBase & wrapper, std::pair< const std::string, const std::string > log ) { - // 1. register le wrapper - - //TODO condition pour enable loglevel w description - //rajouter if wrapper existe pas - - std::string const levelToAppend = "\n" + log.first + "\n"; + std::string const levelToAppend = "\n" + log.first + " :\n"; std::string const descriptionToAppend = log.second; - string wrapperName = viewKeyStruct::logLevelString(); + wrapper.addEntrieLogLevel( levelToAppend, descriptionToAppend ); + wrapper.buildLogLevelDescription(); +} + +void Group::appendLogLevel( std::pair< const std::string, const std::string > log ) +{ + string logLevelName = viewKeyStruct::logLevelString(); try { - WrapperBase & wrapper = getWrapperBase( wrapperName ); - wrapper.addEntrieLogLevel( levelToAppend, descriptionToAppend ); - wrapper.buildDescription(); + WrapperBase & wrapper = getWrapperBase( logLevelName ); + appendLogLevelToWrapper( wrapper, log ); }catch( std::domain_error const & ) { - WrapperBase & wrapper = registerWrapper( wrapperName, &m_logLevel ); - registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ). - setApplyDefaultValue( 1 ). - setInputFlag( InputFlags::OPTIONAL ); - wrapper.addEntrieLogLevel( levelToAppend, descriptionToAppend ); - wrapper.buildDescription(); + WrapperBase & wrapper = registerWrapper( logLevelName, &m_logLevel ); + enableLogLevelInput(); + appendLogLevelToWrapper( wrapper, log ); } - } void Group::resize( indexType const newSize ) @@ -669,10 +665,8 @@ void Group::postRestartInitializationRecursive() postRestartInitialization(); } -//TODO ARN DELETE void Group::enableLogLevelInput() { - // TODO : Improve the Log Level description to clearly assign a usecase per log level (incoming PR). registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ). setApplyDefaultValue( 1 ). setInputFlag( InputFlags::OPTIONAL ); diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index a311b232a94..75a331700a8 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -854,17 +854,11 @@ class Group ///@} //END_SPHINX_INCLUDE_REGISTER_WRAPPER - /** - * @param logs - */ - void appendLogLevel( std::pair< const std::string, const std::string > log ); - /** - * @return The log levels descriptions for a gtoup + * @brief Append a log level/description to the description of the wrapped object + * @param log An entry (log level/ log Description) to append */ - std::string const & getLogLevelDescription(); - - void appendLogLevelDescription( std::string const & description ); + void appendLogLevel( std::pair< const std::string, const std::string > log ); /** * @name Schema generation methods diff --git a/src/coreComponents/dataRepository/WrapperBase.hpp b/src/coreComponents/dataRepository/WrapperBase.hpp index ce7b99225a9..1fd1abb8517 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -519,7 +519,10 @@ class WrapperBase return *this; } - void buildDescription() + /** + * @brief Construct the log level string description for a wrapper + */ + void buildLogLevelDescription() { string descriptionToBuild; descriptionToBuild.append( "Sets the level of information to write in the standard output (the console typically).\n" @@ -557,7 +560,9 @@ class WrapperBase } /** - * @return Add a logLevel/description + * @brief Add an entry to the description map + * @param levelToAppend The log level key + * @param descriptionToAppend The log description value */ void addEntrieLogLevel( std::string levelToAppend, std::string descriptionToAppend ) { diff --git a/src/coreComponents/events/EventBase.cpp b/src/coreComponents/events/EventBase.cpp index 93059a355a4..89512035b95 100644 --- a/src/coreComponents/events/EventBase.cpp +++ b/src/coreComponents/events/EventBase.cpp @@ -52,7 +52,6 @@ EventBase::EventBase( const string & name, { setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); - // This enables logLevel filtering enableLogLevelInput(); registerWrapper( viewKeyStruct::eventTargetString(), &m_eventTarget ). diff --git a/src/coreComponents/events/EventManager.cpp b/src/coreComponents/events/EventManager.cpp index 3ebb6c2af44..4b2b605345f 100644 --- a/src/coreComponents/events/EventManager.cpp +++ b/src/coreComponents/events/EventManager.cpp @@ -44,7 +44,6 @@ EventManager::EventManager( string const & name, { setInputFlags( InputFlags::REQUIRED ); - // This enables logLevel filtering enableLogLevelInput(); registerWrapper( viewKeyStruct::minTimeString(), &m_minTime ). diff --git a/src/coreComponents/fileIO/Outputs/VTKOutput.cpp b/src/coreComponents/fileIO/Outputs/VTKOutput.cpp index b9b6256bc1a..3b54838efcb 100644 --- a/src/coreComponents/fileIO/Outputs/VTKOutput.cpp +++ b/src/coreComponents/fileIO/Outputs/VTKOutput.cpp @@ -39,8 +39,6 @@ VTKOutput::VTKOutput( string const & name, m_levelNames(), m_writer( getOutputDirectory() + '/' + m_plotFileRoot ) { - enableLogLevelInput(); - registerWrapper( viewKeysStruct::plotFileRoot, &m_plotFileRoot ). setDefaultValue( m_plotFileRoot ). setInputFlag( InputFlags::OPTIONAL ). diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index 18be59f08af..edadd32ad80 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -34,7 +34,7 @@ MeshManager::MeshManager( string const & name, Group * const parent ): Group( name, parent ) { - enableLogLevelInput(); + setInputFlags( InputFlags::REQUIRED ); appendLogLevel( { "logLevel >= 1", "Infos about imported field name on region/subRegion" } ); diff --git a/src/coreComponents/mesh/generators/ExternalMeshGeneratorBase.cpp b/src/coreComponents/mesh/generators/ExternalMeshGeneratorBase.cpp index a6d86b02ab5..a3f92bd45d7 100644 --- a/src/coreComponents/mesh/generators/ExternalMeshGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/ExternalMeshGeneratorBase.cpp @@ -23,8 +23,6 @@ ExternalMeshGeneratorBase::ExternalMeshGeneratorBase( string const & name, dataRepository::Group * const parent ) : MeshGeneratorBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::filePathString(), &m_filePath ). setInputFlag( InputFlags::REQUIRED ). setRestartFlags( RestartFlags::NO_WRITE ). diff --git a/src/coreComponents/mesh/generators/InternalWellGenerator.cpp b/src/coreComponents/mesh/generators/InternalWellGenerator.cpp index 5e5d9211a58..d966a82f52c 100644 --- a/src/coreComponents/mesh/generators/InternalWellGenerator.cpp +++ b/src/coreComponents/mesh/generators/InternalWellGenerator.cpp @@ -26,8 +26,6 @@ using namespace dataRepository; InternalWellGenerator::InternalWellGenerator( string const & name, Group * const parent ): WellGeneratorBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::polylineNodeCoordsString(), &m_polyNodeCoords ). setInputFlag( InputFlags::REQUIRED ). setSizedFromParent( 0 ). diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index 35d93ad1fa2..ab7b5a4bd5c 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -34,8 +34,6 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, Group * const parent ) : ExternalMeshGeneratorBase( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::regionAttributeString(), &m_attributeName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::OPTIONAL ). diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index c6ad6fb6bea..fe853f2936c 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -37,7 +37,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent , m_nDims( 3 ) , m_polylineHeadNodeId( -1 ) { - enableLogLevelInput(); + setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 9a5694b6a7f..818345884e5 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -28,8 +28,6 @@ Rectangle::Rectangle( const string & name, Group * const parent ): m_origin{ 0.0, 0.0, 0.0 }, m_tolerance() { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::originString(), &m_origin ). setInputFlag( InputFlags::REQUIRED ). setDescription( "Origin point (x,y,z) of the plane (basically, any point on the plane)" ); diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index fb009cc2f5a..197328e53ed 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -26,7 +26,6 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, { setInputFlags( InputFlags::OPTIONAL ); - // This enables logLevel filtering enableLogLevelInput(); registerWrapper( viewKeysStruct::lineSearchActionString(), &m_lineSearchAction ). diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index 5e687772d7f..1e8316523fd 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -42,7 +42,7 @@ ContactSolverBase::ContactSolverBase( const string & name, Group * const parent ): SolidMechanicsLagrangianFEM( name, parent ) { - enableLogLevelInput(); + this->getWrapper< string >( viewKeyStruct::contactRelationNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index 147f7027661..4972c9679ea 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -48,7 +48,7 @@ WellControls::WellControls( string const & name, Group * const parent ) m_statusTable( nullptr ) { setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); - + enableLogLevelInput(); registerWrapper( viewKeyStruct::typeString(), &m_type ). diff --git a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp index 4c5c4dc1e87..79db210f629 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp @@ -101,7 +101,7 @@ class CoupledReservoirAndWellsBase : public CoupledSolver< RESERVOIR_SOLVER, WEL : Base( name, parent ), m_isWellTransmissibilityComputed( false ) { - // enableLogLevelInput(); + // this->template getWrapper< string >( Base::viewKeyStruct::discretizationString() ). setInputFlag( dataRepository::InputFlags::FALSE ); diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index d3095da425b..3ef5698ef75 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -78,7 +78,7 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & m_isMatrixPoroelastic(), m_newFractureInitializationType() { - Base::enableLogLevelInput(); + Base:: registerWrapper( viewKeyStruct::surfaceGeneratorNameString(), &m_surfaceGeneratorName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index 5922d7e4e70..04a2fdcfdb8 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -40,7 +40,7 @@ SinglePhasePoromechanicsConformingFractures::SinglePhasePoromechanicsConformingF Group * const parent ) : Base( name, parent ) { - enableLogLevelInput(); + appendLogLevel( { "logLevel >= 3", "The summary of declared fields and coupling" } ); From 12da842a4786925c79b62a25a5ffb98c4ca986e8 Mon Sep 17 00:00:00 2001 From: arng40 Date: Tue, 21 May 2024 15:24:13 +0200 Subject: [PATCH 06/18] melvin review ( archi updated ) --- .../multifluid/CO2Brine/CO2BrineFluid.cpp | 2 +- .../fluid/multifluid/PVTDriver.cpp | 4 +-- .../reactive/ReactiveBrineFluid.cpp | 2 +- .../reactive/ReactiveFluidDriver.cpp | 4 +-- .../relativePermeability/RelpermDriver.cpp | 4 +-- .../constitutive/solid/TriaxialDriver.cpp | 4 +-- src/coreComponents/dataRepository/Group.cpp | 23 +++++++--------- src/coreComponents/dataRepository/Group.hpp | 18 ++++++++++--- .../dataRepository/WrapperBase.hpp | 26 ++----------------- src/coreComponents/mesh/MeshManager.cpp | 2 +- .../mesh/generators/VTKMeshGenerator.cpp | 6 ++--- .../mesh/generators/WellGeneratorBase.cpp | 2 +- .../mesh/simpleGeometricObjects/Rectangle.cpp | 2 +- .../NonlinearSolverParameters.cpp | 2 +- .../physicsSolvers/SolverBase.cpp | 14 +++++----- .../contact/ContactSolverBase.cpp | 2 +- .../SolidMechanicsEmbeddedFractures.cpp | 2 +- .../contact/SolidMechanicsLagrangeContact.cpp | 2 +- .../fluidFlow/CompositionalMultiphaseBase.cpp | 4 +-- .../fluidFlow/CompositionalMultiphaseFVM.cpp | 4 +-- .../CompositionalMultiphaseHybridFVM.cpp | 2 +- .../fluidFlow/FlowSolverBase.cpp | 2 +- .../ReactiveCompositionalMultiphaseOBL.cpp | 10 +++---- .../fluidFlow/SinglePhaseBase.cpp | 4 +-- .../fluidFlow/SinglePhaseFVM.cpp | 6 ++--- .../fluidFlow/SinglePhaseHybridFVM.cpp | 4 +-- .../proppantTransport/ProppantTransport.cpp | 2 +- .../wells/CompositionalMultiphaseWell.cpp | 10 +++---- .../fluidFlow/wells/SinglePhaseWell.cpp | 10 +++---- ...mpositionalMultiphaseReservoirAndWells.cpp | 2 +- .../multiphysics/HydrofractureSolver.cpp | 2 +- ...ePhasePoromechanicsConformingFractures.cpp | 2 +- .../simplePDE/PhaseFieldDamageFEM.cpp | 4 +-- .../SolidMechanicsLagrangianFEM.cpp | 4 +-- .../surfaceGeneration/SurfaceGenerator.cpp | 8 +++--- 35 files changed, 92 insertions(+), 109 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index 174500b7a21..c522139fc13 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -111,7 +111,7 @@ CO2BrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevel( { "logLevel >= 1", "Informations on PVT phase table" } ); + appendLogLevelDescription("logLevel >= 1", "Informations on PVT phase table"); } template< typename PHASE1, typename PHASE2, typename FLASH > diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index 4a8ffe7adba..1d6b7d4591d 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -84,8 +84,8 @@ PVTDriver::PVTDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Informations about test" } ); - appendLogLevel( { "logLevel >= 1", "Indicate at the end if the internal results are consistent" } ); + appendLogLevelDescription("logLevel >= 1", "Informations about PVT Driver"); + appendLogLevelDescription("logLevel >= 1", "Indicate at the end if the internal results are consistent"); } void PVTDriver::postProcessInput() diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index e7695ec7ad3..67c47947c97 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -80,7 +80,7 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevel( { "logLevel >= 1", "Infos about phase PVT Table" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about phase PVT Table"); } template< typename PHASE > diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index 10a15697fbe..718cdcb9473 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -65,8 +65,8 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Infos about ReactiveFluidDriver" } ); - appendLogLevel( { "logLevel >= 1", "Indicate at the end if the internal results are consistent" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about ReactiveFluidDriver"); + appendLogLevelDescription("logLevel >= 1", "Indicate at the end if the internal results are consistent"); } diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index e54cbcfdf88..62589b762cb 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -51,8 +51,8 @@ RelpermDriver::RelpermDriver( const geos::string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Infos about RelpermDriver" } ); - appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about RelpermDriver"); + appendLogLevelDescription("logLevel >= 1", "Indicate if the internal results are consistent"); } diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index c082c9032e2..4bf22041880 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -66,8 +66,8 @@ TriaxialDriver::TriaxialDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevel( { "logLevel >= 1", "Infos about TriaxialDriver" } ); - appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about TriaxialDriver"); + appendLogLevelDescription("logLevel >= 1", "Indicate if the internal results are consistent"); } diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index addcbf7b10d..47840e2600e 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -79,28 +79,23 @@ void Group::deregisterWrapper( string const & name ) m_conduitNode.remove( name ); } -void appendLogLevelToWrapper( WrapperBase & wrapper, std::pair< const std::string, const std::string > log ) +void Group::addEntrieLogLevel( std::string const & level, std::string const & description ) { - std::string const levelToAppend = "\n" + log.first + " :\n"; - std::string const descriptionToAppend = log.second; - - wrapper.addEntrieLogLevel( levelToAppend, descriptionToAppend ); - wrapper.buildLogLevelDescription(); + m_logLevelsDescriptions[level].push_back( description ); } -void Group::appendLogLevel( std::pair< const std::string, const std::string > log ) +void Group::appendLogLevelDescription( std::string levelCondition, std::string logDescription ) { string logLevelName = viewKeyStruct::logLevelString(); - try - { - WrapperBase & wrapper = getWrapperBase( logLevelName ); - appendLogLevelToWrapper( wrapper, log ); - }catch( std::domain_error const & ) + levelCondition.insert( 0, "\n" ).append( "\n" ); + if( !hasWrapper( logLevelName ) ) { - WrapperBase & wrapper = registerWrapper( logLevelName, &m_logLevel ); enableLogLevelInput(); - appendLogLevelToWrapper( wrapper, log ); } + + WrapperBase & wrapper = getWrapperBase( logLevelName ); + addEntrieLogLevel( levelCondition, logDescription ); + wrapper.buildLogLevelDescription( m_logLevelsDescriptions ); } void Group::resize( indexType const newSize ) diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index 75a331700a8..1efb4138354 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -855,10 +855,11 @@ class Group //END_SPHINX_INCLUDE_REGISTER_WRAPPER /** - * @brief Append a log level/description to the description of the wrapped object - * @param log An entry (log level/ log Description) to append + * @brief Append a levelCondition and a log description to the description of the wrapped object + * @param levelCondition The level condition to append + * @param logDescription The log description to append */ - void appendLogLevel( std::pair< const std::string, const std::string > log ); + void appendLogLevelDescription( std::string levelCondition, std::string logDescription ); /** * @name Schema generation methods @@ -1488,6 +1489,13 @@ class Group integer getLogLevel() const { return m_logLevel; } ///@} + /** + * @brief Add an entry to the description map + * @param level The log level key + * @param description The log description value + */ + void addEntrieLogLevel( std::string const & level, std::string const & description ); + /** * @brief Performs re-initialization of certain variable depending on the solver being used. */ @@ -1613,7 +1621,9 @@ class Group /// Verbosity flag for group logs integer m_logLevel; - std::string m_logLevelDescription; + /// Map for building the log level string for each wrapper + /// key : logLevel, values : description(s) for a level + std::map< std::string, std::vector< std::string > > m_logLevelsDescriptions; //END_SPHINX_INCLUDE_02 diff --git a/src/coreComponents/dataRepository/WrapperBase.hpp b/src/coreComponents/dataRepository/WrapperBase.hpp index 1fd1abb8517..6a87c55ce0b 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -522,12 +522,12 @@ class WrapperBase /** * @brief Construct the log level string description for a wrapper */ - void buildLogLevelDescription() + void buildLogLevelDescription( std::map< std::string, std::vector< std::string > > & logLevelsDescriptions ) { string descriptionToBuild; descriptionToBuild.append( "Sets the level of information to write in the standard output (the console typically).\n" "A level of 0 outputs minimal information, higher levels require more." ); - for( auto const & [logLevel, logDescriptions] : m_logLevelsDescriptions ) + for( auto const & [logLevel, logDescriptions] : logLevelsDescriptions ) { descriptionToBuild.append( logLevel ); size_t idxDescription = 0; @@ -551,24 +551,6 @@ class WrapperBase return m_description; } - /** - * @return The map of logs levels description - */ - std::map< std::string, std::vector< std::string > > const & getlogLevelsDescriptions() - { - return m_logLevelsDescriptions; - } - - /** - * @brief Add an entry to the description map - * @param levelToAppend The log level key - * @param descriptionToAppend The log description value - */ - void addEntrieLogLevel( std::string levelToAppend, std::string descriptionToAppend ) - { - m_logLevelsDescriptions[levelToAppend].push_back( descriptionToAppend ); - } - /** * @brief @return a table formatted string containing the input options. * @param outputHeader If true outputs the table header, otherwise just @@ -747,10 +729,6 @@ class WrapperBase /// A string description of the wrapped object string m_description; - /// Map for building the log level string for each wrapper - /// key : logLevel, values : description(s) for a level - std::map< std::string, std::vector< std::string > > m_logLevelsDescriptions; - /// A string regex to validate the input values string to parse for the wrapped object string m_rtTypeName; diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index edadd32ad80..6aa1bc85477 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -37,7 +37,7 @@ MeshManager::MeshManager( string const & name, setInputFlags( InputFlags::REQUIRED ); - appendLogLevel( { "logLevel >= 1", "Infos about imported field name on region/subRegion" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about imported field name on region/subRegion"); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index ab7b5a4bd5c..03622be1b48 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -75,9 +75,9 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, " If set to a negative value, the GlobalId arrays in the input mesh are not used, and generated global Ids are automatically generated." " If set to a positive value, the GlobalId arrays in the input mesh are used and required, and the simulation aborts if they are not available" ); - appendLogLevel( { "logLevel >= 1", "Infos about cell block names" } ); - appendLogLevel( { "logLevel >= 2", "Infos about node sets names" } ); - appendLogLevel( { "logLevel >= 5", "Infos about redistribution" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about cell block names"); + appendLogLevelDescription("logLevel >= 2", "Infos about node sets names"); + appendLogLevelDescription("logLevel >= 5", "Infos about redistribution"); } void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index fe853f2936c..52cfdbc26ad 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -73,7 +73,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); - appendLogLevel( { "logLevel >= 1", "Infos about Internal wells and their perforations" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about Internal wells and their perforations"); } Group * WellGeneratorBase::createChild( string const & childKey, string const & childName ) diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 818345884e5..12961e60e5b 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -42,7 +42,7 @@ Rectangle::Rectangle( const string & name, Group * const parent ): setDescription( "Tolerance to determine if a point sits on the plane or not. " "It is relative to the maximum dimension of the plane." ); - appendLogLevel( { "logLevel >= 2", "Infos about length and width of the bounded plane" } ); + appendLogLevelDescription("logLevel >= 2", "Infos about length and width of the bounded plane"); m_points.resize( 4, 3 ); } diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index 197328e53ed..3ade07ff79c 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -164,7 +164,7 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); - appendLogLevel( { "logLevel >= 1", "Infos about NonLinearSolver parameters" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about NonLinearSolver parameters"); } diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index 8e0d8b5aa43..7b5870093ec 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -89,13 +89,13 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Initial time-step value required by the solver to the event manager." ); - appendLogLevel( { "logLevel >= 1", "Infos on line search" } ); - appendLogLevel( { "logLevel >= 1", "Infos global solution scaling factor" } ); - appendLogLevel( { "logLevel >= 1", "Output about the timestep" } ); - appendLogLevel( { "logLevel >= 2", "Output to screen the assembled linear system (matrices and vectors)" } ); - appendLogLevel( { "logLevel >= 2", "Output to screen the assembled linear solutions (matrices and vectors)" } ); - appendLogLevel( { "logLevel >= 3", "Output to file the assembled linear system (matrices and vectors)" } ); - appendLogLevel( { "logLevel >= 3", "Output to file the assembled linear solutions (matrices and vectors)" } ); + appendLogLevelDescription("logLevel >= 1", "Infos on line search"); + appendLogLevelDescription("logLevel >= 1", "Infos on global solution scaling factor"); + appendLogLevelDescription("logLevel >= 1", "Output about the timestep"); + appendLogLevelDescription("logLevel >= 2", "Output to screen the assembled linear system (matrices and vectors)"); + appendLogLevelDescription("logLevel >= 2", "Output to screen the assembled linear solutions (matrices and vectors)"); + appendLogLevelDescription("logLevel >= 3", "Output to file the assembled linear system (matrices and vectors)"); + appendLogLevelDescription("logLevel >= 3", "Output to file the assembled linear solutions (matrices and vectors)"); registerGroup( groupKeyStruct::linearSolverParametersString(), &m_linearSolverParameters ); registerGroup( groupKeyStruct::nonlinearSolverParametersString(), &m_nonlinearSolverParameters ); diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index 1e8316523fd..db6b4affbe6 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -50,7 +50,7 @@ ContactSolverBase::ContactSolverBase( const string & name, this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); - appendLogLevel( { "logLevel >= 1", "Infos about number of elements for each fracture states" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about number of elements for each fracture states"); } void ContactSolverBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp index b511cd15a75..6a82c198371 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp @@ -51,7 +51,7 @@ SolidMechanicsEmbeddedFractures::SolidMechanicsEmbeddedFractures( const string & setApplyDefaultValue( 0 ). setDescription( "Defines whether to use static condensation or not." ); - appendLogLevel( { "logLevel >= 1", "Infos on residual norm for each fractures" } ); + appendLogLevelDescription("logLevel >= 1", "Infos on residual norm for each fractures"); } SolidMechanicsEmbeddedFractures::~SolidMechanicsEmbeddedFractures() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp index 4d01ff4e31c..cca7ab7929d 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp @@ -64,7 +64,7 @@ SolidMechanicsLagrangeContact::SolidMechanicsLagrangeContact( const string & nam setInputFlag( InputFlags::REQUIRED ). setDescription( "Name of the stabilization to use in the lagrangian contact solver" ); - appendLogLevel( { "logLevel >= 1", "Infos on risidual norm (Rdisplacement, Rtraction, Rtotal)" } ); + appendLogLevelDescription("logLevel >= 1", "Infos on risidual norm (Rdisplacement, Rtraction, Rtotal)"); LinearSolverParameters & linSolParams = m_linearSolverParameters.get(); linSolParams.mgr.strategy = LinearSolverParameters::MGR::StrategyType::lagrangianContactMechanics; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index 1c9ec0966bf..bfb61bb3fe4 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -152,8 +152,8 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setApplyDefaultValue( 1.0 ). setDescription( "Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevel( { "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); - appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about boundary conditions" } ); + appendLogLevelDescription("logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects"); + appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about boundary conditions"); } void CompositionalMultiphaseBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index f9924e4d76e..df401ed0b82 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -87,8 +87,8 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); - appendLogLevel( { "logLevel >= 1", "Informations on the residual values" } ); - appendLogLevel( { "logLevel >= 1 and non first nonlinear iteration", "Infos about the face boundary conditions log" } ); + appendLogLevelDescription("logLevel >= 1", "Informations on the residual values"); + appendLogLevelDescription("logLevel >= 1 and non first nonlinear iteration", "Infos about the face boundary conditions log"); } void CompositionalMultiphaseFVM::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp index 89780cb4a34..b9a59f2ec89 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,7 +49,7 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { - appendLogLevel( { "logLevel >= 1", "Infos on the residual values" } ); + appendLogLevelDescription("logLevel >= 1", "Infos on the residual values"); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::compositionalMultiphaseHybridFVM; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp index 506a10bdb4a..cc939382b37 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -119,7 +119,7 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevel( { "logLevel >= 1", "Infos about the boundary conditions" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about the boundary conditions"); // allow the user to select a norm getNonlinearSolverParameters().getWrapper< solverBaseKernels::NormType >( NonlinearSolverParameters::viewKeysStruct::normTypeString() ).setInputFlag( InputFlags::OPTIONAL ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index c697f96cb7e..1ee6b7da251 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -115,11 +115,11 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); - appendLogLevel( { "logLevel >= 1", "Informations on the residuals values" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the boundary conditions" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet pressure boundary conditions" } ); - appendLogLevel( { "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet temperature boundary conditions" } ); + appendLogLevelDescription("logLevel >= 1", "Informations on the residuals values"); + appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions"); + appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the boundary conditions"); + appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet pressure boundary conditions"); + appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet temperature boundary conditions"); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp index e02af17a135..f15017a2ed2 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -59,8 +59,8 @@ SinglePhaseBase::SinglePhaseBase( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Temperature" ); - appendLogLevel( { "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" } ); - appendLogLevel( { "logLevel >= 1", "Infos about boundary conditions" } ); + appendLogLevelDescription("logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects"); + appendLogLevelDescription("logLevel >= 1", "Infos about boundary conditions"); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 4ed85cd2d0a..4fb3873f252 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -61,9 +61,9 @@ SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, { SinglePhaseBase::enableLogLevelInput(); - SinglePhaseBase::appendLogLevel( { "logLevel >= 1", "Infos on the residual values" } ); - SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with pressure" } ); - SinglePhaseBase::appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with temperature" } ); + SinglePhaseBase::appendLogLevelDescription("logLevel >= 1", "Infos on the residual values"); + SinglePhaseBase::appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with pressure"); + SinglePhaseBase::appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with temperature"); } template< typename BASE > diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index c8bb105f645..a223d723177 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -47,8 +47,8 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, m_areaRelTol( 1e-8 ) { - appendLogLevel( { "logLevel >= 1", "Infos about the residual values" } ); - appendLogLevel( { "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary conditions definied with pressure" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about the residual values"); + appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary conditions definied with pressure"); // one cell-centered dof per cell m_numDofPerCell = 1; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp index 5aef8d73a4a..b282b21033d 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp @@ -78,7 +78,7 @@ ProppantTransport::ProppantTransport( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag that enables/disables proppant-packing update" ); - appendLogLevel( { "logLevel >= 1", "Infos on residual norm values" } ); + appendLogLevelDescription("logLevel >= 1", "Infos on residual norm values"); } void ProppantTransport::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 9c495e968a3..631554cb340 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -102,11 +102,11 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setApplyDefaultValue( 1 ). setDescription( "Flag indicating whether local (cell-wise) chopping of negative compositions is allowed" ); - appendLogLevel( { "logLevel >= 1", "Infos on residual values" } ); - appendLogLevel( { "logLevel >= 1", "Output well rates to a simple csv file" } ); - appendLogLevel( { "logLevel >= 2", "Infos on the BHP pressure" } ); - appendLogLevel( { "logLevel >= 2", "Infos on the surface density" } ); - appendLogLevel( { "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" } ); + appendLogLevelDescription("logLevel >= 1", "Infos on residual values"); + appendLogLevelDescription("logLevel >= 1", "Output well rates to a simple csv file"); + appendLogLevelDescription("logLevel >= 2", "Infos on the BHP pressure"); + appendLogLevelDescription("logLevel >= 2", "Infos on the surface density"); + appendLogLevelDescription("logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element"); } void CompositionalMultiphaseWell::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index 3c549ab8fd6..452ab1aafde 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -46,11 +46,11 @@ SinglePhaseWell::SinglePhaseWell( const string & name, Group * const parent ): WellSolverBase( name, parent ) { - appendLogLevel( { "logLevel >= 1", "Infos on residual values" } ); - appendLogLevel( { "logLevel >= 1", "Output well rates to a simple csv file" } ); - appendLogLevel( { "logLevel >= 2", "Infos on BHP pressure" } ); - appendLogLevel( { "logLevel >= 2", "Infos on surface density" } ); - appendLogLevel( { "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" } ); + appendLogLevelDescription("logLevel >= 1", "Infos on residual values"); + appendLogLevelDescription("logLevel >= 1", "Output well rates to a simple csv file"); + appendLogLevelDescription("logLevel >= 2", "Infos on BHP pressure"); + appendLogLevelDescription("logLevel >= 2", "Infos on surface density"); + appendLogLevelDescription("logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element"); m_numDofPerWellElement = 2; m_numDofPerResElement = 1; diff --git a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp index 5fa66860d9a..c7abe138010 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -78,7 +78,7 @@ CompositionalMultiphaseReservoirAndWells( const string & name, { Base::enableLogLevelInput(); - Base::appendLogLevel( { "logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors" } ); + Base::appendLogLevelDescription("logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors"); } template< typename COMPOSITIONAL_RESERVOIR_SOLVER > diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index 3ef5698ef75..c4b265b2cc7 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -109,7 +109,7 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); - Base::appendLogLevel( { "logLevel >= 1", "Output whether or not we Re-entering Newton Solve" } ); + Base::appendLogLevelDescription("logLevel >= 1", "Output whether or not we Re-entering Newton Solve"); m_numResolves[0] = 0; diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index 04a2fdcfdb8..69425f695d2 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -42,7 +42,7 @@ SinglePhasePoromechanicsConformingFractures::SinglePhasePoromechanicsConformingF { - appendLogLevel( { "logLevel >= 3", "The summary of declared fields and coupling" } ); + appendLogLevelDescription("logLevel >= 3", "The summary of declared fields and coupling"); LinearSolverParameters & params = m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; diff --git a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp index c63efd501ab..f02b5a12545 100644 --- a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp +++ b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp @@ -81,8 +81,8 @@ PhaseFieldDamageFEM::PhaseFieldDamageFEM( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "The upper bound of the damage" ); - appendLogLevel( { "logLevel >= 2", "Output the jacobian matrix" } ); - appendLogLevel( { "logLevel >= 2", "Output the residuals values" } ); + appendLogLevelDescription("logLevel >= 2", "Output the jacobian matrix"); + appendLogLevelDescription("logLevel >= 2", "Output the residuals values"); } PhaseFieldDamageFEM::~PhaseFieldDamageFEM() diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp index c768f9e6aca..10650cfc264 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp @@ -120,8 +120,8 @@ SolidMechanicsLagrangianFEM::SolidMechanicsLagrangianFEM( const string & name, setInputFlag( InputFlags::FALSE ). setDescription( "The maximum force contribution in the problem domain." ); - appendLogLevel( { "logLevel >= 2 and target set is empty", "Warning about boundary conditions" } ); - appendLogLevel( { "logLevel >= 2", "Infos on residuals values" } ); + appendLogLevelDescription("logLevel >= 2 and target set is empty", "Warning about boundary conditions"); + appendLogLevelDescription("logLevel >= 2", "Infos on residuals values"); } diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index 99f0fa643cd..a20ccb6b539 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -220,10 +220,10 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); - appendLogLevel( { "logLevel >= 1", "Infos about splitting node/edge/faces" } ); - appendLogLevel( { "logLevel >= 2", "Infos about all elements attached to the nodeID" } ); - appendLogLevel( { "logLevel >= 2", "Infos about all faces on their element" } ); - appendLogLevel( { "logLevel >= 3", "Infos on the consistency checking of the maps" } ); + appendLogLevelDescription("logLevel >= 1", "Infos about splitting node/edge/faces"); + appendLogLevelDescription("logLevel >= 2", "Infos about all elements attached to the nodeID"); + appendLogLevelDescription("logLevel >= 2", "Infos about all faces on their element"); + appendLogLevelDescription("logLevel >= 3", "Infos on the consistency checking of the maps"); } void SurfaceGenerator::postProcessInput() From 65d8ae9958c1dc27b988451d91c0d34905e45726 Mon Sep 17 00:00:00 2001 From: arng40 Date: Tue, 21 May 2024 17:18:24 +0200 Subject: [PATCH 07/18] renaming / constness / refacto --- src/coreComponents/dataRepository/Group.cpp | 21 +++++++++---------- src/coreComponents/dataRepository/Group.hpp | 4 ++-- .../dataRepository/WrapperBase.hpp | 6 +++--- 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index 47840e2600e..8b9f02037e7 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -79,23 +79,22 @@ void Group::deregisterWrapper( string const & name ) m_conduitNode.remove( name ); } -void Group::addEntrieLogLevel( std::string const & level, std::string const & description ) +void Group::addLogLevelEntry( string_view level, string_view description ) { - m_logLevelsDescriptions[level].push_back( description ); + m_logLevelsDescriptions[string(level)].push_back( string(description) ); } -void Group::appendLogLevelDescription( std::string levelCondition, std::string logDescription ) +void Group::appendLogLevelDescription( string_view levelCondition, string_view logDescription ) { - string logLevelName = viewKeyStruct::logLevelString(); - levelCondition.insert( 0, "\n" ).append( "\n" ); - if( !hasWrapper( logLevelName ) ) + Wrapper< integer > * wrapper = getWrapperPointer< integer >( viewKeyStruct::logLevelString() ); + if( wrapper == nullptr ) { - enableLogLevelInput(); + wrapper = ®isterWrapper( viewKeyStruct::logLevelString(), &m_logLevel ); + wrapper->setApplyDefaultValue( 0 ); + wrapper->setInputFlag( InputFlags::OPTIONAL ); } - - WrapperBase & wrapper = getWrapperBase( logLevelName ); - addEntrieLogLevel( levelCondition, logDescription ); - wrapper.buildLogLevelDescription( m_logLevelsDescriptions ); + addLogLevelEntry( levelCondition, logDescription ); + wrapper->buildLogLevelDescription( m_logLevelsDescriptions ); } void Group::resize( indexType const newSize ) diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index 1efb4138354..8b40dcd8aa7 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -859,7 +859,7 @@ class Group * @param levelCondition The level condition to append * @param logDescription The log description to append */ - void appendLogLevelDescription( std::string levelCondition, std::string logDescription ); + void appendLogLevelDescription( string_view levelCondition, string_view logDescription ); /** * @name Schema generation methods @@ -1494,7 +1494,7 @@ class Group * @param level The log level key * @param description The log description value */ - void addEntrieLogLevel( std::string const & level, std::string const & description ); + void addLogLevelEntry( string_view level, string_view description ); /** * @brief Performs re-initialization of certain variable depending on the solver being used. diff --git a/src/coreComponents/dataRepository/WrapperBase.hpp b/src/coreComponents/dataRepository/WrapperBase.hpp index 6a87c55ce0b..45ad05876cb 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -522,19 +522,19 @@ class WrapperBase /** * @brief Construct the log level string description for a wrapper */ - void buildLogLevelDescription( std::map< std::string, std::vector< std::string > > & logLevelsDescriptions ) + void buildLogLevelDescription( std::map< std::string, std::vector< std::string > > const & logLevelsDescriptions ) { string descriptionToBuild; descriptionToBuild.append( "Sets the level of information to write in the standard output (the console typically).\n" "A level of 0 outputs minimal information, higher levels require more." ); for( auto const & [logLevel, logDescriptions] : logLevelsDescriptions ) { - descriptionToBuild.append( logLevel ); + descriptionToBuild.append( GEOS_FMT( "\n{}\n", logLevel ) ); size_t idxDescription = 0; for( const auto & description : logDescriptions ) { idxDescription == logDescriptions.size() - 1 ? descriptionToBuild.append( " - " + description ) : - descriptionToBuild.append( " - " + description + "\n" ); + descriptionToBuild.append( GEOS_FMT( " - {}\n", description ) ); idxDescription++; } } From f957ceaded3837b098a3c2c09ad5b53984936088 Mon Sep 17 00:00:00 2001 From: arng40 Date: Tue, 21 May 2024 17:21:35 +0200 Subject: [PATCH 08/18] uncrustify --- .../fluid/multifluid/CO2Brine/CO2BrineFluid.cpp | 2 +- .../constitutive/fluid/multifluid/PVTDriver.cpp | 4 ++-- .../multifluid/reactive/ReactiveBrineFluid.cpp | 2 +- .../multifluid/reactive/ReactiveFluidDriver.cpp | 6 +++--- .../relativePermeability/RelpermDriver.cpp | 4 ++-- .../constitutive/solid/TriaxialDriver.cpp | 6 +++--- src/coreComponents/dataRepository/Group.cpp | 2 +- src/coreComponents/mesh/MeshManager.cpp | 4 ++-- .../mesh/generators/VTKMeshGenerator.cpp | 6 +++--- .../mesh/generators/WellGeneratorBase.cpp | 4 ++-- .../mesh/simpleGeometricObjects/Rectangle.cpp | 2 +- .../physicsSolvers/NonlinearSolverParameters.cpp | 2 +- src/coreComponents/physicsSolvers/SolverBase.cpp | 14 +++++++------- .../physicsSolvers/contact/ContactSolverBase.cpp | 4 ++-- .../contact/SolidMechanicsEmbeddedFractures.cpp | 2 +- .../contact/SolidMechanicsLagrangeContact.cpp | 2 +- .../fluidFlow/CompositionalMultiphaseBase.cpp | 4 ++-- .../fluidFlow/CompositionalMultiphaseFVM.cpp | 4 ++-- .../fluidFlow/CompositionalMultiphaseHybridFVM.cpp | 2 +- .../physicsSolvers/fluidFlow/FlowSolverBase.cpp | 2 +- .../ReactiveCompositionalMultiphaseOBL.cpp | 10 +++++----- .../physicsSolvers/fluidFlow/SinglePhaseBase.cpp | 4 ++-- .../physicsSolvers/fluidFlow/SinglePhaseFVM.cpp | 6 +++--- .../fluidFlow/SinglePhaseHybridFVM.cpp | 4 ++-- .../proppantTransport/ProppantTransport.cpp | 2 +- .../wells/CompositionalMultiphaseWell.cpp | 10 +++++----- .../fluidFlow/wells/SinglePhaseWell.cpp | 10 +++++----- .../CompositionalMultiphaseReservoirAndWells.cpp | 2 +- .../multiphysics/HydrofractureSolver.cpp | 4 ++-- ...SinglePhasePoromechanicsConformingFractures.cpp | 4 ++-- .../simplePDE/PhaseFieldDamageFEM.cpp | 4 ++-- .../solidMechanics/SolidMechanicsLagrangianFEM.cpp | 4 ++-- .../surfaceGeneration/SurfaceGenerator.cpp | 8 ++++---- 33 files changed, 75 insertions(+), 75 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index c522139fc13..46977b016cc 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -111,7 +111,7 @@ CO2BrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevelDescription("logLevel >= 1", "Informations on PVT phase table"); + appendLogLevelDescription( "logLevel >= 1", "Informations on PVT phase table" ); } template< typename PHASE1, typename PHASE2, typename FLASH > diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index 1d6b7d4591d..3132008e377 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -84,8 +84,8 @@ PVTDriver::PVTDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription("logLevel >= 1", "Informations about PVT Driver"); - appendLogLevelDescription("logLevel >= 1", "Indicate at the end if the internal results are consistent"); + appendLogLevelDescription( "logLevel >= 1", "Informations about PVT Driver" ); + appendLogLevelDescription( "logLevel >= 1", "Indicate at the end if the internal results are consistent" ); } void PVTDriver::postProcessInput() diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 67c47947c97..33cef792d08 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -80,7 +80,7 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevelDescription("logLevel >= 1", "Infos about phase PVT Table"); + appendLogLevelDescription( "logLevel >= 1", "Infos about phase PVT Table" ); } template< typename PHASE > diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index 718cdcb9473..e6334e481e5 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -64,9 +64,9 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - - appendLogLevelDescription("logLevel >= 1", "Infos about ReactiveFluidDriver"); - appendLogLevelDescription("logLevel >= 1", "Indicate at the end if the internal results are consistent"); + + appendLogLevelDescription( "logLevel >= 1", "Infos about ReactiveFluidDriver" ); + appendLogLevelDescription( "logLevel >= 1", "Indicate at the end if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index 62589b762cb..f2db0ab3324 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -51,8 +51,8 @@ RelpermDriver::RelpermDriver( const geos::string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription("logLevel >= 1", "Infos about RelpermDriver"); - appendLogLevelDescription("logLevel >= 1", "Indicate if the internal results are consistent"); + appendLogLevelDescription( "logLevel >= 1", "Infos about RelpermDriver" ); + appendLogLevelDescription( "logLevel >= 1", "Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index 4bf22041880..7cc46e74091 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -65,9 +65,9 @@ TriaxialDriver::TriaxialDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - - appendLogLevelDescription("logLevel >= 1", "Infos about TriaxialDriver"); - appendLogLevelDescription("logLevel >= 1", "Indicate if the internal results are consistent"); + + appendLogLevelDescription( "logLevel >= 1", "Infos about TriaxialDriver" ); + appendLogLevelDescription( "logLevel >= 1", "Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index 8b9f02037e7..eebb1408ea6 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -81,7 +81,7 @@ void Group::deregisterWrapper( string const & name ) void Group::addLogLevelEntry( string_view level, string_view description ) { - m_logLevelsDescriptions[string(level)].push_back( string(description) ); + m_logLevelsDescriptions[string( level )].push_back( string( description ) ); } void Group::appendLogLevelDescription( string_view levelCondition, string_view logDescription ) diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index 6aa1bc85477..1389bc02148 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -34,10 +34,10 @@ MeshManager::MeshManager( string const & name, Group * const parent ): Group( name, parent ) { - + setInputFlags( InputFlags::REQUIRED ); - appendLogLevelDescription("logLevel >= 1", "Infos about imported field name on region/subRegion"); + appendLogLevelDescription( "logLevel >= 1", "Infos about imported field name on region/subRegion" ); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index 03622be1b48..3b8ff1662d1 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -75,9 +75,9 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, " If set to a negative value, the GlobalId arrays in the input mesh are not used, and generated global Ids are automatically generated." " If set to a positive value, the GlobalId arrays in the input mesh are used and required, and the simulation aborts if they are not available" ); - appendLogLevelDescription("logLevel >= 1", "Infos about cell block names"); - appendLogLevelDescription("logLevel >= 2", "Infos about node sets names"); - appendLogLevelDescription("logLevel >= 5", "Infos about redistribution"); + appendLogLevelDescription( "logLevel >= 1", "Infos about cell block names" ); + appendLogLevelDescription( "logLevel >= 2", "Infos about node sets names" ); + appendLogLevelDescription( "logLevel >= 5", "Infos about redistribution" ); } void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index 52cfdbc26ad..5cf6e07e32f 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -37,7 +37,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent , m_nDims( 3 ) , m_polylineHeadNodeId( -1 ) { - + setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); @@ -73,7 +73,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); - appendLogLevelDescription("logLevel >= 1", "Infos about Internal wells and their perforations"); + appendLogLevelDescription( "logLevel >= 1", "Infos about Internal wells and their perforations" ); } Group * WellGeneratorBase::createChild( string const & childKey, string const & childName ) diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 12961e60e5b..898d99513cb 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -42,7 +42,7 @@ Rectangle::Rectangle( const string & name, Group * const parent ): setDescription( "Tolerance to determine if a point sits on the plane or not. " "It is relative to the maximum dimension of the plane." ); - appendLogLevelDescription("logLevel >= 2", "Infos about length and width of the bounded plane"); + appendLogLevelDescription( "logLevel >= 2", "Infos about length and width of the bounded plane" ); m_points.resize( 4, 3 ); } diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index 3ade07ff79c..d40d62fdb58 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -164,7 +164,7 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); - appendLogLevelDescription("logLevel >= 1", "Infos about NonLinearSolver parameters"); + appendLogLevelDescription( "logLevel >= 1", "Infos about NonLinearSolver parameters" ); } diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index 7b5870093ec..fa75b1211ec 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -89,13 +89,13 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Initial time-step value required by the solver to the event manager." ); - appendLogLevelDescription("logLevel >= 1", "Infos on line search"); - appendLogLevelDescription("logLevel >= 1", "Infos on global solution scaling factor"); - appendLogLevelDescription("logLevel >= 1", "Output about the timestep"); - appendLogLevelDescription("logLevel >= 2", "Output to screen the assembled linear system (matrices and vectors)"); - appendLogLevelDescription("logLevel >= 2", "Output to screen the assembled linear solutions (matrices and vectors)"); - appendLogLevelDescription("logLevel >= 3", "Output to file the assembled linear system (matrices and vectors)"); - appendLogLevelDescription("logLevel >= 3", "Output to file the assembled linear solutions (matrices and vectors)"); + appendLogLevelDescription( "logLevel >= 1", "Infos on line search" ); + appendLogLevelDescription( "logLevel >= 1", "Infos on global solution scaling factor" ); + appendLogLevelDescription( "logLevel >= 1", "Output about the timestep" ); + appendLogLevelDescription( "logLevel >= 2", "Output to screen the assembled linear system (matrices and vectors)" ); + appendLogLevelDescription( "logLevel >= 2", "Output to screen the assembled linear solutions (matrices and vectors)" ); + appendLogLevelDescription( "logLevel >= 3", "Output to file the assembled linear system (matrices and vectors)" ); + appendLogLevelDescription( "logLevel >= 3", "Output to file the assembled linear solutions (matrices and vectors)" ); registerGroup( groupKeyStruct::linearSolverParametersString(), &m_linearSolverParameters ); registerGroup( groupKeyStruct::nonlinearSolverParametersString(), &m_nonlinearSolverParameters ); diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index db6b4affbe6..055df2fd268 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -42,7 +42,7 @@ ContactSolverBase::ContactSolverBase( const string & name, Group * const parent ): SolidMechanicsLagrangianFEM( name, parent ) { - + this->getWrapper< string >( viewKeyStruct::contactRelationNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); @@ -50,7 +50,7 @@ ContactSolverBase::ContactSolverBase( const string & name, this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); - appendLogLevelDescription("logLevel >= 1", "Infos about number of elements for each fracture states"); + appendLogLevelDescription( "logLevel >= 1", "Infos about number of elements for each fracture states" ); } void ContactSolverBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp index 6a82c198371..2bc72ccce3e 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp @@ -51,7 +51,7 @@ SolidMechanicsEmbeddedFractures::SolidMechanicsEmbeddedFractures( const string & setApplyDefaultValue( 0 ). setDescription( "Defines whether to use static condensation or not." ); - appendLogLevelDescription("logLevel >= 1", "Infos on residual norm for each fractures"); + appendLogLevelDescription( "logLevel >= 1", "Infos on residual norm for each fractures" ); } SolidMechanicsEmbeddedFractures::~SolidMechanicsEmbeddedFractures() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp index cca7ab7929d..64b6e9d9b7b 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp @@ -64,7 +64,7 @@ SolidMechanicsLagrangeContact::SolidMechanicsLagrangeContact( const string & nam setInputFlag( InputFlags::REQUIRED ). setDescription( "Name of the stabilization to use in the lagrangian contact solver" ); - appendLogLevelDescription("logLevel >= 1", "Infos on risidual norm (Rdisplacement, Rtraction, Rtotal)"); + appendLogLevelDescription( "logLevel >= 1", "Infos on risidual norm (Rdisplacement, Rtraction, Rtotal)" ); LinearSolverParameters & linSolParams = m_linearSolverParameters.get(); linSolParams.mgr.strategy = LinearSolverParameters::MGR::StrategyType::lagrangianContactMechanics; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index bfb61bb3fe4..09fc7e7feb2 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -152,8 +152,8 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setApplyDefaultValue( 1.0 ). setDescription( "Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevelDescription("logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects"); - appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about boundary conditions"); + appendLogLevelDescription( "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); + appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about boundary conditions" ); } void CompositionalMultiphaseBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index df401ed0b82..523e24aa558 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -87,8 +87,8 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); - appendLogLevelDescription("logLevel >= 1", "Informations on the residual values"); - appendLogLevelDescription("logLevel >= 1 and non first nonlinear iteration", "Infos about the face boundary conditions log"); + appendLogLevelDescription( "logLevel >= 1", "Informations on the residual values" ); + appendLogLevelDescription( "logLevel >= 1 and non first nonlinear iteration", "Infos about the face boundary conditions log" ); } void CompositionalMultiphaseFVM::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp index b9a59f2ec89..be31088277f 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,7 +49,7 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { - appendLogLevelDescription("logLevel >= 1", "Infos on the residual values"); + appendLogLevelDescription( "logLevel >= 1", "Infos on the residual values" ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::compositionalMultiphaseHybridFVM; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp index cc939382b37..753d3e3a8ef 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -119,7 +119,7 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevelDescription("logLevel >= 1", "Infos about the boundary conditions"); + appendLogLevelDescription( "logLevel >= 1", "Infos about the boundary conditions" ); // allow the user to select a norm getNonlinearSolverParameters().getWrapper< solverBaseKernels::NormType >( NonlinearSolverParameters::viewKeysStruct::normTypeString() ).setInputFlag( InputFlags::OPTIONAL ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index 1ee6b7da251..ace91cebbf2 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -115,11 +115,11 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); - appendLogLevelDescription("logLevel >= 1", "Informations on the residuals values"); - appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions"); - appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the boundary conditions"); - appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet pressure boundary conditions"); - appendLogLevelDescription("logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet temperature boundary conditions"); + appendLogLevelDescription( "logLevel >= 1", "Informations on the residuals values" ); + appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet pressure boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet temperature boundary conditions" ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp index f15017a2ed2..6ffa7e5d413 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -59,8 +59,8 @@ SinglePhaseBase::SinglePhaseBase( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Temperature" ); - appendLogLevelDescription("logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects"); - appendLogLevelDescription("logLevel >= 1", "Infos about boundary conditions"); + appendLogLevelDescription( "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); + appendLogLevelDescription( "logLevel >= 1", "Infos about boundary conditions" ); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 4fb3873f252..8695e830307 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -61,9 +61,9 @@ SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, { SinglePhaseBase::enableLogLevelInput(); - SinglePhaseBase::appendLogLevelDescription("logLevel >= 1", "Infos on the residual values"); - SinglePhaseBase::appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with pressure"); - SinglePhaseBase::appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with temperature"); + SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1", "Infos on the residual values" ); + SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with pressure" ); + SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with temperature" ); } template< typename BASE > diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index a223d723177..91a86e6fdd3 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -47,8 +47,8 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, m_areaRelTol( 1e-8 ) { - appendLogLevelDescription("logLevel >= 1", "Infos about the residual values"); - appendLogLevelDescription("logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary conditions definied with pressure"); + appendLogLevelDescription( "logLevel >= 1", "Infos about the residual values" ); + appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary conditions definied with pressure" ); // one cell-centered dof per cell m_numDofPerCell = 1; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp index b282b21033d..a48ef2c1091 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp @@ -78,7 +78,7 @@ ProppantTransport::ProppantTransport( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag that enables/disables proppant-packing update" ); - appendLogLevelDescription("logLevel >= 1", "Infos on residual norm values"); + appendLogLevelDescription( "logLevel >= 1", "Infos on residual norm values" ); } void ProppantTransport::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 631554cb340..e6666252354 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -102,11 +102,11 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setApplyDefaultValue( 1 ). setDescription( "Flag indicating whether local (cell-wise) chopping of negative compositions is allowed" ); - appendLogLevelDescription("logLevel >= 1", "Infos on residual values"); - appendLogLevelDescription("logLevel >= 1", "Output well rates to a simple csv file"); - appendLogLevelDescription("logLevel >= 2", "Infos on the BHP pressure"); - appendLogLevelDescription("logLevel >= 2", "Infos on the surface density"); - appendLogLevelDescription("logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element"); + appendLogLevelDescription( "logLevel >= 1", "Infos on residual values" ); + appendLogLevelDescription( "logLevel >= 1", "Output well rates to a simple csv file" ); + appendLogLevelDescription( "logLevel >= 2", "Infos on the BHP pressure" ); + appendLogLevelDescription( "logLevel >= 2", "Infos on the surface density" ); + appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" ); } void CompositionalMultiphaseWell::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index 452ab1aafde..36167dcb5fa 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -46,11 +46,11 @@ SinglePhaseWell::SinglePhaseWell( const string & name, Group * const parent ): WellSolverBase( name, parent ) { - appendLogLevelDescription("logLevel >= 1", "Infos on residual values"); - appendLogLevelDescription("logLevel >= 1", "Output well rates to a simple csv file"); - appendLogLevelDescription("logLevel >= 2", "Infos on BHP pressure"); - appendLogLevelDescription("logLevel >= 2", "Infos on surface density"); - appendLogLevelDescription("logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element"); + appendLogLevelDescription( "logLevel >= 1", "Infos on residual values" ); + appendLogLevelDescription( "logLevel >= 1", "Output well rates to a simple csv file" ); + appendLogLevelDescription( "logLevel >= 2", "Infos on BHP pressure" ); + appendLogLevelDescription( "logLevel >= 2", "Infos on surface density" ); + appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" ); m_numDofPerWellElement = 2; m_numDofPerResElement = 1; diff --git a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp index c7abe138010..3884a407a28 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -78,7 +78,7 @@ CompositionalMultiphaseReservoirAndWells( const string & name, { Base::enableLogLevelInput(); - Base::appendLogLevelDescription("logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors"); + Base::appendLogLevelDescription( "logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors" ); } template< typename COMPOSITIONAL_RESERVOIR_SOLVER > diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index c4b265b2cc7..334899cbf9e 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -80,7 +80,7 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & { Base:: - registerWrapper( viewKeyStruct::surfaceGeneratorNameString(), &m_surfaceGeneratorName ). + registerWrapper( viewKeyStruct::surfaceGeneratorNameString(), &m_surfaceGeneratorName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). setDescription( "Name of the surface generator to use in the hydrofracture solver" ); @@ -109,7 +109,7 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); - Base::appendLogLevelDescription("logLevel >= 1", "Output whether or not we Re-entering Newton Solve"); + Base::appendLogLevelDescription( "logLevel >= 1", "Output whether or not we Re-entering Newton Solve" ); m_numResolves[0] = 0; diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index 69425f695d2..0ff56d3b191 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -40,9 +40,9 @@ SinglePhasePoromechanicsConformingFractures::SinglePhasePoromechanicsConformingF Group * const parent ) : Base( name, parent ) { - - appendLogLevelDescription("logLevel >= 3", "The summary of declared fields and coupling"); + + appendLogLevelDescription( "logLevel >= 3", "The summary of declared fields and coupling" ); LinearSolverParameters & params = m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; diff --git a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp index f02b5a12545..73952eedbda 100644 --- a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp +++ b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp @@ -81,8 +81,8 @@ PhaseFieldDamageFEM::PhaseFieldDamageFEM( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "The upper bound of the damage" ); - appendLogLevelDescription("logLevel >= 2", "Output the jacobian matrix"); - appendLogLevelDescription("logLevel >= 2", "Output the residuals values"); + appendLogLevelDescription( "logLevel >= 2", "Output the jacobian matrix" ); + appendLogLevelDescription( "logLevel >= 2", "Output the residuals values" ); } PhaseFieldDamageFEM::~PhaseFieldDamageFEM() diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp index 10650cfc264..61359e9eec0 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp @@ -120,8 +120,8 @@ SolidMechanicsLagrangianFEM::SolidMechanicsLagrangianFEM( const string & name, setInputFlag( InputFlags::FALSE ). setDescription( "The maximum force contribution in the problem domain." ); - appendLogLevelDescription("logLevel >= 2 and target set is empty", "Warning about boundary conditions"); - appendLogLevelDescription("logLevel >= 2", "Infos on residuals values"); + appendLogLevelDescription( "logLevel >= 2 and target set is empty", "Warning about boundary conditions" ); + appendLogLevelDescription( "logLevel >= 2", "Infos on residuals values" ); } diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index a20ccb6b539..c9377fc81cc 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -220,10 +220,10 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); - appendLogLevelDescription("logLevel >= 1", "Infos about splitting node/edge/faces"); - appendLogLevelDescription("logLevel >= 2", "Infos about all elements attached to the nodeID"); - appendLogLevelDescription("logLevel >= 2", "Infos about all faces on their element"); - appendLogLevelDescription("logLevel >= 3", "Infos on the consistency checking of the maps"); + appendLogLevelDescription( "logLevel >= 1", "Infos about splitting node/edge/faces" ); + appendLogLevelDescription( "logLevel >= 2", "Infos about all elements attached to the nodeID" ); + appendLogLevelDescription( "logLevel >= 2", "Infos about all faces on their element" ); + appendLogLevelDescription( "logLevel >= 3", "Infos on the consistency checking of the maps" ); } void SurfaceGenerator::postProcessInput() From 8de5703edace769070a907504b970860d6c7bc18 Mon Sep 17 00:00:00 2001 From: arng40 Date: Wed, 22 May 2024 11:19:51 +0200 Subject: [PATCH 09/18] add missing log --- src/coreComponents/dataRepository/Group.cpp | 2 +- src/coreComponents/dataRepository/WrapperBase.hpp | 4 ++-- src/coreComponents/events/EventBase.cpp | 4 ++-- .../physicsSolvers/NonlinearSolverParameters.cpp | 2 -- src/coreComponents/physicsSolvers/SolverBase.cpp | 3 --- .../physicsSolvers/fluidFlow/SinglePhaseFVM.cpp | 2 -- .../physicsSolvers/fluidFlow/wells/WellControls.cpp | 4 ++-- .../CompositionalMultiphaseReservoirAndWells.cpp | 2 -- .../multiphysics/PoromechanicsInitialization.cpp | 5 +++-- .../solidMechanics/SolidMechanicsStateReset.cpp | 4 +++- 10 files changed, 13 insertions(+), 19 deletions(-) diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index eebb1408ea6..ac94ae4b3da 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -81,7 +81,7 @@ void Group::deregisterWrapper( string const & name ) void Group::addLogLevelEntry( string_view level, string_view description ) { - m_logLevelsDescriptions[string( level )].push_back( string( description ) ); + m_logLevelsDescriptions[ string( level ) ].push_back( string( description ) ); } void Group::appendLogLevelDescription( string_view levelCondition, string_view logDescription ) diff --git a/src/coreComponents/dataRepository/WrapperBase.hpp b/src/coreComponents/dataRepository/WrapperBase.hpp index 45ad05876cb..c6e5018cdd7 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -533,8 +533,8 @@ class WrapperBase size_t idxDescription = 0; for( const auto & description : logDescriptions ) { - idxDescription == logDescriptions.size() - 1 ? descriptionToBuild.append( " - " + description ) : - descriptionToBuild.append( GEOS_FMT( " - {}\n", description ) ); + idxDescription == logDescriptions.size() - 1 ? descriptionToBuild.append( " - " + description ) + : descriptionToBuild.append( GEOS_FMT( " - {}\n", description ) ); idxDescription++; } } diff --git a/src/coreComponents/events/EventBase.cpp b/src/coreComponents/events/EventBase.cpp index 89512035b95..9187e09a0b7 100644 --- a/src/coreComponents/events/EventBase.cpp +++ b/src/coreComponents/events/EventBase.cpp @@ -52,8 +52,6 @@ EventBase::EventBase( const string & name, { setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); - enableLogLevelInput(); - registerWrapper( viewKeyStruct::eventTargetString(), &m_eventTarget ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::OPTIONAL ). @@ -105,6 +103,8 @@ EventBase::EventBase( const string & name, registerWrapper( viewKeyStruct::isTargetExecutingString(), &m_targetExecFlag ). setDescription( "Index of the current subevent" ); + + appendLogLevelDescription( "logLevel >= 1", "Log about sub-event" ); } diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index 84ffe138686..70ad52ee54e 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -26,8 +26,6 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, { setInputFlags( InputFlags::OPTIONAL ); - enableLogLevelInput(); - registerWrapper( viewKeysStruct::lineSearchActionString(), &m_lineSearchAction ). setApplyDefaultValue( LineSearchAction::Attempt ). setInputFlag( InputFlags::OPTIONAL ). diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index b1acb3f4f81..35725fcbd53 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -45,9 +45,6 @@ SolverBase::SolverBase( string const & name, { setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); - // This enables logLevel filtering - enableLogLevelInput(); - // This sets a flag to indicate that this object is going to select the time step size this->setTimesteppingBehavior( ExecutableGroup::TimesteppingBehavior::DeterminesTimeStepSize ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 70be4627fe2..9166aaed4b7 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -59,8 +59,6 @@ SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, Group * const parent ): BASE( name, parent ) { - SinglePhaseBase::enableLogLevelInput(); - SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1", "Infos on the residual values" ); SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with pressure" ); SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with temperature" ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index 6ca0974e47f..6399a2bb2e0 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -49,8 +49,6 @@ WellControls::WellControls( string const & name, Group * const parent ) m_statusTable( nullptr ) { setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); - - enableLogLevelInput(); registerWrapper( viewKeyStruct::typeString(), &m_type ). setInputFlag( InputFlags::REQUIRED ). @@ -162,6 +160,8 @@ WellControls::WellControls( string const & name, Group * const parent ) setInputFlag( InputFlags::OPTIONAL ). setDescription( "Name of the well status table when the status of the well is a time dependent function. \n" "If the status function evaluates to a positive value at the current time, the well will be open otherwise the well will be shut." ); + + appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Inform about well controls setting" ); } diff --git a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp index 67e64a58f39..3bde78a9952 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -43,8 +43,6 @@ CompositionalMultiphaseReservoirAndWells( const string & name, Group * const parent ) : Base( name, parent ) { - Base::enableLogLevelInput(); - Base::appendLogLevelDescription( "logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors" ); } diff --git a/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp b/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp index b21b1d904f5..dade19de71d 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp @@ -42,8 +42,6 @@ PoromechanicsInitialization( const string & name, m_solidMechanicsStatistics(), m_solidMechanicsStateResetTask( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::poromechanicsSolverNameString(), &m_poromechanicsSolverName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). @@ -54,6 +52,9 @@ PoromechanicsInitialization( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "" ). setDescription( "Name of the solid mechanics statistics" ); + + appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Inform about physics solver stress initialization" ); + appendLogLevelDescription( "logLevel >= 1", "Indicate the physics solver completed stress initialization" ); } template< typename POROMECHANICS_SOLVER > diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp index f77dd4fd535..5eea9a2585b 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp @@ -35,7 +35,6 @@ SolidMechanicsStateReset::SolidMechanicsStateReset( const string & name, TaskBase( name, parent ), m_solidSolverName() { - enableLogLevelInput(); registerWrapper( viewKeyStruct::solidSolverNameString(), &m_solidSolverName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). @@ -51,6 +50,9 @@ SolidMechanicsStateReset::SolidMechanicsStateReset( const string & name, setApplyDefaultValue( false ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to enable/disable inelastic behavior" ); + + appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Inform about physics solver resetting total displacement and velocity to zero" ); + appendLogLevelDescription( "logLevel >= 2", "Inform about solid model enable / disable inelastic behavior" ); } SolidMechanicsStateReset::~SolidMechanicsStateReset() From a720b27f785e7402386afaddc585f7041905d88c Mon Sep 17 00:00:00 2001 From: arng40 Date: Wed, 22 May 2024 11:24:06 +0200 Subject: [PATCH 10/18] update comment --- src/coreComponents/dataRepository/Group.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index 8b40dcd8aa7..d64c9784056 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -1622,7 +1622,7 @@ class Group integer m_logLevel; /// Map for building the log level string for each wrapper - /// key : logLevel, values : description(s) for a level + /// key : a logLevel condition, values : a set of description for a corresponding loglevel std::map< std::string, std::vector< std::string > > m_logLevelsDescriptions; //END_SPHINX_INCLUDE_02 From dcf4fa7555dea3bc9d35a62f6270205d768564c3 Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 24 May 2024 11:20:28 +0200 Subject: [PATCH 11/18] adding new doc + update --- src/coreComponents/dataRepository/Group.cpp | 7 ------ src/coreComponents/dataRepository/Group.hpp | 3 --- src/coreComponents/events/EventBase.cpp | 2 +- src/coreComponents/events/EventManager.cpp | 4 +-- .../AquiferBoundaryCondition.cpp | 1 + .../FieldSpecificationBase.cpp | 4 ++- .../SourceFluxBoundaryCondition.cpp | 5 ++++ .../fileIO/Outputs/ChomboIO.cpp | 2 ++ .../fileIO/Outputs/VTKOutput.cpp | 2 ++ .../interfaces/direct/SuperLUDist.cpp | 2 +- .../interfaces/hypre/HypreMGR.cpp | 2 +- src/coreComponents/mesh/DomainPartition.cpp | 2 ++ .../mesh/generators/VTKMeshGenerator.cpp | 9 ++++--- .../mesh/generators/VTKWellGenerator.cpp | 1 + .../physicsSolvers/FieldStatisticsBase.hpp | 6 +++-- .../physicsSolvers/LinearSolverParameters.cpp | 25 ++++++++++++++++++- .../physicsSolvers/SolverBase.cpp | 21 ++++++++++------ .../fluidFlow/CompositionalMultiphaseBase.cpp | 6 ++++- .../fluidFlow/CompositionalMultiphaseFVM.cpp | 11 ++++++-- .../CompositionalMultiphaseStatistics.cpp | 5 +++- .../fluidFlow/FlowSolverBase.cpp | 3 +-- .../ReactiveCompositionalMultiphaseOBL.cpp | 7 ++---- .../fluidFlow/SinglePhaseBase.cpp | 5 ++-- .../fluidFlow/SinglePhaseFVM.cpp | 4 +-- .../fluidFlow/SinglePhaseHybridFVM.cpp | 4 +-- .../fluidFlow/SinglePhaseStatistics.cpp | 4 ++- .../fluidFlow/wells/WellControls.cpp | 2 +- .../multiphysics/CoupledSolver.hpp | 8 +++--- .../FlowProppantTransportSolver.cpp | 4 ++- .../multiphysics/HydrofractureSolver.cpp | 6 ++--- .../multiphysics/MultiphasePoromechanics.cpp | 3 ++- .../PoromechanicsInitialization.cpp | 3 +-- .../SolidMechanicsStateReset.cpp | 4 +-- .../SolidMechanicsStatistics.cpp | 4 ++- .../EmbeddedSurfaceGenerator.cpp | 3 +++ .../surfaceGeneration/SurfaceGenerator.cpp | 11 ++++---- .../isotropic/AcousticWaveEquationSEM.cpp | 1 + .../wavePropagation/shared/WaveSolverBase.cpp | 2 ++ 38 files changed, 128 insertions(+), 70 deletions(-) diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index ac94ae4b3da..c2c6f2eb6b5 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -659,13 +659,6 @@ void Group::postRestartInitializationRecursive() postRestartInitialization(); } -void Group::enableLogLevelInput() -{ - registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ). - setApplyDefaultValue( 1 ). - setInputFlag( InputFlags::OPTIONAL ); -} - Group const & Group::getBaseGroupByPath( string const & path ) const { Group const * currentGroup = this; diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index d64c9784056..2e8c4ef8059 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -1476,9 +1476,6 @@ class Group */ void loadFromConduit(); - /// Enable verbosity input for object - void enableLogLevelInput(); - /** * @brief Set verbosity level * @param logLevel new verbosity level value diff --git a/src/coreComponents/events/EventBase.cpp b/src/coreComponents/events/EventBase.cpp index 9187e09a0b7..685f05e65ae 100644 --- a/src/coreComponents/events/EventBase.cpp +++ b/src/coreComponents/events/EventBase.cpp @@ -104,7 +104,7 @@ EventBase::EventBase( const string & name, registerWrapper( viewKeyStruct::isTargetExecutingString(), &m_targetExecFlag ). setDescription( "Index of the current subevent" ); - appendLogLevelDescription( "logLevel >= 1", "Log about sub-event" ); + appendLogLevelDescription( "logLevel >= 1", "Information about sub-event" ); } diff --git a/src/coreComponents/events/EventManager.cpp b/src/coreComponents/events/EventManager.cpp index 4b2b605345f..b300d6b99b6 100644 --- a/src/coreComponents/events/EventManager.cpp +++ b/src/coreComponents/events/EventManager.cpp @@ -44,8 +44,6 @@ EventManager::EventManager( string const & name, { setInputFlags( InputFlags::REQUIRED ); - enableLogLevelInput(); - registerWrapper( viewKeyStruct::minTimeString(), &m_minTime ). setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ). @@ -81,6 +79,8 @@ EventManager::EventManager( string const & name, setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "Format of the time in the GEOS log." ); + + appendLogLevelDescription( "logLevel >= 1", "Information about current sub-event" ); } diff --git a/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp b/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp index f74b40c75a5..8f5838522e8 100644 --- a/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp +++ b/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp @@ -111,6 +111,7 @@ AquiferBoundaryCondition::AquiferBoundaryCondition( string const & name, Group * getWrapper< int >( FieldSpecificationBase::viewKeyStruct::componentString() ). setInputFlag( InputFlags::FALSE ); + appendLogLevelDescription( "logLevel >= 1", "Information on boundary conditions" ); } void AquiferBoundaryCondition::postProcessInput() diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index 09f92109054..45b295e5d65 100644 --- a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp +++ b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp @@ -84,7 +84,9 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par setInputFlag( InputFlags::OPTIONAL ). setDescription( "Time at which the boundary condition will stop being applied." ); - enableLogLevelInput(); + appendLogLevelDescription( "logLevel >= 1 and regions with no dof", "Warning about non simulated region" ); + appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Print boundary conditions log messages" ); + appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Information on the face boundary condition defined with pressure and temperature" ); } diff --git a/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp b/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp index acc3cc39981..21ff43e30f5 100644 --- a/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp +++ b/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp @@ -29,6 +29,11 @@ SourceFluxBoundaryCondition::SourceFluxBoundaryCondition( string const & name, G getWrapper< string >( FieldSpecificationBase::viewKeyStruct::fieldNameString() ). setInputFlag( InputFlags::FALSE ); setFieldName( catalogName() ); + + appendLogLevelDescription( "logLevel >= 1 and first newton iteration", "Print the log message issued by the solver if the boundary condition is called" ); + appendLogLevelDescription( "logLevel >= 1 and regions with no dof", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); + appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Information abonout the Dirichlet pressure, temperature boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration and this is a thermal simulation", "Information on single phase thermal simulation" ); } REGISTER_CATALOG_ENTRY( FieldSpecificationBase, SourceFluxBoundaryCondition, string const &, Group * const ) diff --git a/src/coreComponents/fileIO/Outputs/ChomboIO.cpp b/src/coreComponents/fileIO/Outputs/ChomboIO.cpp index ffabfe63b05..21bea044374 100644 --- a/src/coreComponents/fileIO/Outputs/ChomboIO.cpp +++ b/src/coreComponents/fileIO/Outputs/ChomboIO.cpp @@ -60,6 +60,8 @@ ChomboIO::ChomboIO( string const & name, Group * const parent ): setInputFlag( InputFlags::OPTIONAL ). setDefaultValue( 0 ). setDescription( "True iff geosx should use the pressures chombo writes out." ); + + appendLogLevelDescription( "logLevel == 1", "Indicate chombo initializing" ); } ChomboIO::~ChomboIO() diff --git a/src/coreComponents/fileIO/Outputs/VTKOutput.cpp b/src/coreComponents/fileIO/Outputs/VTKOutput.cpp index 3b54838efcb..a1cc25f4bbd 100644 --- a/src/coreComponents/fileIO/Outputs/VTKOutput.cpp +++ b/src/coreComponents/fileIO/Outputs/VTKOutput.cpp @@ -114,6 +114,8 @@ void VTKOutput::postProcessInput() "{} `{}`: found {} fields to plot in `{}`, in addition to all fields with `plotLevel` smaller or equal to {}.", catalogName(), getDataContext(), std::to_string( m_fieldNames.size() ), fieldNamesString, m_plotLevel ) ); + + appendLogLevelDescription( "logLevel >= 1", "Print field name and cycle number during execution" ); } diff --git a/src/coreComponents/linearAlgebra/interfaces/direct/SuperLUDist.cpp b/src/coreComponents/linearAlgebra/interfaces/direct/SuperLUDist.cpp index 52a62dfa2b3..152c9112915 100644 --- a/src/coreComponents/linearAlgebra/interfaces/direct/SuperLUDist.cpp +++ b/src/coreComponents/linearAlgebra/interfaces/direct/SuperLUDist.cpp @@ -326,7 +326,7 @@ void SuperLUDist< LAI >::setOptions() m_data->options.ParSymbFact = m_params.direct.colPerm == LinearSolverParameters::Direct::ColPerm::parmetis ? YES : NO; m_data->options.ReplaceTinyPivot = m_params.direct.replaceTinyPivot ? YES : NO; m_data->options.IterRefine = m_params.direct.iterativeRefine ? SLU_DOUBLE : NOREFINE; - + if( m_params.logLevel > 0 ) { print_sp_ienv_dist( &m_data->options ); diff --git a/src/coreComponents/linearAlgebra/interfaces/hypre/HypreMGR.cpp b/src/coreComponents/linearAlgebra/interfaces/hypre/HypreMGR.cpp index aa85b90b68a..fb052d93895 100644 --- a/src/coreComponents/linearAlgebra/interfaces/hypre/HypreMGR.cpp +++ b/src/coreComponents/linearAlgebra/interfaces/hypre/HypreMGR.cpp @@ -74,7 +74,7 @@ void hypre::mgr::createMGR( LinearSolverParameters const & params, { GEOS_LOG_RANK_0( GEOS_FMT( " MGR preconditioner: numComponentsPerField = {}", numComponentsPerField ) ); } - if( params.logLevel >= 1024 ) + if( params.logLevel >= 1 ) { GEOS_LOG_RANK( GEOS_FMT( " MGR preconditioner: pointMarkers = {}", mgrData.pointMarkers ) ); } diff --git a/src/coreComponents/mesh/DomainPartition.cpp b/src/coreComponents/mesh/DomainPartition.cpp index 50cecbc24d9..c02ecf46889 100644 --- a/src/coreComponents/mesh/DomainPartition.cpp +++ b/src/coreComponents/mesh/DomainPartition.cpp @@ -45,6 +45,8 @@ DomainPartition::DomainPartition( string const & name, registerGroup( groupKeys.meshBodies ); registerGroup< constitutive::ConstitutiveManager >( groupKeys.constitutiveManager ); + + appendLogLevelDescription( "logLevel >= 3", "Indication about setup communication" ); } diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index 3b8ff1662d1..0cc5ee683e4 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -75,9 +75,10 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, " If set to a negative value, the GlobalId arrays in the input mesh are not used, and generated global Ids are automatically generated." " If set to a positive value, the GlobalId arrays in the input mesh are used and required, and the simulation aborts if they are not available" ); - appendLogLevelDescription( "logLevel >= 1", "Infos about cell block names" ); - appendLogLevelDescription( "logLevel >= 2", "Infos about node sets names" ); - appendLogLevelDescription( "logLevel >= 5", "Infos about redistribution" ); + appendLogLevelDescription( "logLevel >= 1", "Information on cell block names" ); + appendLogLevelDescription( "logLevel >= 2", "Information on node sets names" ); + appendLogLevelDescription( "logLevel >= 2", "Information on node sets names" ); + appendLogLevelDescription( "logLevel >= 2", "Print the mesh generation step" ); } void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) @@ -88,7 +89,7 @@ void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager MPI_Comm const comm = MPI_COMM_GEOSX; vtkSmartPointer< vtkMultiProcessController > controller = vtk::getController(); vtkMultiProcessController::SetGlobalController( controller ); - + GEOS_LOG_RANK_0( GEOS_FMT( "{} '{}': reading mesh from {}", catalogName(), getName(), m_filePath ) ); { GEOS_LOG_LEVEL_RANK_0( 2, " reading the dataset..." ); diff --git a/src/coreComponents/mesh/generators/VTKWellGenerator.cpp b/src/coreComponents/mesh/generators/VTKWellGenerator.cpp index 3ea92f78551..dc0d94d1849 100644 --- a/src/coreComponents/mesh/generators/VTKWellGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKWellGenerator.cpp @@ -37,6 +37,7 @@ VTKWellGenerator::VTKWellGenerator( string const & name, Group * const parent ): setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "Path to the well file" ); + appendLogLevelDescription( "logLevel >= 2", "Indicate the dataset reading" ); } void VTKWellGenerator::fillPolylineDataStructure( ) diff --git a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp index fc1f4a2c5a3..d4a2ef50173 100644 --- a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp +++ b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp @@ -49,8 +49,6 @@ class FieldStatisticsBase : public TaskBase m_solver( nullptr ), m_outputDir( joinPath( OutputBase::getOutputDirectory(), name ) ) { - enableLogLevelInput(); - string const key = SOLVER::coupledSolverAttributePrefix() + "SolverName"; registerWrapper( key, &m_solverName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). @@ -61,6 +59,10 @@ class FieldStatisticsBase : public TaskBase setApplyDefaultValue( 0 ). setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Write statistics into a CSV file" ); + + appendLogLevelDescription( "logLevel == 1 and pore volume is zero", "Display warning message" ); + appendLogLevelDescription( "logLevel == 1 ", "Dipslay Indicative message" ); + } /** diff --git a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp index 6fa15ae76e4..7f434ac6641 100644 --- a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp @@ -28,7 +28,6 @@ LinearSolverParametersInput::LinearSolverParametersInput( string const & name, Group( name, parent ) { setInputFlags( InputFlags::OPTIONAL ); - enableLogLevelInput(); registerWrapper( viewKeyStruct::solverTypeString(), &m_parameters.solverType ). setApplyDefaultValue( m_parameters.solverType ). @@ -198,6 +197,30 @@ LinearSolverParametersInput::LinearSolverParametersInput( string const & name, setApplyDefaultValue( m_parameters.ifact.threshold ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "ILU(T) threshold factor" ); + + appendLogLevelDescription( "logLevel >= 2", "Print information about symbolic factorization." ); + appendLogLevelDescription( "logLevel >= 2", "Print information about numeric factorization." ); + appendLogLevelDescription( "logLevel >= 2", "Set UMFPACK_PRL to 6" ); + appendLogLevelDescription( "logLevel = 1", "Set UMFPACK_PRL to 1" ); + appendLogLevelDescription( "logLevel >= 1 and incorrect final relative residual norm", "Warning about residual reduction" ); + appendLogLevelDescription( "logLevel >= 1", "Linear solver informations" ); + appendLogLevelDescription( "logLevel >= 1 and incorrect SuperLU residual reduction", "Warning about residual reduction" ); + appendLogLevelDescription( "logLevel >= 1 and SuperLU solver", "Information about superLU result" ); + appendLogLevelDescription( "logLevel >= 2 and SuperLU solver", "Print the statistics." ); + appendLogLevelDescription( "logLevel >= 1 and SuperLU", "Print SuperLU_Dist environment parameters and options" ); + appendLogLevelDescription( "logLevel >= 1 and HypreSolver", "Information about MGR preconditioner" ); + appendLogLevelDescription( "logLevel == 2 or logLevel == 4 and HypreSolver", "Print amg solution info" ); + appendLogLevelDescription( "logLevel >= 1 and HyprePreconditioner setup not existing", "Error about HyprePreconditioner setup failed" ); + appendLogLevelDescription( "logLevel >= 3 and Hypre", "Print Hypre iterations info" ); + appendLogLevelDescription( "logLevel >= 3 and Hypre", "Print convergence + iteration info" ); + appendLogLevelDescription( "logLevel >= 3 and PetscSolver ", "Informations about the PetscSolver result" ); + appendLogLevelDescription( "logLevel >= 1 and PetscSolver ", "Sets an ADDITIONAL function to be called at every iteration to monitor the residual/error etc" ); + appendLogLevelDescription( "logLevel == 1 and TrilinosSover ", "Sets SetAztecOption to AZ_summary" ); + appendLogLevelDescription( "logLevel == 2 and TrilinosSover ", "Sets SetAztecOption to AZ_all" ); + appendLogLevelDescription( "logLevel >= 3 and TrilinosSover ", "Sets SetAztecOption to AZ_none" ); + appendLogLevelDescription( "logLevel >= 2 and KrylovSolver ", "Print residual norms" ); + appendLogLevelDescription( "logLevel >= 2 and KrylovSolver ", "Print the result success with nb iterations and solve time" ); + appendLogLevelDescription( "logLevel >= 2 and value too close to zero. ", "Information about exit solver iteration" ); } void LinearSolverParametersInput::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index 35725fcbd53..a77b1fe2c36 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -86,13 +86,18 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Initial time-step value required by the solver to the event manager." ); - appendLogLevelDescription( "logLevel >= 1", "Infos on line search" ); - appendLogLevelDescription( "logLevel >= 1", "Infos on global solution scaling factor" ); - appendLogLevelDescription( "logLevel >= 1", "Output about the timestep" ); - appendLogLevelDescription( "logLevel >= 2", "Output to screen the assembled linear system (matrices and vectors)" ); - appendLogLevelDescription( "logLevel >= 2", "Output to screen the assembled linear solutions (matrices and vectors)" ); - appendLogLevelDescription( "logLevel >= 3", "Output to file the assembled linear system (matrices and vectors)" ); - appendLogLevelDescription( "logLevel >= 3", "Output to file the assembled linear solutions (matrices and vectors)" ); + appendLogLevelDescription( "logLevel >= 1", "Information on line search" ); + appendLogLevelDescription( "logLevel >= 1", "Information on global solution scaling factor" ); + appendLogLevelDescription( "logLevel >= 1", "Output the timestep" ); + appendLogLevelDescription( "logLevel >= 2", "Output to screen the assembled linear system and solutions (matrices and vectors)" ); + appendLogLevelDescription( "logLevel >= 3", "Output to file the assembled linear system and solutions (matrices and vectors)" ); + appendLogLevelDescription( "logLevel >= 1", "Information on time-step based on stateChange" ); + appendLogLevelDescription( "logLevel >= 1 and incorrect solution", "Information about line search failed" ); + appendLogLevelDescription( "logLevel >= 1", "Print residual norm" ); + appendLogLevelDescription( "logLevel >= 1 and configuration didn't converge", "Information about testing new configuration and print the new step" ); + appendLogLevelDescription( "logLevel >= 1 and non linear system", "Information on each newton Iteration " ); + appendLogLevelDescription( "logLevel >= 1 and linear system", "Information on number of iterations and residual reduction" ); + appendLogLevelDescription( "logLevel >= 1 and residual norm above the max allowed residual norm", "Indicate allowed residual norm" ); registerGroup( groupKeyStruct::linearSolverParametersString(), &m_linearSolverParameters ); registerGroup( groupKeyStruct::nonlinearSolverParametersString(), &m_nonlinearSolverParameters ); @@ -757,7 +762,6 @@ real64 SolverBase::nonlinearImplicitStep( real64 const & time_n, { // increment the solver statistics for reporting purposes m_solverStatistics.logOuterLoopIteration(); - GEOS_LOG_LEVEL_RANK_0( 1, "---------- Configuration did not converge. Testing new configuration. ----------" ); } } @@ -832,6 +836,7 @@ bool SolverBase::solveNonlinearSystem( real64 const & time_n, for( newtonIter = 0; newtonIter < maxNewtonIter; ++newtonIter ) { + GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( " Attempt: {:2}, ConfigurationIter: {:2}, NewtonIter: {:2}", dtAttempt, configurationLoopIter, newtonIter ) ); { diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index ea6dfd0785c..711024823a0 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -152,7 +152,11 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setDescription( "Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check" ); appendLogLevelDescription( "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); - appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1", "Information about pressure, phase, temperature during time step" ); + appendLogLevelDescription( "logLevel >= 1", "Information on density during outer iteration" ); + appendLogLevelDescription( "logLevel >= 1 and thermal simulation", "Information on max relative temperature" ); + appendLogLevelDescription( "logLevel >= 1", "Information on volume frations" ); + appendLogLevelDescription( "logLevel >= 1", "Information on CFL number" ); } void CompositionalMultiphaseBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index 061594a4839..92cdec30f32 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -87,8 +87,14 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); - appendLogLevelDescription( "logLevel >= 1", "Informations on the residual values" ); - appendLogLevelDescription( "logLevel >= 1 and non first nonlinear iteration", "Infos about the face boundary conditions log" ); + appendLogLevelDescription( "logLevel >= 1", "Print the residual values" ); + appendLogLevelDescription( "logLevel >= 1 and non first nonlinear iteration", "Information on the face boundary conditions log" ); + appendLogLevelDescription( "logLevel >= 1", "Information about max pressure/max component density change" ); + appendLogLevelDescription( "logLevel >= 1 and thermal simulation", "Information about temperature changes" ); + appendLogLevelDescription( "logLevel >= 1 and scaling type is local", "Print scaling factors" ); + appendLogLevelDescription( "logLevel >= 1 and negative pressure", "Information on negative pressure values" ); + appendLogLevelDescription( "logLevel >= 1 and negative density", "Information on negative density values" ); + appendLogLevelDescription( "logLevel >= 1 and total density > 0", "Information on total density values" ); } void CompositionalMultiphaseFVM::postProcessInput() @@ -527,6 +533,7 @@ real64 CompositionalMultiphaseFVM::scalingForSystemSolution( DomainPartition & d minCompDensScalingFactor = MpiWrapper::min( minCompDensScalingFactor ); string const massUnit = m_useMass ? "kg/m3" : "mol/m3"; + GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( " {}: Max pressure change: {} Pa (before scaling)", getName(), GEOS_FMT( "{:.{}f}", maxDeltaPres, 3 ) ) ); GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( " {}: Max component density change: {} {} (before scaling)", diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp index 137a760069d..39b0fb27818 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp @@ -59,6 +59,10 @@ CompositionalMultiphaseStatistics::CompositionalMultiphaseStatistics( const stri setApplyDefaultValue( 1e-6 ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to decide whether a phase is considered mobile (when the relperm is above the threshold) or immobile (when the relperm is below the threshold) in metric 2" ); + + appendLogLevelDescription( "logLevel >= 1 and pore volume equal 0", "Warning on the impossibility to compute pressure" ); + appendLogLevelDescription( "logLevel >= 1", "Information on the regions statistics" ); + appendLogLevelDescription( "logLevel >= 1", "Information on CFL numbers" ); } void CompositionalMultiphaseStatistics::postProcessInput() @@ -395,7 +399,6 @@ void CompositionalMultiphaseStatistics::computeRegionStatistics( real64 const ti << ": Cannot compute average pressure because region pore volume is zero." ); } - // helpers to report statistics array1d< real64 > nonTrappedPhaseMass( numPhases ); array1d< real64 > mobilePhaseMass( numPhases ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp index 84a1a1f8e70..1579fded932 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -121,7 +121,7 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevelDescription( "logLevel >= 1", "Infos about the boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1", "Information on pressure and temperature" ); // allow the user to select a norm getNonlinearSolverParameters().getWrapper< solverBaseKernels::NormType >( NonlinearSolverParameters::viewKeysStruct::normTypeString() ).setInputFlag( InputFlags::OPTIONAL ); @@ -794,7 +794,6 @@ void FlowSolverBase::updateStencilWeights( DomainPartition & domain ) const bool FlowSolverBase::checkSequentialSolutionIncrements( DomainPartition & GEOS_UNUSED_PARAM( domain ) ) const { - GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( " {}: Max pressure change during outer iteration: {} Pa", getName(), fmt::format( "{:.{}f}", m_sequentialPresChange, 3 ) ) ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index 6e0ba71bfdb..a1f634d57a0 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -115,11 +115,8 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); - appendLogLevelDescription( "logLevel >= 1", "Informations on the residuals values" ); - appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions" ); - appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the boundary conditions" ); - appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet pressure boundary conditions" ); - appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the Dirichlet temperature boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1", "Print the residuals values" ); + //appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions" ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp index 0a6ccc76f58..9f0cf072091 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -58,8 +58,8 @@ SinglePhaseBase::SinglePhaseBase( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Temperature" ); - appendLogLevelDescription( "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); - appendLogLevelDescription( "logLevel >= 1", "Infos about boundary conditions" ); + appendLogLevelDescription( "logLevel >= 1", "Print pressure change" ); + appendLogLevelDescription( "logLevel >= 1", "Information on negative pressure values" ); } @@ -1070,6 +1070,7 @@ void SinglePhaseBase::applySourceFluxBC( real64 const time_n, { return; } + if( !subRegion.hasWrapper( dofKey ) ) { if( fs.getLogLevel() >= 1 ) diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 9166aaed4b7..ce685c7fe85 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -59,9 +59,7 @@ SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, Group * const parent ): BASE( name, parent ) { - SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1", "Infos on the residual values" ); - SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with pressure" ); - SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary condition defined with temperature" ); + SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1", "Print the residual values" ); } template< typename BASE > diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index aff821973ca..bac7ac9e802 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -46,9 +46,7 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, SinglePhaseBase( name, parent ), m_areaRelTol( 1e-8 ) { - - appendLogLevelDescription( "logLevel >= 1", "Infos about the residual values" ); - appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Infos about the face boundary conditions definied with pressure" ); + appendLogLevelDescription( "logLevel >= 1", "Print the residual norm values" ); // one cell-centered dof per cell m_numDofPerCell = 1; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp index c74a9e906b1..07257632cde 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp @@ -34,7 +34,9 @@ using namespace dataRepository; SinglePhaseStatistics::SinglePhaseStatistics( const string & name, Group * const parent ): Base( name, parent ) -{} +{ + appendLogLevelDescription( "logLevel >= 1", "Information on region statistics" ); +} void SinglePhaseStatistics::registerDataOnMesh( Group & meshBodies ) { diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index 6399a2bb2e0..e9bf64190fa 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -161,7 +161,7 @@ WellControls::WellControls( string const & name, Group * const parent ) setDescription( "Name of the well status table when the status of the well is a time dependent function. \n" "If the status function evaluates to a positive value at the current time, the well will be open otherwise the well will be shut." ); - appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Inform about well controls setting" ); + appendLogLevelDescription( "logLevel >= 1", "Information on well controls setting" ); } diff --git a/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp index d46bbc32def..4fdb5c09456 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp @@ -54,6 +54,11 @@ class CoupledSolver : public SolverBase this->getWrapper< string >( SolverBase::viewKeyStruct::discretizationString() ). setInputFlag( dataRepository::InputFlags::FALSE ); + + appendLogLevelDescription( "logLevel >= 1", "Print solvers name" ); + appendLogLevelDescription( "logLevel >= 1", "Print residual norm" ); + appendLogLevelDescription( "logLevel >= 1", "Print time stepping" ); + appendLogLevelDescription( "logLevel >= 1", "Information on each iteration" ); } /// deleted copy constructor @@ -68,7 +73,6 @@ class CoupledSolver : public SolverBase /// deleted move operator CoupledSolver & operator=( CoupledSolver && ) = delete; - /** * @brief Utility function to set the subsolvers pointers using the names provided by the user */ @@ -546,7 +550,6 @@ class CoupledSolver : public SolverBase { NonlinearSolverParameters const & params = getNonlinearSolverParameters(); bool isConverged = true; - if( params.m_subcyclingOption == 0 ) { GEOS_LOG_LEVEL_RANK_0( 1, "***** Single Pass solver, no subcycling *****" ); @@ -618,7 +621,6 @@ class CoupledSolver : public SolverBase { GEOS_ERROR( getDataContext() << ": Invalid sequential convergence criterion." ); } - if( isConverged ) { GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( "***** The iterative coupling has converged in {} iteration(s) *****", iter + 1 ) ); diff --git a/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp index 17ee134ba24..b610999ab1f 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp @@ -32,7 +32,9 @@ using namespace constitutive; FlowProppantTransportSolver::FlowProppantTransportSolver( const string & name, Group * const parent ): Base( name, parent ) -{} +{ + appendLogLevelDescription( "logLevel >= 1", "Informations about convergance and iterations " ); +} void FlowProppantTransportSolver::preStepUpdate( real64 const & time_n, real64 const & dt, diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index 2856121ea54..8f6d7f643de 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -46,8 +46,6 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & m_isMatrixPoroelastic(), m_newFractureInitializationType() { - Base:: - registerWrapper( viewKeyStruct::surfaceGeneratorNameString(), &m_surfaceGeneratorName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). @@ -78,6 +76,9 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setInputFlag( InputFlags::OPTIONAL ); Base::appendLogLevelDescription( "logLevel >= 1", "Output whether or not we Re-entering Newton Solve" ); + Base::appendLogLevelDescription( "logLevel >= 1", "Information on aperture and hydraulic aperture" ); + Base::appendLogLevelDescription( "logLevel >= 3", "Print time stepping" ); + m_numResolves[0] = 0; @@ -891,7 +892,6 @@ real64 HydrofractureSolver< POROMECHANICS_SOLVER >::setNextDt( real64 const & cu { nextDt = m_surfaceGenerator->getTimestepRequest() < 1e99 ? m_surfaceGenerator->getTimestepRequest() : currentDt; } - GEOS_LOG_LEVEL_RANK_0( 3, this->getName() << ": nextDt request is " << nextDt ); return nextDt; } diff --git a/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp b/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp index c497b8d9480..1e84031088f 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp @@ -59,6 +59,8 @@ MultiphasePoromechanics< FLOW_SOLVER >::MultiphasePoromechanics( const string & setInputFlag( InputFlags::OPTIONAL ). setDescription( "Constant multiplier of stabilization strength." ); + Base::appendLogLevelDescription( "logLevel >= 1", "Print phase volume fraction" ); + LinearSolverParameters & linearSolverParameters = this->m_linearSolverParameters.get(); linearSolverParameters.mgr.strategy = LinearSolverParameters::MGR::StrategyType::multiphasePoromechanics; linearSolverParameters.mgr.separateComponents = true; @@ -289,7 +291,6 @@ void MultiphasePoromechanics< FLOW_SOLVER >::updateState( DomainPartition & doma } ); maxDeltaPhaseVolFrac = MpiWrapper::max( maxDeltaPhaseVolFrac ); - GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( " {}: Max phase volume fraction change = {}", this->getName(), GEOS_FMT( "{:.{}f}", maxDeltaPhaseVolFrac, 4 ) ) ); } diff --git a/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp b/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp index dade19de71d..334197a0db6 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp @@ -53,8 +53,7 @@ PoromechanicsInitialization( const string & name, setApplyDefaultValue( "" ). setDescription( "Name of the solid mechanics statistics" ); - appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Inform about physics solver stress initialization" ); - appendLogLevelDescription( "logLevel >= 1", "Indicate the physics solver completed stress initialization" ); + appendLogLevelDescription( "logLevel >= 1", "Information about physics solver stress initialization" ); } template< typename POROMECHANICS_SOLVER > diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp index 5eea9a2585b..73a696ed7d4 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp @@ -51,8 +51,8 @@ SolidMechanicsStateReset::SolidMechanicsStateReset( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to enable/disable inelastic behavior" ); - appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Inform about physics solver resetting total displacement and velocity to zero" ); - appendLogLevelDescription( "logLevel >= 2", "Inform about solid model enable / disable inelastic behavior" ); + appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Information about physics solver duringtask" ); + appendLogLevelDescription( "logLevel >= 2", "Information about solid model during task" ); } SolidMechanicsStateReset::~SolidMechanicsStateReset() diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp index 855fb547a3f..c729be5cb52 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp @@ -35,7 +35,9 @@ using namespace fields; SolidMechanicsStatistics::SolidMechanicsStatistics( const string & name, Group * const parent ): Base( name, parent ) -{} +{ + appendLogLevelDescription( "logLevel >= 1", "Information on node statistics displacement" ); +} void SolidMechanicsStatistics::registerDataOnMesh( Group & meshBodies ) { diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp index 85d2fbc2aa9..4c0da3ea920 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp @@ -80,6 +80,9 @@ EmbeddedSurfaceGenerator::EmbeddedSurfaceGenerator( const string & name, registerWrapper( viewKeyStruct::mpiCommOrderString(), &m_mpiCommOrder ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to enable MPI consistent communication ordering" ); + + appendLogLevelDescription( "logLevel >= 2", "Print each cell index element fractured" ); + appendLogLevelDescription( "logLevel >= 1", "Print number of embedded surface elements" ); } EmbeddedSurfaceGenerator::~EmbeddedSurfaceGenerator() diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index c9377fc81cc..6c19a42f491 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -220,10 +220,12 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); - appendLogLevelDescription( "logLevel >= 1", "Infos about splitting node/edge/faces" ); - appendLogLevelDescription( "logLevel >= 2", "Infos about all elements attached to the nodeID" ); - appendLogLevelDescription( "logLevel >= 2", "Infos about all faces on their element" ); - appendLogLevelDescription( "logLevel >= 3", "Infos on the consistency checking of the maps" ); + appendLogLevelDescription( "logLevel >= 1", "Print splitting node along separation plane faces" ); + appendLogLevelDescription( "logLevel >= 1", "Print splitting edge and face" ); + appendLogLevelDescription( "logLevel >= 2", "Print all elements attached to the nodeID" ); + appendLogLevelDescription( "logLevel >= 2", "Print all faces on their element" ); + appendLogLevelDescription( "logLevel >= 3", "Information on the consistency checking of the maps" ); + appendLogLevelDescription( "logLevel >= 3", "Print rupture rate" ); } void SurfaceGenerator::postProcessInput() @@ -750,7 +752,6 @@ int SurfaceGenerator::separationDriver( DomainPartition & domain, real64 ruptureRate = calculateRuptureRate( elementManager.getRegion< SurfaceElementRegion >( this->m_fractureRegionName ) ); - GEOS_LOG_LEVEL_RANK_0( 3, "rupture rate is " << ruptureRate ); if( ruptureRate > 0 ) m_nextDt = ruptureRate < 1e99 ? m_cflFactor / ruptureRate : 1e99; diff --git a/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp b/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp index a6171a8028c..4126fa91bd6 100644 --- a/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp +++ b/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp @@ -50,6 +50,7 @@ AcousticWaveEquationSEM::AcousticWaveEquationSEM( const std::string & name, setSizedFromParent( 0 ). setDescription( "Pressure value at each receiver for each timestep" ); + appendLogLevelDescription( "logLevel >= 1", "Print PML parameters" ); } AcousticWaveEquationSEM::~AcousticWaveEquationSEM() diff --git a/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp b/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp index 3eb561b2704..6d74334798f 100644 --- a/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp @@ -197,6 +197,8 @@ WaveSolverBase::WaveSolverBase( const std::string & name, setInputFlag( InputFlags::FALSE ). setSizedFromParent( 0 ). setDescription( "Element containing the receivers" ); + + appendLogLevelDescription( "logLevel >= 1", "Information about linear DAS" ); } WaveSolverBase::~WaveSolverBase() From 78badfa042fce35a231e0e07ae4836b6d5f5a58b Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 24 May 2024 15:18:34 +0200 Subject: [PATCH 12/18] update solver log --- .../physicsSolvers/LinearSolverParameters.cpp | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp index 7f434ac6641..9195e796c10 100644 --- a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp @@ -198,28 +198,28 @@ LinearSolverParametersInput::LinearSolverParametersInput( string const & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "ILU(T) threshold factor" ); - appendLogLevelDescription( "logLevel >= 2", "Print information about symbolic factorization." ); - appendLogLevelDescription( "logLevel >= 2", "Print information about numeric factorization." ); + appendLogLevelDescription( "logLevel >= 2", "Print information about symbolic and numeric factorization." ); appendLogLevelDescription( "logLevel >= 2", "Set UMFPACK_PRL to 6" ); appendLogLevelDescription( "logLevel = 1", "Set UMFPACK_PRL to 1" ); appendLogLevelDescription( "logLevel >= 1 and incorrect final relative residual norm", "Warning about residual reduction" ); appendLogLevelDescription( "logLevel >= 1", "Linear solver informations" ); appendLogLevelDescription( "logLevel >= 1 and incorrect SuperLU residual reduction", "Warning about residual reduction" ); - appendLogLevelDescription( "logLevel >= 1 and SuperLU solver", "Information about superLU result" ); + appendLogLevelDescription( "logLevel >= 1 and SuperLU solver", "Information on result" ); appendLogLevelDescription( "logLevel >= 2 and SuperLU solver", "Print the statistics." ); - appendLogLevelDescription( "logLevel >= 1 and SuperLU", "Print SuperLU_Dist environment parameters and options" ); - appendLogLevelDescription( "logLevel >= 1 and HypreSolver", "Information about MGR preconditioner" ); - appendLogLevelDescription( "logLevel == 2 or logLevel == 4 and HypreSolver", "Print amg solution info" ); - appendLogLevelDescription( "logLevel >= 1 and HyprePreconditioner setup not existing", "Error about HyprePreconditioner setup failed" ); - appendLogLevelDescription( "logLevel >= 3 and Hypre", "Print Hypre iterations info" ); + appendLogLevelDescription( "logLevel >= 1 and SuperLU solver", "Print the blocking parameters and options setting" ); + appendLogLevelDescription( "logLevel >= 1 and HypreSolver", "Set print level for mgr solver" ); + appendLogLevelDescription( "logLevel >= 1 and HypreSolver", "Information on MGR preconditioner" ); + appendLogLevelDescription( "logLevel == 2 or logLevel == 4 and HypreSolver", "Set print level for BoomerAMG" ); + appendLogLevelDescription( "logLevel >= 1 and HyprePreconditioner setup not existing", "Indicate arror" ); appendLogLevelDescription( "logLevel >= 3 and Hypre", "Print convergence + iteration info" ); - appendLogLevelDescription( "logLevel >= 3 and PetscSolver ", "Informations about the PetscSolver result" ); - appendLogLevelDescription( "logLevel >= 1 and PetscSolver ", "Sets an ADDITIONAL function to be called at every iteration to monitor the residual/error etc" ); + appendLogLevelDescription( "logLevel >= 1 and Hypre", "Print results" ); + appendLogLevelDescription( "logLevel >= 3 and PetscSolver ", "Informations on PetscSolver result" ); + appendLogLevelDescription( "logLevel >= 1 and PetscSolver ", "Print the residual/error" ); appendLogLevelDescription( "logLevel == 1 and TrilinosSover ", "Sets SetAztecOption to AZ_summary" ); appendLogLevelDescription( "logLevel == 2 and TrilinosSover ", "Sets SetAztecOption to AZ_all" ); appendLogLevelDescription( "logLevel >= 3 and TrilinosSover ", "Sets SetAztecOption to AZ_none" ); appendLogLevelDescription( "logLevel >= 2 and KrylovSolver ", "Print residual norms" ); - appendLogLevelDescription( "logLevel >= 2 and KrylovSolver ", "Print the result success with nb iterations and solve time" ); + appendLogLevelDescription( "logLevel >= 2 and KrylovSolver ", "Print the results" ); appendLogLevelDescription( "logLevel >= 2 and value too close to zero. ", "Information about exit solver iteration" ); } From 0c32b521a6c9ae6460bfb1d59b47bc39653903bd Mon Sep 17 00:00:00 2001 From: arng40 Date: Fri, 24 May 2024 15:51:12 +0200 Subject: [PATCH 13/18] log message correction --- src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp | 2 +- .../fluid/multifluid/reactive/ReactiveBrineFluid.cpp | 2 +- .../fluid/multifluid/reactive/ReactiveFluidDriver.cpp | 2 +- .../constitutive/relativePermeability/RelpermDriver.cpp | 2 +- src/coreComponents/constitutive/solid/TriaxialDriver.cpp | 2 +- src/coreComponents/mesh/MeshManager.cpp | 2 +- src/coreComponents/mesh/generators/WellGeneratorBase.cpp | 2 +- src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp | 2 +- src/coreComponents/physicsSolvers/LinearSolverParameters.cpp | 2 +- src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp | 2 +- src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp | 2 +- .../fluidFlow/CompositionalMultiphaseHybridFVM.cpp | 2 +- .../fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp | 2 +- .../fluidFlow/wells/CompositionalMultiphaseWell.cpp | 2 +- .../physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index 8a307c229fe..3822bfdc2e1 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -90,7 +90,7 @@ PVTDriver::PVTDriver( const string & name, setDescription( "Baseline file" ); appendLogLevelDescription( "logLevel >= 1", "Informations about PVT Driver" ); - appendLogLevelDescription( "logLevel >= 1", "Indicate at the end if the internal results are consistent" ); + appendLogLevelDescription( "logLevel >= 1", "Indicate consistency of results" ); } void PVTDriver::postProcessInput() diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 33cef792d08..869e54085f3 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -80,7 +80,7 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevelDescription( "logLevel >= 1", "Infos about phase PVT Table" ); + appendLogLevelDescription( "logLevel >= 1", "Information on phase PVT Table" ); } template< typename PHASE > diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index e6334e481e5..e1aba8f59fb 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -65,7 +65,7 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription( "logLevel >= 1", "Infos about ReactiveFluidDriver" ); + appendLogLevelDescription( "logLevel >= 1", "Information on ReactiveFluidDriver" ); appendLogLevelDescription( "logLevel >= 1", "Indicate at the end if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index f2db0ab3324..4dfa3fd5426 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -51,7 +51,7 @@ RelpermDriver::RelpermDriver( const geos::string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription( "logLevel >= 1", "Infos about RelpermDriver" ); + appendLogLevelDescription( "logLevel >= 1", "Information on RelpermDriver" ); appendLogLevelDescription( "logLevel >= 1", "Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index 7cc46e74091..1cdc8f7294f 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -66,7 +66,7 @@ TriaxialDriver::TriaxialDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription( "logLevel >= 1", "Infos about TriaxialDriver" ); + appendLogLevelDescription( "logLevel >= 1", "Information on TriaxialDriver" ); appendLogLevelDescription( "logLevel >= 1", "Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index 1389bc02148..9d3650740ac 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -37,7 +37,7 @@ MeshManager::MeshManager( string const & name, setInputFlags( InputFlags::REQUIRED ); - appendLogLevelDescription( "logLevel >= 1", "Infos about imported field name on region/subRegion" ); + appendLogLevelDescription( "logLevel >= 1", "Information on imported field name on region/subRegion" ); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index 5cf6e07e32f..5e196ae99c6 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -73,7 +73,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); - appendLogLevelDescription( "logLevel >= 1", "Infos about Internal wells and their perforations" ); + appendLogLevelDescription( "logLevel >= 1", "Information on Internal wells and their perforations" ); } Group * WellGeneratorBase::createChild( string const & childKey, string const & childName ) diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 898d99513cb..7a7955d04f3 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -42,7 +42,7 @@ Rectangle::Rectangle( const string & name, Group * const parent ): setDescription( "Tolerance to determine if a point sits on the plane or not. " "It is relative to the maximum dimension of the plane." ); - appendLogLevelDescription( "logLevel >= 2", "Infos about length and width of the bounded plane" ); + appendLogLevelDescription( "logLevel >= 2", "Information on length and width of the bounded plane" ); m_points.resize( 4, 3 ); } diff --git a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp index 9195e796c10..ffc46795f7b 100644 --- a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp @@ -200,7 +200,7 @@ LinearSolverParametersInput::LinearSolverParametersInput( string const & name, appendLogLevelDescription( "logLevel >= 2", "Print information about symbolic and numeric factorization." ); appendLogLevelDescription( "logLevel >= 2", "Set UMFPACK_PRL to 6" ); - appendLogLevelDescription( "logLevel = 1", "Set UMFPACK_PRL to 1" ); + appendLogLevelDescription( "logLevel == 1", "Set UMFPACK_PRL to 1" ); appendLogLevelDescription( "logLevel >= 1 and incorrect final relative residual norm", "Warning about residual reduction" ); appendLogLevelDescription( "logLevel >= 1", "Linear solver informations" ); appendLogLevelDescription( "logLevel >= 1 and incorrect SuperLU residual reduction", "Warning about residual reduction" ); diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index 70ad52ee54e..bb7e6e80931 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -167,7 +167,7 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); - appendLogLevelDescription( "logLevel >= 1", "Infos about NonLinearSolver parameters" ); + appendLogLevelDescription( "logLevel >= 1", "Information on NonLinearSolver parameters" ); } diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index 321be680ca6..32d70c2ab65 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -50,7 +50,7 @@ ContactSolverBase::ContactSolverBase( const string & name, this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); - appendLogLevelDescription( "logLevel >= 1", "Infos about number of elements for each fracture states" ); + appendLogLevelDescription( "logLevel >= 1", "Information on number of elements for each fracture states" ); } void ContactSolverBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp index be31088277f..f040a51259a 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,7 +49,7 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { - appendLogLevelDescription( "logLevel >= 1", "Infos on the residual values" ); + appendLogLevelDescription( "logLevel >= 1", "Print the residual values" ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::compositionalMultiphaseHybridFVM; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index a1f634d57a0..8f764e27993 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -116,7 +116,7 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setDescription( "List of fluid phases" ); appendLogLevelDescription( "logLevel >= 1", "Print the residuals values" ); - //appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Infos about the source flux boundary conditions" ); + //appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Information on the source flux boundary conditions" ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 66a4c8c719e..44ef7a4de11 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -106,7 +106,7 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, appendLogLevelDescription( "logLevel >= 1", "Output well rates to a simple csv file" ); appendLogLevelDescription( "logLevel >= 2", "Infos on the BHP pressure" ); appendLogLevelDescription( "logLevel >= 2", "Infos on the surface density" ); - appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" ); + appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Information on the phase and total density in the reference element" ); } void CompositionalMultiphaseWell::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index 36167dcb5fa..f9b81ead2f6 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -50,7 +50,7 @@ SinglePhaseWell::SinglePhaseWell( const string & name, appendLogLevelDescription( "logLevel >= 1", "Output well rates to a simple csv file" ); appendLogLevelDescription( "logLevel >= 2", "Infos on BHP pressure" ); appendLogLevelDescription( "logLevel >= 2", "Infos on surface density" ); - appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Infos about the phase and total density in the reference element" ); + appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Information on the phase and total density in the reference element" ); m_numDofPerWellElement = 2; m_numDofPerResElement = 1; From ed7a285d19fa8bf3ff611e27e88852dca7ff1917 Mon Sep 17 00:00:00 2001 From: arng40 Date: Mon, 27 May 2024 09:36:45 +0200 Subject: [PATCH 14/18] doc corrections --- src/coreComponents/mesh/generators/VTKMeshGenerator.cpp | 1 - src/coreComponents/physicsSolvers/SolverBase.cpp | 5 ++--- .../solidMechanics/SolidMechanicsStateReset.cpp | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index 0cc5ee683e4..03f2b46d618 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -77,7 +77,6 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, appendLogLevelDescription( "logLevel >= 1", "Information on cell block names" ); appendLogLevelDescription( "logLevel >= 2", "Information on node sets names" ); - appendLogLevelDescription( "logLevel >= 2", "Information on node sets names" ); appendLogLevelDescription( "logLevel >= 2", "Print the mesh generation step" ); } diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index a77b1fe2c36..ac0dfd9fe0f 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -88,13 +88,12 @@ SolverBase::SolverBase( string const & name, appendLogLevelDescription( "logLevel >= 1", "Information on line search" ); appendLogLevelDescription( "logLevel >= 1", "Information on global solution scaling factor" ); - appendLogLevelDescription( "logLevel >= 1", "Output the timestep" ); + appendLogLevelDescription( "logLevel >= 1", "Information on the timestep" ); appendLogLevelDescription( "logLevel >= 2", "Output to screen the assembled linear system and solutions (matrices and vectors)" ); appendLogLevelDescription( "logLevel >= 3", "Output to file the assembled linear system and solutions (matrices and vectors)" ); - appendLogLevelDescription( "logLevel >= 1", "Information on time-step based on stateChange" ); appendLogLevelDescription( "logLevel >= 1 and incorrect solution", "Information about line search failed" ); appendLogLevelDescription( "logLevel >= 1", "Print residual norm" ); - appendLogLevelDescription( "logLevel >= 1 and configuration didn't converge", "Information about testing new configuration and print the new step" ); + appendLogLevelDescription( "logLevel >= 1 and configuration didn't converge", "Information about testing new configuration and print the time step" ); appendLogLevelDescription( "logLevel >= 1 and non linear system", "Information on each newton Iteration " ); appendLogLevelDescription( "logLevel >= 1 and linear system", "Information on number of iterations and residual reduction" ); appendLogLevelDescription( "logLevel >= 1 and residual norm above the max allowed residual norm", "Indicate allowed residual norm" ); diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp index 73a696ed7d4..0ea5a0ad5fb 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp @@ -51,7 +51,7 @@ SolidMechanicsStateReset::SolidMechanicsStateReset( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to enable/disable inelastic behavior" ); - appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Information about physics solver duringtask" ); + appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Information about physics solver during task" ); appendLogLevelDescription( "logLevel >= 2", "Information about solid model during task" ); } From c3cdc0d2047184c5ab8933324b4740320d4e6ad0 Mon Sep 17 00:00:00 2001 From: arng40 Date: Wed, 19 Jun 2024 17:06:31 +0200 Subject: [PATCH 15/18] rst added --- .../schema/docs/AcousticElasticSEM.rst | 56 +- .../schema/docs/AcousticFirstOrderSEM.rst | 87 +- .../schema/docs/AcousticSEM.rst | 88 +- .../schema/docs/AcousticVTISEM.rst | 87 +- src/coreComponents/schema/docs/Aquifer.rst | 10 +- .../schema/docs/CO2BrineEzrokhiFluid.rst | 32 +- .../docs/CO2BrineEzrokhiThermalFluid.rst | 32 +- .../schema/docs/CO2BrinePhillipsFluid.rst | 32 +- .../docs/CO2BrinePhillipsThermalFluid.rst | 32 +- src/coreComponents/schema/docs/ChomboIO.rst | 28 +- .../docs/CompositionalMultiphaseFVM.rst | 142 +- .../docs/CompositionalMultiphaseHybridFVM.rst | 109 +- .../docs/CompositionalMultiphaseReservoir.rst | 55 +- ...tionalMultiphaseReservoirPoromechanics.rst | 73 +- ...seReservoirPoromechanicsInitialization.rst | 20 +- .../CompositionalMultiphaseStatistics.rst | 33 +- .../docs/CompositionalMultiphaseWell.rst | 82 +- src/coreComponents/schema/docs/Dirichlet.rst | 42 +- .../schema/docs/ElasticFirstOrderSEM.rst | 87 +- src/coreComponents/schema/docs/ElasticSEM.rst | 93 +- .../schema/docs/EmbeddedSurfaceGenerator.rst | 60 +- src/coreComponents/schema/docs/Events.rst | 28 +- .../schema/docs/FieldSpecification.rst | 42 +- .../schema/docs/FlowProppantTransport.rst | 59 +- src/coreComponents/schema/docs/HaltEvent.rst | 38 +- .../schema/docs/Hydrofracture.rst | 71 +- .../schema/docs/HydrostaticEquilibrium.rst | 52 +- .../schema/docs/InternalWell.rst | 34 +- src/coreComponents/schema/docs/LaplaceFEM.rst | 60 +- .../schema/docs/LinearSolverParameters.rst | 122 +- src/coreComponents/schema/docs/Mesh.rst | 24 +- .../schema/docs/MultiphasePoromechanics.rst | 73 +- .../MultiphasePoromechanicsInitialization.rst | 20 +- .../docs/MultiphasePoromechanicsReservoir.rst | 55 +- .../schema/docs/NonlinearSolverParameters.rst | 6 +- src/coreComponents/schema/docs/PML.rst | 52 +- src/coreComponents/schema/docs/PVTDriver.rst | 36 +- .../schema/docs/PeriodicEvent.rst | 52 +- .../schema/docs/PhaseFieldDamageFEM.rst | 69 +- .../schema/docs/PhaseFieldFracture.rst | 58 +- .../schema/docs/ProppantTransport.rst | 83 +- .../schema/docs/ReactiveBrine.rst | 28 +- .../schema/docs/ReactiveBrineThermal.rst | 28 +- .../ReactiveCompositionalMultiphaseOBL.rst | 93 +- .../schema/docs/ReactiveFluidDriver.rst | 34 +- src/coreComponents/schema/docs/Rectangle.rst | 30 +- .../schema/docs/RelpermDriver.rst | 28 +- .../schema/docs/SeismicityRate.rst | 52 +- .../schema/docs/SinglePhaseFVM.rst | 67 +- .../schema/docs/SinglePhaseHybridFVM.rst | 83 +- .../schema/docs/SinglePhasePoromechanics.rst | 60 +- ...ePhasePoromechanicsConformingFractures.rst | 57 +- ...glePhasePoromechanicsEmbeddedFractures.rst | 60 +- ...SinglePhasePoromechanicsInitialization.rst | 20 +- .../SinglePhasePoromechanicsReservoir.rst | 58 +- .../schema/docs/SinglePhaseProppantFVM.rst | 67 +- .../schema/docs/SinglePhaseReservoir.rst | 58 +- .../SinglePhaseReservoirPoromechanics.rst | 60 +- ...seReservoirPoromechanicsInitialization.rst | 20 +- .../schema/docs/SinglePhaseStatistics.rst | 24 +- .../schema/docs/SinglePhaseWell.rst | 72 +- .../docs/SolidMechanicsEmbeddedFractures.rst | 80 +- .../docs/SolidMechanicsLagrangeContact.rst | 82 +- .../docs/SolidMechanicsLagrangianSSLE.rst | 88 +- .../schema/docs/SolidMechanicsStateReset.rst | 24 +- .../schema/docs/SolidMechanicsStatistics.rst | 24 +- .../docs/SolidMechanics_LagrangianFEM.rst | 88 +- .../schema/docs/SolidMechanics_MPM.rst | 102 +- src/coreComponents/schema/docs/SoloEvent.rst | 42 +- src/coreComponents/schema/docs/SourceFlux.rst | 46 +- .../schema/docs/SurfaceGenerator.rst | 75 +- src/coreComponents/schema/docs/Traction.rst | 48 +- .../schema/docs/TriaxialDriver.rst | 36 +- src/coreComponents/schema/docs/VTK.rst | 2 - src/coreComponents/schema/docs/VTKMesh.rst | 15 +- src/coreComponents/schema/docs/VTKWell.rst | 36 +- .../schema/docs/WellControls.rst | 4 +- src/coreComponents/schema/schema.xsd | 1625 ++++++++++++----- 78 files changed, 3551 insertions(+), 2179 deletions(-) diff --git a/src/coreComponents/schema/docs/AcousticElasticSEM.rst b/src/coreComponents/schema/docs/AcousticElasticSEM.rst index 8ff2a68dc11..9b3de635d99 100644 --- a/src/coreComponents/schema/docs/AcousticElasticSEM.rst +++ b/src/coreComponents/schema/docs/AcousticElasticSEM.rst @@ -1,26 +1,38 @@ -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -acousticSolverName groupNameRef required Name of the acoustic solver used by the coupled solver -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -elasticSolverName groupNameRef required Name of the elastic solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +Name Type Default Description +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +acousticSolverName groupNameRef required Name of the acoustic solver used by the coupled solver +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +elasticSolverName groupNameRef required Name of the elastic solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst index 1ca8ddb6e7b..34c3bd7b9de 100644 --- a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst @@ -1,41 +1,54 @@ -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/AcousticSEM.rst b/src/coreComponents/schema/docs/AcousticSEM.rst index 1ca8ddb6e7b..9fa66005d69 100644 --- a/src/coreComponents/schema/docs/AcousticSEM.rst +++ b/src/coreComponents/schema/docs/AcousticSEM.rst @@ -1,41 +1,55 @@ -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | - Print PML parameters + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/AcousticVTISEM.rst b/src/coreComponents/schema/docs/AcousticVTISEM.rst index 1ca8ddb6e7b..34c3bd7b9de 100644 --- a/src/coreComponents/schema/docs/AcousticVTISEM.rst +++ b/src/coreComponents/schema/docs/AcousticVTISEM.rst @@ -1,41 +1,54 @@ -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/Aquifer.rst b/src/coreComponents/schema/docs/Aquifer.rst index c23befdd3c7..a8a97af2ad9 100644 --- a/src/coreComponents/schema/docs/Aquifer.rst +++ b/src/coreComponents/schema/docs/Aquifer.rst @@ -27,8 +27,16 @@ direction R1Tensor {0,0,0} Direction to appl endTime real64 1e+99 Time at which the boundary condition will stop being applied. functionName groupNameRef Name of function that specifies variation of the boundary condition. initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on boundary conditions + | logLevel >= 1 and first nonlinear iteration + | - Information on the face boundary condition defined with pressure and temperature + | logLevel >= 1 and regions with no dof + | - Warning about non simulated region + | logLevel >= 1 first nonlinear iteration + | - Print boundary conditions log messages name groupName required A name is required for any non-unique nodes pressureInfluenceFunctionName groupNameRef | Name of the table describing the pressure influence function | . If not provided, we use a default pressure influence function diff --git a/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst b/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst index 56cbe6beff2..269464937be 100644 --- a/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid.rst @@ -1,20 +1,20 @@ -==================== ================== ======== ============================================================================================================================================================================================= -Name Type Default Description -==================== ================== ======== ============================================================================================================================================================================================= -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display PVT phase table -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================================================================================================= +==================== ================== ======== ================================================================================================================================================================================================================ +Name Type Default Description +==================== ================== ======== ================================================================================================================================================================================================================ +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Informations on PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst b/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst index 56cbe6beff2..269464937be 100644 --- a/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid.rst @@ -1,20 +1,20 @@ -==================== ================== ======== ============================================================================================================================================================================================= -Name Type Default Description -==================== ================== ======== ============================================================================================================================================================================================= -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display PVT phase table -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================================================================================================= +==================== ================== ======== ================================================================================================================================================================================================================ +Name Type Default Description +==================== ================== ======== ================================================================================================================================================================================================================ +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Informations on PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst b/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst index 56cbe6beff2..269464937be 100644 --- a/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrinePhillipsFluid.rst @@ -1,20 +1,20 @@ -==================== ================== ======== ============================================================================================================================================================================================= -Name Type Default Description -==================== ================== ======== ============================================================================================================================================================================================= -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display PVT phase table -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================================================================================================= +==================== ================== ======== ================================================================================================================================================================================================================ +Name Type Default Description +==================== ================== ======== ================================================================================================================================================================================================================ +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Informations on PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst b/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst index 56cbe6beff2..269464937be 100644 --- a/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst +++ b/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid.rst @@ -1,20 +1,20 @@ -==================== ================== ======== ============================================================================================================================================================================================= -Name Type Default Description -==================== ================== ======== ============================================================================================================================================================================================= -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -flashModelParaFile path Name of the file defining the parameters of the flash model -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display PVT phase table -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -solubilityTableNames string_array {} Names of solubility tables for each phase -==================== ================== ======== ============================================================================================================================================================================================= +==================== ================== ======== ================================================================================================================================================================================================================ +Name Type Default Description +==================== ================== ======== ================================================================================================================================================================================================================ +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +flashModelParaFile path Name of the file defining the parameters of the flash model +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Informations on PVT phase table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +solubilityTableNames string_array {} Names of solubility tables for each phase +==================== ================== ======== ================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/ChomboIO.rst b/src/coreComponents/schema/docs/ChomboIO.rst index 300787a76c2..8e866ef6e57 100644 --- a/src/coreComponents/schema/docs/ChomboIO.rst +++ b/src/coreComponents/schema/docs/ChomboIO.rst @@ -1,16 +1,20 @@ -================== ========= =================== =============================================================================================== -Name Type Default Description -================== ========= =================== =============================================================================================== -beginCycle real64 required Cycle at which the coupling will commence. -childDirectory string Child directory path -inputPath string /INVALID_INPUT_PATH Path at which the chombo to geosx file will be written. -name groupName required A name is required for any non-unique nodes -outputPath string required Path at which the geosx to chombo file will be written. -parallelThreads integer 1 Number of plot files. -useChomboPressures integer 0 True iff geosx should use the pressures chombo writes out. -waitForInput integer required True iff geosx should wait for chombo to write out a file. When true the inputPath must be set. -================== ========= =================== =============================================================================================== +================== ========= =================== ============================================================================================================================================================================================================= +Name Type Default Description +================== ========= =================== ============================================================================================================================================================================================================= +beginCycle real64 required Cycle at which the coupling will commence. +childDirectory string Child directory path +inputPath string /INVALID_INPUT_PATH Path at which the chombo to geosx file will be written. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel == 1 + | - Indicate chombo initializing +name groupName required A name is required for any non-unique nodes +outputPath string required Path at which the geosx to chombo file will be written. +parallelThreads integer 1 Number of plot files. +useChomboPressures integer 0 True iff geosx should use the pressures chombo writes out. +waitForInput integer required True iff geosx should wait for chombo to write out a file. When true the inputPath must be set. +================== ========= =================== ============================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst index ba45cce4388..8e1db83c332 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst @@ -1,64 +1,86 @@ -========================================= =========================================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================================= =========================================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used -continuationDBC integer 1 Flag for enabling continuation parameter -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 1 : - | - Display the boundary conditions - | 1 and first nonlinear iteration : - | - Display the residuals values - | 1 : - | - Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects - | 1 : - | - Display the residual values - | - | 1: and non first nonlinear iteration - | - Display face boundary conditions log -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility -name groupName required A name is required for any non-unique nodes -omegaDBC real64 1 Factor by which DBC flux is multiplied -scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: - | * Global - | * Local -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useDBC integer 0 Enable Dissipation-based continuation flux -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= =========================================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used +continuationDBC integer 1 Flag for enabling continuation parameter +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | - Information about pressure, phase, temperature during time step + | - Information on density during outer iteration + | - Information on volume frations + | - Information on CFL number + | - Print the residual values + | - Information about max pressure/max component density change + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and negative density + | - Information on negative density values + | logLevel >= 1 and negative pressure + | - Information on negative pressure values + | logLevel >= 1 and non first nonlinear iteration + | - Information on the face boundary conditions log + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 1 and scaling type is local + | - Print scaling factors + | logLevel >= 1 and thermal simulation + | - Information on max relative temperature + | - Information about temperature changes + | logLevel >= 1 and total density > 0 + | - Information on total density values + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility +name groupName required A name is required for any non-unique nodes +omegaDBC real64 1 Factor by which DBC flux is multiplied +scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: + | * Global + | * Local +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useDBC integer 0 Enable Dissipation-based continuation flux +useMass integer 0 Use mass formulation instead of molar +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst index 8f2e1a23f37..8303e68b3a8 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst @@ -1,52 +1,65 @@ -========================================= ================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================================= ================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 1 : - | - Display the boundary conditions - | 1 and first nonlinear iteration : - | - Display the residuals values - | 1 : - | - Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects - | 1 : - | - Display the residual values -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -name groupName required A name is required for any non-unique nodes -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= ================== ======== =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | - Information about pressure, phase, temperature during time step + | - Information on density during outer iteration + | - Information on volume frations + | - Information on CFL number + | - Print the residual values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 1 and thermal simulation + | - Information on max relative temperature + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +name groupName required A name is required for any non-unique nodes +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useMass integer 0 Use mass formulation instead of molar +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst index ab6df335a34..7b540496fe9 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst @@ -1,20 +1,43 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 and if the well is injector and crossflow enbled: - | Display warnings about crossflow for injectors -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -wellSolverName groupNameRef required Name of the well solver used by the coupled solver -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and if the well is injector and crossflow enabled + | - Warnings about crossflow for injectors + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst index 0c3f259254a..e6895f5228c 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst @@ -1,32 +1,49 @@ -=========================== ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -=========================== ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. -stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -=========================== ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | - Print phase volume fraction + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: + | None - Add no stabilization to mass equation, + | Global - Add stabilization to all faces, + | Local - Add stabilization only to interiors of macro elements. +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst index 7fae6d809b6..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst @@ -1,13 +1,15 @@ -=========================== ============ ======== ============================================================================================================================================================= -Name Type Default Description -=========================== ============ ======== ============================================================================================================================================================= -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ============================================================================================================================================================= +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst index e09bd239254..a1e565dfbe6 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst @@ -1,16 +1,25 @@ -======================= ============ ======== =============================================================================================================================================================== -Name Type Default Description -======================= ============ ======== =============================================================================================================================================================== -computeCFLNumbers integer 0 Flag to decide whether CFL numbers are computed or not -computeRegionStatistics integer 1 Flag to decide whether region statistics are computed or not -flowSolverName groupNameRef required Name of the flow solver -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -relpermThreshold real64 1e-06 Flag to decide whether a phase is considered mobile (when the relperm is above the threshold) or immobile (when the relperm is below the threshold) in metric 2 -writeCSV integer 0 Write statistics into a CSV file -======================= ============ ======== =============================================================================================================================================================== +======================= ============ ======== =================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +======================= ============ ======== =================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +computeCFLNumbers integer 0 Flag to decide whether CFL numbers are computed or not +computeRegionStatistics integer 1 Flag to decide whether region statistics are computed or not +flowSolverName groupNameRef required Name of the flow solver +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel == 1 + | - Dipslay Indicative message + | logLevel == 1 and pore volume is zero + | - Display warning message + | logLevel >= 1 + | - Information on the regions statistics + | - Information on CFL numbers + | logLevel >= 1 and pore volume equal 0 + | - Warning on the impossibility to compute pressure +name groupName required A name is required for any non-unique nodes +relpermThreshold real64 1e-06 Flag to decide whether a phase is considered mobile (when the relperm is above the threshold) or immobile (when the relperm is below the threshold) in metric 2 +writeCSV integer 0 Write statistics into a CSV file +======================= ============ ======== =================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst index ef01c30f7e8..94dbc6be1d9 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst @@ -1,42 +1,48 @@ -============================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 0 : - | - Display the residuals norm values - | - | 1 : - | - Output well rates to a simple csv file - | - | 2 : - | - Display the BHP pressure - | - Display the surface density - | - | 2 and use surface conditions: - | - Display phase and total density in the reference element -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations -maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -useMass integer 0 Use total mass equation -writeCSV integer 0 Write rates into a CSV file -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -WellControls node :ref:`XML_WellControls` -============================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Infos on residual values + | - Output well rates to a simple csv file + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on the BHP pressure + | - Infos on the surface density + | logLevel >= 2 and use surface conditions + | - Information on the phase and total density in the reference element + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations +maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +useMass integer 0 Use total mass equation +writeCSV integer 0 Write rates into a CSV file +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +WellControls node :ref:`XML_WellControls` +============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Dirichlet.rst b/src/coreComponents/schema/docs/Dirichlet.rst index 86abc981fdd..260b86169b7 100644 --- a/src/coreComponents/schema/docs/Dirichlet.rst +++ b/src/coreComponents/schema/docs/Dirichlet.rst @@ -1,22 +1,28 @@ -====================== ================== ======== ============================================================================================================================================================= -Name Type Default Description -====================== ================== ======== ============================================================================================================================================================= -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -fieldName groupNameRef Name of field that boundary condition is applied to. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ============================================================================================================================================================= +====================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +====================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +fieldName groupNameRef Name of field that boundary condition is applied to. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialCondition integer 0 Boundary condition is applied as an initial condition. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 and first nonlinear iteration + | - Information on the face boundary condition defined with pressure and temperature + | logLevel >= 1 and regions with no dof + | - Warning about non simulated region + | logLevel >= 1 first nonlinear iteration + | - Print boundary conditions log messages +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +====================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst index 1ca8ddb6e7b..34c3bd7b9de 100644 --- a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst @@ -1,41 +1,54 @@ -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ElasticSEM.rst b/src/coreComponents/schema/docs/ElasticSEM.rst index 2843908756e..b385d767058 100644 --- a/src/coreComponents/schema/docs/ElasticSEM.rst +++ b/src/coreComponents/schema/docs/ElasticSEM.rst @@ -1,44 +1,57 @@ -========================= ============================ ============= ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ============= ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). -sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -useVTI integer 0 Flag to apply VTI anisotropy. The default is to use isotropic physic. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ============= ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). +sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference +useVTI integer 0 Flag to apply VTI anisotropy. The default is to use isotropic physic. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst index 0a85cfc597e..bb9959443c2 100644 --- a/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst +++ b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst @@ -1,27 +1,41 @@ -========================= ================== ============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fractureRegion groupNameRef FractureRegion (no description available) -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering -name groupName required A name is required for any non-unique nodes -targetObjects groupNameRef_array required List of geometric objects that will be used to initialized the embedded surfaces/fractures. -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fractureRegion groupNameRef FractureRegion (no description available) +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print number of embedded surface elements + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Print each cell index element fractured + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering +name groupName required A name is required for any non-unique nodes +targetObjects groupNameRef_array required List of geometric objects that will be used to initialized the embedded surfaces/fractures. +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Events.rst b/src/coreComponents/schema/docs/Events.rst index c7cd27fb469..edf1c9286b6 100644 --- a/src/coreComponents/schema/docs/Events.rst +++ b/src/coreComponents/schema/docs/Events.rst @@ -1,17 +1,19 @@ -================ ================================== ============ ============================================================================================================================================================= -Name Type Default Description -================ ================================== ============ ============================================================================================================================================================= -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. -maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. -minTime real64 0 Start simulation time for the global event loop. -timeOutputFormat geos_EventManager_TimeOutputFormat seconds Format of the time in the GEOS log. -HaltEvent node :ref:`XML_HaltEvent` -PeriodicEvent node :ref:`XML_PeriodicEvent` -SoloEvent node :ref:`XML_SoloEvent` -================ ================================== ============ ============================================================================================================================================================= +================ ================================== ============ ==================================================================================================================================================================================================================== +Name Type Default Description +================ ================================== ============ ==================================================================================================================================================================================================================== +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about current sub-event +maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. +maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. +minTime real64 0 Start simulation time for the global event loop. +timeOutputFormat geos_EventManager_TimeOutputFormat seconds Format of the time in the GEOS log. +HaltEvent node :ref:`XML_HaltEvent` +PeriodicEvent node :ref:`XML_PeriodicEvent` +SoloEvent node :ref:`XML_SoloEvent` +================ ================================== ============ ==================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/FieldSpecification.rst b/src/coreComponents/schema/docs/FieldSpecification.rst index 86abc981fdd..260b86169b7 100644 --- a/src/coreComponents/schema/docs/FieldSpecification.rst +++ b/src/coreComponents/schema/docs/FieldSpecification.rst @@ -1,22 +1,28 @@ -====================== ================== ======== ============================================================================================================================================================= -Name Type Default Description -====================== ================== ======== ============================================================================================================================================================= -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -fieldName groupNameRef Name of field that boundary condition is applied to. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ============================================================================================================================================================= +====================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +====================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +fieldName groupNameRef Name of field that boundary condition is applied to. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialCondition integer 0 Boundary condition is applied as an initial condition. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 and first nonlinear iteration + | - Information on the face boundary condition defined with pressure and temperature + | logLevel >= 1 and regions with no dof + | - Warning about non simulated region + | logLevel >= 1 first nonlinear iteration + | - Print boundary conditions log messages +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +====================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/FlowProppantTransport.rst b/src/coreComponents/schema/docs/FlowProppantTransport.rst index 4d90536762c..be8c4b259e4 100644 --- a/src/coreComponents/schema/docs/FlowProppantTransport.rst +++ b/src/coreComponents/schema/docs/FlowProppantTransport.rst @@ -1,25 +1,42 @@ -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -proppantSolverName groupNameRef required Name of the proppant solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | - Informations about convergance and iterations + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +proppantSolverName groupNameRef required Name of the proppant solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/HaltEvent.rst b/src/coreComponents/schema/docs/HaltEvent.rst index d62af56a529..8b020024353 100644 --- a/src/coreComponents/schema/docs/HaltEvent.rst +++ b/src/coreComponents/schema/docs/HaltEvent.rst @@ -1,22 +1,24 @@ -==================== ============ ======== ============================================================================================================================================================= -Name Type Default Description -==================== ============ ======== ============================================================================================================================================================= -beginTime real64 0 Start time of this event. -endTime real64 1e+100 End time of this event. -finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. -forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). -maxRuntime real64 required The maximum allowable runtime for the job. -name groupName required A name is required for any non-unique nodes -target groupNameRef Name of the object to be executed when the event criteria are met. -targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. -HaltEvent node :ref:`XML_HaltEvent` -PeriodicEvent node :ref:`XML_PeriodicEvent` -SoloEvent node :ref:`XML_SoloEvent` -==================== ============ ======== ============================================================================================================================================================= +==================== ============ ======== ============================================================================================================================================================================================================ +Name Type Default Description +==================== ============ ======== ============================================================================================================================================================================================================ +beginTime real64 0 Start time of this event. +endTime real64 1e+100 End time of this event. +finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. +forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about sub-event +maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). +maxRuntime real64 required The maximum allowable runtime for the job. +name groupName required A name is required for any non-unique nodes +target groupNameRef Name of the object to be executed when the event criteria are met. +targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. +HaltEvent node :ref:`XML_HaltEvent` +PeriodicEvent node :ref:`XML_PeriodicEvent` +SoloEvent node :ref:`XML_SoloEvent` +==================== ============ ======== ============================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/Hydrofracture.rst b/src/coreComponents/schema/docs/Hydrofracture.rst index 72b144f36c2..1105baae110 100644 --- a/src/coreComponents/schema/docs/Hydrofracture.rst +++ b/src/coreComponents/schema/docs/Hydrofracture.rst @@ -1,28 +1,51 @@ -============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactRelationName groupNameRef required Name of contact relation to enforce constraints on fracture boundary. -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isMatrixPoroelastic integer 0 (no description available) -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display whether or not we Re-entering Newton Solve - | -maxNumResolves integer 10 Value to indicate how many resolves may be executed to perform surface generation after the execution of flow and mechanics solver. -name groupName required A name is required for any non-unique nodes -newFractureInitializationType geos_HydrofractureSolver >_InitializationType Pressure Type of new fracture element initialization. Can be Pressure or Displacement. -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -surfaceGeneratorName groupNameRef required Name of the surface generator to use in the hydrofracture solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -useQuasiNewton integer 0 (no description available) -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================== +============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactRelationName groupNameRef required Name of contact relation to enforce constraints on fracture boundary. +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isMatrixPoroelastic integer 0 (no description available) +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | - Output whether or not we Re-entering Newton Solve + | - Information on aperture and hydraulic aperture + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) + | - Print time stepping +maxNumResolves integer 10 Value to indicate how many resolves may be executed to perform surface generation after the execution of flow and mechanics solver. +name groupName required A name is required for any non-unique nodes +newFractureInitializationType geos_HydrofractureSolver >_InitializationType Pressure Type of new fracture element initialization. Can be Pressure or Displacement. +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +surfaceGeneratorName groupNameRef required Name of the surface generator to use in the hydrofracture solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +useQuasiNewton integer 0 (no description available) +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst b/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst index 4b4abbb2c73..9e0204e0ddb 100644 --- a/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst +++ b/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst @@ -1,27 +1,33 @@ -============================================ ================== ======== ============================================================================================================================================================= -Name Type Default Description -============================================ ================== ======== ============================================================================================================================================================= -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -componentFractionVsElevationTableNames groupNameRef_array {} Names of the tables specifying the (component fraction vs elevation) relationship for each component -componentNames string_array {} Names of the fluid components -datumElevation real64 required Datum elevation [m] -datumPressure real64 required Datum pressure [Pa] -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -elevationIncrementInHydrostaticPressureTable real64 0.6096 Elevation increment [m] in the hydrostatic pressure table constructed internally -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -equilibrationTolerance real64 0.001 Tolerance in the fixed-point iteration scheme used for hydrostatic initialization -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialPhaseName groupNameRef Name of the phase initially saturating the reservoir -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -maxNumberOfEquilibrationIterations integer 5 Maximum number of equilibration iterations -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -temperatureVsElevationTableName groupNameRef Name of the table specifying the (temperature [K] vs elevation) relationship -============================================ ================== ======== ============================================================================================================================================================= +============================================ ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================================ ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +componentFractionVsElevationTableNames groupNameRef_array {} Names of the tables specifying the (component fraction vs elevation) relationship for each component +componentNames string_array {} Names of the fluid components +datumElevation real64 required Datum elevation [m] +datumPressure real64 required Datum pressure [Pa] +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +elevationIncrementInHydrostaticPressureTable real64 0.6096 Elevation increment [m] in the hydrostatic pressure table constructed internally +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +equilibrationTolerance real64 0.001 Tolerance in the fixed-point iteration scheme used for hydrostatic initialization +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialPhaseName groupNameRef Name of the phase initially saturating the reservoir +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 and first nonlinear iteration + | - Information on the face boundary condition defined with pressure and temperature + | logLevel >= 1 and regions with no dof + | - Warning about non simulated region + | logLevel >= 1 first nonlinear iteration + | - Print boundary conditions log messages +maxNumberOfEquilibrationIterations integer 5 Maximum number of equilibration iterations +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +temperatureVsElevationTableName groupNameRef Name of the table specifying the (temperature [K] vs elevation) relationship +============================================ ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/InternalWell.rst b/src/coreComponents/schema/docs/InternalWell.rst index 8b37a5409bf..f23d8057442 100644 --- a/src/coreComponents/schema/docs/InternalWell.rst +++ b/src/coreComponents/schema/docs/InternalWell.rst @@ -1,20 +1,22 @@ -===================== =================== ======== ============================================================================================================================================================= -Name Type Default Description -===================== =================== ======== ============================================================================================================================================================= -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] -minSegmentLength real64 0.01 Minimum length of a well segment [m] -name groupName required A name is required for any non-unique nodes -numElementsPerSegment integer required Number of well elements per polyline segment -polylineNodeCoords real64_array2d required Physical coordinates of the well polyline nodes -polylineSegmentConn globalIndex_array2d required Connectivity of the polyline segments -radius real64 required Radius of the well [m] -wellControlsName string required Name of the set of constraints associated with this well -wellRegionName string required Name of the well element region -Perforation node :ref:`XML_Perforation` -===================== =================== ======== ============================================================================================================================================================= +===================== =================== ======== ===================================================================================================================================================================================================================================== +Name Type Default Description +===================== =================== ======== ===================================================================================================================================================================================================================================== +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on Internal wells and their perforations +minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] +minSegmentLength real64 0.01 Minimum length of a well segment [m] +name groupName required A name is required for any non-unique nodes +numElementsPerSegment integer required Number of well elements per polyline segment +polylineNodeCoords real64_array2d required Physical coordinates of the well polyline nodes +polylineSegmentConn globalIndex_array2d required Connectivity of the polyline segments +radius real64 required Radius of the well [m] +wellControlsName string required Name of the set of constraints associated with this well +wellRegionName string required Name of the well element region +Perforation node :ref:`XML_Perforation` +===================== =================== ======== ===================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/LaplaceFEM.rst b/src/coreComponents/schema/docs/LaplaceFEM.rst index bc04a0493f9..73c2c973b56 100644 --- a/src/coreComponents/schema/docs/LaplaceFEM.rst +++ b/src/coreComponents/schema/docs/LaplaceFEM.rst @@ -1,28 +1,40 @@ -========================= ======================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ======================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fieldName groupNameRef required Name of field variable -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_LaplaceBaseH1_TimeIntegrationOption required | Time integration method. Options are: - | * SteadyState - | * ImplicitTransient -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ======================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ======================================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +Name Type Default Description +========================= ======================================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fieldName groupNameRef required Name of field variable +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_LaplaceBaseH1_TimeIntegrationOption required | Time integration method. Options are: + | * SteadyState + | * ImplicitTransient +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ======================================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/LinearSolverParameters.rst b/src/coreComponents/schema/docs/LinearSolverParameters.rst index 0486315e51a..15ee7731950 100644 --- a/src/coreComponents/schema/docs/LinearSolverParameters.rst +++ b/src/coreComponents/schema/docs/LinearSolverParameters.rst @@ -1,44 +1,86 @@ -============================= ============================================== ============= ======================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -============================= ============================================== ============= ======================================================================================================================================================================================================================================================================================================================= -amgAggressiveCoarseningLevels integer 0 AMG number of levels for aggressive coarsening -amgAggressiveCoarseningPaths integer 1 AMG number of paths for aggressive coarsening -amgAggressiveInterpType geos_LinearSolverParameters_AMG_AggInterpType multipass AMG aggressive interpolation algorithm. Available options are: ``default\|extendedIStage2\|standardStage2\|extendedStage2\|multipass\|modifiedExtended\|modifiedExtendedI\|modifiedExtendedE\|modifiedMultipass`` -amgCoarseSolver geos_LinearSolverParameters_AMG_CoarseType direct AMG coarsest level solver/smoother type. Available options are: ``default\|jacobi\|l1jacobi\|fgs\|sgs\|l1sgs\|chebyshev\|direct\|bgs`` -amgCoarseningType geos_LinearSolverParameters_AMG_CoarseningType HMIS AMG coarsening algorithm. Available options are: ``default\|CLJP\|RugeStueben\|Falgout\|PMIS\|HMIS`` -amgInterpolationMaxNonZeros integer 4 AMG interpolation maximum number of nonzeros per row -amgInterpolationType geos_LinearSolverParameters_AMG_InterpType extendedI AMG interpolation algorithm. Available options are: ``default\|modifiedClassical\|direct\|multipass\|extendedI\|standard\|extended\|directBAMG\|modifiedExtended\|modifiedExtendedI\|modifiedExtendedE`` -amgNullSpaceType geos_LinearSolverParameters_AMG_NullSpaceType constantModes AMG near null space approximation. Available options are:``constantModes\|rigidBodyModes`` -amgNumFunctions integer 1 AMG number of functions -amgNumSweeps integer 1 AMG smoother sweeps -amgRelaxWeight real64 1 AMG relaxation factor for the smoother -amgSeparateComponents integer 0 AMG apply separate component filter for multi-variable problems -amgSmootherType geos_LinearSolverParameters_AMG_SmootherType l1sgs AMG smoother type. Available options are: ``default\|jacobi\|l1jacobi\|fgs\|bgs\|sgs\|l1sgs\|chebyshev\|ilu0\|ilut\|ic0\|ict`` -amgThreshold real64 0 AMG strength-of-connection threshold -directCheckResidual integer 0 Whether to check the linear system solution residual -directColPerm geos_LinearSolverParameters_Direct_ColPerm metis How to permute the columns. Available options are: ``none\|MMD_AtplusA\|MMD_AtA\|colAMD\|metis\|parmetis`` -directEquil integer 1 Whether to scale the rows and columns of the matrix -directIterRef integer 1 Whether to perform iterative refinement -directParallel integer 1 Whether to use a parallel solver (instead of a serial one) -directReplTinyPivot integer 1 Whether to replace tiny pivots by sqrt(epsilon)*norm(A) -directRowPerm geos_LinearSolverParameters_Direct_RowPerm mc64 How to permute the rows. Available options are: ``none\|mc64`` -iluFill integer 0 ILU(K) fill factor -iluThreshold real64 0 ILU(T) threshold factor -krylovAdaptiveTol integer 0 Use Eisenstat-Walker adaptive linear tolerance -krylovMaxIter integer 200 Maximum iterations allowed for an iterative solver -krylovMaxRestart integer 200 Maximum iterations before restart (GMRES only) -krylovTol real64 1e-06 | Relative convergence tolerance of the iterative method - | If the method converges, the iterative solution :math:`\mathsf{x}_k` is such that - | the relative residual norm satisfies: - | :math:`\left\lVert \mathsf{b} - \mathsf{A} \mathsf{x}_k \right\rVert_2` < ``krylovTol`` * :math:`\left\lVert\mathsf{b}\right\rVert_2` -krylovWeakestTol real64 0.001 Weakest-allowed tolerance for adaptive method -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -preconditionerType geos_LinearSolverParameters_PreconditionerType iluk Preconditioner type. Available options are: ``none\|jacobi\|l1jacobi\|fgs\|sgs\|l1sgs\|chebyshev\|iluk\|ilut\|icc\|ict\|amg\|mgr\|block\|direct\|bgs`` -solverType geos_LinearSolverParameters_SolverType direct Linear solver type. Available options are: ``direct\|cg\|gmres\|fgmres\|bicgstab\|preconditioner`` -stopIfError integer 1 Whether to stop the simulation if the linear solver reports an error -============================= ============================================== ============= ======================================================================================================================================================================================================================================================================================================================= +============================= ============================================== ============= ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================= ============================================== ============= ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +amgAggressiveCoarseningLevels integer 0 AMG number of levels for aggressive coarsening +amgAggressiveCoarseningPaths integer 1 AMG number of paths for aggressive coarsening +amgAggressiveInterpType geos_LinearSolverParameters_AMG_AggInterpType multipass AMG aggressive interpolation algorithm. Available options are: ``default\|extendedIStage2\|standardStage2\|extendedStage2\|multipass\|modifiedExtended\|modifiedExtendedI\|modifiedExtendedE\|modifiedMultipass`` +amgCoarseSolver geos_LinearSolverParameters_AMG_CoarseType direct AMG coarsest level solver/smoother type. Available options are: ``default\|jacobi\|l1jacobi\|fgs\|sgs\|l1sgs\|chebyshev\|direct\|bgs`` +amgCoarseningType geos_LinearSolverParameters_AMG_CoarseningType HMIS AMG coarsening algorithm. Available options are: ``default\|CLJP\|RugeStueben\|Falgout\|PMIS\|HMIS`` +amgInterpolationMaxNonZeros integer 4 AMG interpolation maximum number of nonzeros per row +amgInterpolationType geos_LinearSolverParameters_AMG_InterpType extendedI AMG interpolation algorithm. Available options are: ``default\|modifiedClassical\|direct\|multipass\|extendedI\|standard\|extended\|directBAMG\|modifiedExtended\|modifiedExtendedI\|modifiedExtendedE`` +amgNullSpaceType geos_LinearSolverParameters_AMG_NullSpaceType constantModes AMG near null space approximation. Available options are:``constantModes\|rigidBodyModes`` +amgNumFunctions integer 1 AMG number of functions +amgNumSweeps integer 1 AMG smoother sweeps +amgRelaxWeight real64 1 AMG relaxation factor for the smoother +amgSeparateComponents integer 0 AMG apply separate component filter for multi-variable problems +amgSmootherType geos_LinearSolverParameters_AMG_SmootherType l1sgs AMG smoother type. Available options are: ``default\|jacobi\|l1jacobi\|fgs\|bgs\|sgs\|l1sgs\|chebyshev\|ilu0\|ilut\|ic0\|ict`` +amgThreshold real64 0 AMG strength-of-connection threshold +directCheckResidual integer 0 Whether to check the linear system solution residual +directColPerm geos_LinearSolverParameters_Direct_ColPerm metis How to permute the columns. Available options are: ``none\|MMD_AtplusA\|MMD_AtA\|colAMD\|metis\|parmetis`` +directEquil integer 1 Whether to scale the rows and columns of the matrix +directIterRef integer 1 Whether to perform iterative refinement +directParallel integer 1 Whether to use a parallel solver (instead of a serial one) +directReplTinyPivot integer 1 Whether to replace tiny pivots by sqrt(epsilon)*norm(A) +directRowPerm geos_LinearSolverParameters_Direct_RowPerm mc64 How to permute the rows. Available options are: ``none\|mc64`` +iluFill integer 0 ILU(K) fill factor +iluThreshold real64 0 ILU(T) threshold factor +krylovAdaptiveTol integer 0 Use Eisenstat-Walker adaptive linear tolerance +krylovMaxIter integer 200 Maximum iterations allowed for an iterative solver +krylovMaxRestart integer 200 Maximum iterations before restart (GMRES only) +krylovTol real64 1e-06 | Relative convergence tolerance of the iterative method + | If the method converges, the iterative solution :math:`\mathsf{x}_k` is such that + | the relative residual norm satisfies: + | :math:`\left\lVert \mathsf{b} - \mathsf{A} \mathsf{x}_k \right\rVert_2` < ``krylovTol`` * :math:`\left\lVert\mathsf{b}\right\rVert_2` +krylovWeakestTol real64 0.001 Weakest-allowed tolerance for adaptive method +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel == 1 + | - Set UMFPACK_PRL to 1 + | logLevel == 1 and TrilinosSover + | - Sets SetAztecOption to AZ_summary + | logLevel == 2 and TrilinosSover + | - Sets SetAztecOption to AZ_all + | logLevel == 2 or logLevel == 4 and HypreSolver + | - Set print level for BoomerAMG + | logLevel >= 1 + | - Linear solver informations + | logLevel >= 1 and Hypre + | - Print results + | logLevel >= 1 and HyprePreconditioner setup not existing + | - Indicate arror + | logLevel >= 1 and HypreSolver + | - Set print level for mgr solver + | - Information on MGR preconditioner + | logLevel >= 1 and PetscSolver + | - Print the residual/error + | logLevel >= 1 and SuperLU solver + | - Information on result + | - Print the blocking parameters and options setting + | logLevel >= 1 and incorrect SuperLU residual reduction + | - Warning about residual reduction + | logLevel >= 1 and incorrect final relative residual norm + | - Warning about residual reduction + | logLevel >= 2 + | - Print information about symbolic and numeric factorization. + | - Set UMFPACK_PRL to 6 + | logLevel >= 2 and KrylovSolver + | - Print residual norms + | - Print the results + | logLevel >= 2 and SuperLU solver + | - Print the statistics. + | logLevel >= 2 and value too close to zero. + | - Information about exit solver iteration + | logLevel >= 3 and Hypre + | - Print convergence + iteration info + | logLevel >= 3 and PetscSolver + | - Informations on PetscSolver result + | logLevel >= 3 and TrilinosSover + | - Sets SetAztecOption to AZ_none +preconditionerType geos_LinearSolverParameters_PreconditionerType iluk Preconditioner type. Available options are: ``none\|jacobi\|l1jacobi\|fgs\|sgs\|l1sgs\|chebyshev\|iluk\|ilut\|icc\|ict\|amg\|mgr\|block\|direct\|bgs`` +solverType geos_LinearSolverParameters_SolverType direct Linear solver type. Available options are: ``direct\|cg\|gmres\|fgmres\|bicgstab\|preconditioner`` +stopIfError integer 1 Whether to stop the simulation if the linear solver reports an error +============================= ============================================== ============= ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Mesh.rst b/src/coreComponents/schema/docs/Mesh.rst index daca929392e..22773cd454e 100644 --- a/src/coreComponents/schema/docs/Mesh.rst +++ b/src/coreComponents/schema/docs/Mesh.rst @@ -1,16 +1,16 @@ -================ ======= ======= ======================================================================================================================================================================================================================================== -Name Type Default Description -================ ======= ======= ======================================================================================================================================================================================================================================== -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display informations about imported field name on region/subRegion -InternalMesh node :ref:`XML_InternalMesh` -InternalWellbore node :ref:`XML_InternalWellbore` -ParticleMesh node :ref:`XML_ParticleMesh` -VTKMesh node :ref:`XML_VTKMesh` -================ ======= ======= ======================================================================================================================================================================================================================================== +================ ======= ======= ======================================================================================================================================================================================================================================= +Name Type Default Description +================ ======= ======= ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on imported field name on region/subRegion +InternalMesh node :ref:`XML_InternalMesh` +InternalWellbore node :ref:`XML_InternalWellbore` +ParticleMesh node :ref:`XML_ParticleMesh` +VTKMesh node :ref:`XML_VTKMesh` +================ ======= ======= ======================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst index 3b5b8eb2631..8028a317831 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst @@ -1,32 +1,49 @@ -========================= ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. -stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ==================================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | - Print phase volume fraction + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: + | None - Add no stabilization to mass equation, + | Global - Add stabilization to all faces, + | Local - Add stabilization only to interiors of macro elements. +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst b/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst index 7fae6d809b6..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst @@ -1,13 +1,15 @@ -=========================== ============ ======== ============================================================================================================================================================= -Name Type Default Description -=========================== ============ ======== ============================================================================================================================================================= -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ============================================================================================================================================================= +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst index 3f3f25116f9..07859d72a8b 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst @@ -1,20 +1,43 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 and if the well is injector and crossflow enbled: - | Display warnings about crossflow for injectors -name groupName required A name is required for any non-unique nodes -poromechanicsSolverName groupNameRef required Name of the poromechanics solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -wellSolverName groupNameRef required Name of the well solver used by the coupled solver -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and if the well is injector and crossflow enabled + | - Warnings about crossflow for injectors + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/NonlinearSolverParameters.rst b/src/coreComponents/schema/docs/NonlinearSolverParameters.rst index c3cd4144e45..163375038a2 100644 --- a/src/coreComponents/schema/docs/NonlinearSolverParameters.rst +++ b/src/coreComponents/schema/docs/NonlinearSolverParameters.rst @@ -18,10 +18,10 @@ lineSearchInterpolationType geos_NonlinearSolverParameters_LineSearchInterpol lineSearchMaxCuts integer 4 Maximum number of line search cuts. lineSearchResidualFactor real64 1 Factor to determine residual increase (recommended values: 1.1 (conservative), 2.0 (relaxed), 10.0 (aggressive)). lineSearchStartingIteration integer 0 Iteration when line search starts. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display informations about NonLinearSolver parameters + | logLevel >= 1 + | - Information on NonLinearSolver parameters maxAllowedResidualNorm real64 1e+09 Maximum value of residual norm that is allowed in a Newton loop maxNumConfigurationAttempts integer 10 Max number of times that the configuration can be changed maxSubSteps integer 10 Maximum number of time sub-steps allowed for the solver diff --git a/src/coreComponents/schema/docs/PML.rst b/src/coreComponents/schema/docs/PML.rst index ca9c41cfb6d..c6876deef6a 100644 --- a/src/coreComponents/schema/docs/PML.rst +++ b/src/coreComponents/schema/docs/PML.rst @@ -1,27 +1,33 @@ -====================== ================== ======================================== ============================================================================================================================================================= -Name Type Default Description -====================== ================== ======================================== ============================================================================================================================================================= -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -reflectivity real32 0.001 Desired reflectivity of the PML region, used to compute the damping profile -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -thicknessMaxXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at right, back, and bottom sides, used to compute the damping profile -thicknessMinXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at left, front, and top sides, used to compute the damping profile -waveSpeedMaxXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at right, back, and bottom sides, used to compute the damping profile -waveSpeedMinXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at left, front, and top sides, used to compute the damping profile -xMax R1Tensor32 {3.40282e+38,3.40282e+38,3.40282e+38} Maximum (x,y,z) coordinates of the inner PML boundaries -xMin R1Tensor32 {-3.40282e+38,-3.40282e+38,-3.40282e+38} Minimum (x,y,z) coordinates of the inner PML boundaries -====================== ================== ======================================== ============================================================================================================================================================= +====================== ================== ======================================== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +====================== ================== ======================================== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 and first nonlinear iteration + | - Information on the face boundary condition defined with pressure and temperature + | logLevel >= 1 and regions with no dof + | - Warning about non simulated region + | logLevel >= 1 first nonlinear iteration + | - Print boundary conditions log messages +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +reflectivity real32 0.001 Desired reflectivity of the PML region, used to compute the damping profile +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +thicknessMaxXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at right, back, and bottom sides, used to compute the damping profile +thicknessMinXYZ R1Tensor32 {-1,-1,-1} Thickness of the PML region, at left, front, and top sides, used to compute the damping profile +waveSpeedMaxXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at right, back, and bottom sides, used to compute the damping profile +waveSpeedMinXYZ R1Tensor32 {-1,-1,-1} Wave speed in the PML, at left, front, and top sides, used to compute the damping profile +xMax R1Tensor32 {3.40282e+38,3.40282e+38,3.40282e+38} Maximum (x,y,z) coordinates of the inner PML boundaries +xMin R1Tensor32 {-3.40282e+38,-3.40282e+38,-3.40282e+38} Minimum (x,y,z) coordinates of the inner PML boundaries +====================== ================== ======================================== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/PVTDriver.rst b/src/coreComponents/schema/docs/PVTDriver.rst index 9196c73c11a..6f5a4715ac0 100644 --- a/src/coreComponents/schema/docs/PVTDriver.rst +++ b/src/coreComponents/schema/docs/PVTDriver.rst @@ -1,20 +1,24 @@ -====================== ============ ======== ===================================================================== -Name Type Default Description -====================== ============ ======== ===================================================================== -baseline path none Baseline file -feedComposition real64_array required Feed composition array [mol fraction] -fluid groupNameRef required Fluid to test -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -output string none Output file -outputCompressibility integer 0 Flag to indicate that the total compressibility should be output -outputMassDensity integer 0 Flag to indicate that the mass density of each phase should be output -outputPhaseComposition integer 0 Flag to indicate that phase compositions should be output -pressureControl groupNameRef required Function controlling pressure time history -steps integer required Number of load steps to take -temperatureControl groupNameRef required Function controlling temperature time history -====================== ============ ======== ===================================================================== +====================== ============ ======== ================================================================================================================================================================================================================================================== +Name Type Default Description +====================== ============ ======== ================================================================================================================================================================================================================================================== +baseline path none Baseline file +feedComposition real64_array required Feed composition array [mol fraction] +fluid groupNameRef required Fluid to test +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Informations about PVT Driver + | - Indicate consistency of results +name groupName required A name is required for any non-unique nodes +output string none Output file +outputCompressibility integer 0 Flag to indicate that the total compressibility should be output +outputMassDensity integer 0 Flag to indicate that the mass density of each phase should be output +outputPhaseComposition integer 0 Flag to indicate that phase compositions should be output +pressureControl groupNameRef required Function controlling pressure time history +steps integer required Number of load steps to take +temperatureControl groupNameRef required Function controlling temperature time history +====================== ============ ======== ================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/PeriodicEvent.rst b/src/coreComponents/schema/docs/PeriodicEvent.rst index ecf3561ddd9..69f6896e2d9 100644 --- a/src/coreComponents/schema/docs/PeriodicEvent.rst +++ b/src/coreComponents/schema/docs/PeriodicEvent.rst @@ -1,29 +1,31 @@ -==================== ============ ======== ================================================================================================================================================================================= -Name Type Default Description -==================== ============ ======== ================================================================================================================================================================================= -beginTime real64 0 Start time of this event. -cycleFrequency integer 1 Event application frequency (cycle, default) -endTime real64 1e+100 End time of this event. -finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. -forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). -function groupNameRef Name of an optional function to evaluate when the time/cycle criteria are met.If the result is greater than the specified eventThreshold, the function will continue to execute. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). -name groupName required A name is required for any non-unique nodes -object groupNameRef If the optional function requires an object as an input, specify its path here. -set groupNameRef If the optional function is applied to an object, specify the setname to evaluate (default = everything). -stat integer 0 If the optional function is applied to an object, specify the statistic to compare to the eventThreshold.The current options include: min, avg, and max. -target groupNameRef Name of the object to be executed when the event criteria are met. -targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. -targetExactTimestep integer 1 If this option is set, the event will reduce its timestep requests to match the specified timeFrequency perfectly: dt_request = min(dt_request, t_last + time_frequency - time)). -threshold real64 0 If the optional function is used, the event will execute if the value returned by the function exceeds this threshold. -timeFrequency real64 -1 Event application frequency (time). Note: if this value is specified, it will override any cycle-based behavior. -HaltEvent node :ref:`XML_HaltEvent` -PeriodicEvent node :ref:`XML_PeriodicEvent` -SoloEvent node :ref:`XML_SoloEvent` -==================== ============ ======== ================================================================================================================================================================================= +==================== ============ ======== ============================================================================================================================================================================================================ +Name Type Default Description +==================== ============ ======== ============================================================================================================================================================================================================ +beginTime real64 0 Start time of this event. +cycleFrequency integer 1 Event application frequency (cycle, default) +endTime real64 1e+100 End time of this event. +finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. +forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). +function groupNameRef Name of an optional function to evaluate when the time/cycle criteria are met.If the result is greater than the specified eventThreshold, the function will continue to execute. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about sub-event +maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). +name groupName required A name is required for any non-unique nodes +object groupNameRef If the optional function requires an object as an input, specify its path here. +set groupNameRef If the optional function is applied to an object, specify the setname to evaluate (default = everything). +stat integer 0 If the optional function is applied to an object, specify the statistic to compare to the eventThreshold.The current options include: min, avg, and max. +target groupNameRef Name of the object to be executed when the event criteria are met. +targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. +targetExactTimestep integer 1 If this option is set, the event will reduce its timestep requests to match the specified timeFrequency perfectly: dt_request = min(dt_request, t_last + time_frequency - time)). +threshold real64 0 If the optional function is used, the event will execute if the value returned by the function exceeds this threshold. +timeFrequency real64 -1 Event application frequency (time). Note: if this value is specified, it will override any cycle-based behavior. +HaltEvent node :ref:`XML_HaltEvent` +PeriodicEvent node :ref:`XML_PeriodicEvent` +SoloEvent node :ref:`XML_SoloEvent` +==================== ============ ======== ============================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst b/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst index b605130f3b2..1120325f8ca 100644 --- a/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst +++ b/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst @@ -1,34 +1,43 @@ -========================= ============================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -damageUpperBound real64 1.5 The upper bound of the damage -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fieldName groupNameRef required name of field variable -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -irreversibilityFlag integer 0 The flag to indicate whether to apply the irreversibility constraint -localDissipation geos_PhaseFieldDamageFEM_LocalDissipation required Type of local dissipation function. Can be Linear or Quadratic -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 2 : - | - Display the jacobian matrix - | - | 2 : - | - Display the residuals values -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_PhaseFieldDamageFEM_TimeIntegrationOption required option for default time integration method -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ============================================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ============================================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +damageUpperBound real64 1.5 The upper bound of the damage +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fieldName groupNameRef required name of field variable +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +irreversibilityFlag integer 0 The flag to indicate whether to apply the irreversibility constraint +localDissipation geos_PhaseFieldDamageFEM_LocalDissipation required Type of local dissipation function. Can be Linear or Quadratic +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Output the jacobian matrix + | - Output the residuals values + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_PhaseFieldDamageFEM_TimeIntegrationOption required option for default time integration method +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ============================================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/PhaseFieldFracture.rst b/src/coreComponents/schema/docs/PhaseFieldFracture.rst index 0bd35ae5eec..12082b10238 100644 --- a/src/coreComponents/schema/docs/PhaseFieldFracture.rst +++ b/src/coreComponents/schema/docs/PhaseFieldFracture.rst @@ -1,25 +1,41 @@ -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -damageSolverName groupNameRef required Name of the damage solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +damageSolverName groupNameRef required Name of the damage solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ProppantTransport.rst b/src/coreComponents/schema/docs/ProppantTransport.rst index 4dc9b15c718..4c05cf8b0b4 100644 --- a/src/coreComponents/schema/docs/ProppantTransport.rst +++ b/src/coreComponents/schema/docs/ProppantTransport.rst @@ -1,41 +1,50 @@ -============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -bridgingFactor real64 0 Bridging factor used for bridging/screen-out calculation -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -criticalShieldsNumber real64 0 Critical Shields number -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -frictionCoefficient real64 0.03 Friction coefficient -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 1 : - | - Display the boundary conditions - | 1 : - | - Display the residuals norm values - | -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxProppantConcentration real64 0.6 Maximum proppant concentration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -proppantDensity real64 2500 Proppant density -proppantDiameter real64 0.0004 Proppant diameter -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -updateProppantPacking integer 0 Flag that enables/disables proppant-packing update -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +bridgingFactor real64 0 Bridging factor used for bridging/screen-out calculation +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +criticalShieldsNumber real64 0 Critical Shields number +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +frictionCoefficient real64 0.03 Friction coefficient +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Infos on residual norm values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxProppantConcentration real64 0.6 Maximum proppant concentration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +proppantDensity real64 2500 Proppant density +proppantDiameter real64 0.0004 Proppant diameter +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +updateProppantPacking integer 0 Flag that enables/disables proppant-packing update +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ReactiveBrine.rst b/src/coreComponents/schema/docs/ReactiveBrine.rst index d31e604d12b..38e344376bb 100644 --- a/src/coreComponents/schema/docs/ReactiveBrine.rst +++ b/src/coreComponents/schema/docs/ReactiveBrine.rst @@ -1,18 +1,18 @@ -==================== ================== ======== ============================================================================================================================================================================================= -Name Type Default Description -==================== ================== ======== ============================================================================================================================================================================================= -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display phase PVT Table -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -==================== ================== ======== ============================================================================================================================================================================================= +==================== ================== ======== =============================================================================================================================================================================================================== +Name Type Default Description +==================== ================== ======== =============================================================================================================================================================================================================== +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on phase PVT Table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +==================== ================== ======== =============================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ReactiveBrineThermal.rst b/src/coreComponents/schema/docs/ReactiveBrineThermal.rst index d31e604d12b..38e344376bb 100644 --- a/src/coreComponents/schema/docs/ReactiveBrineThermal.rst +++ b/src/coreComponents/schema/docs/ReactiveBrineThermal.rst @@ -1,18 +1,18 @@ -==================== ================== ======== ============================================================================================================================================================================================= -Name Type Default Description -==================== ================== ======== ============================================================================================================================================================================================= -checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. -componentMolarWeight real64_array {0} Component molar weights -componentNames string_array {} List of component names -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display phase PVT Table -name groupName required A name is required for any non-unique nodes -phaseNames groupNameRef_array {} List of fluid phases -phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models -==================== ================== ======== ============================================================================================================================================================================================= +==================== ================== ======== =============================================================================================================================================================================================================== +Name Type Default Description +==================== ================== ======== =============================================================================================================================================================================================================== +checkPVTTablesRanges integer 1 Enable (1) or disable (0) an error when the input pressure or temperature of the PVT tables is out of range. +componentMolarWeight real64_array {0} Component molar weights +componentNames string_array {} List of component names +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on phase PVT Table +name groupName required A name is required for any non-unique nodes +phaseNames groupNameRef_array {} List of fluid phases +phasePVTParaFiles path_array required Names of the files defining the parameters of the viscosity and density models +==================== ================== ======== =============================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst b/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst index cfd5f6bc402..a444f68c5c2 100644 --- a/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst +++ b/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst @@ -1,48 +1,53 @@ -============================== ================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -OBLOperatorsTableFile path required File containing OBL operator values -allowLocalOBLChopping integer 1 Allow keeping solution within OBL limits -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -componentNames string_array {} List of component names -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -enableEnergyBalance integer required Enable energy balance calculation and temperature degree of freedom -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 1 : - | - Display the boundary conditions - | 1 and first nonlinear iteration : - | - Display the source flux boundary conditions - | - Display the Dirichlet pressure boundary conditions - | - Display the Dirichlet temperature boundary conditions - | - | 1 : - | - Display the residuals values -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -numComponents integer required Number of components -numPhases integer required Number of phases -phaseNames groupNameRef_array {} List of fluid phases -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -transMultExp real64 1 Exponent of dynamic transmissibility multiplier -useDARTSL2Norm integer 1 Use L2 norm calculation similar to one used DARTS -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== =========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +OBLOperatorsTableFile path required File containing OBL operator values +allowLocalOBLChopping integer 1 Allow keeping solution within OBL limits +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +componentNames string_array {} List of component names +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +enableEnergyBalance integer required Enable energy balance calculation and temperature degree of freedom +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Print the residuals values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +numComponents integer required Number of components +numPhases integer required Number of phases +phaseNames groupNameRef_array {} List of fluid phases +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +transMultExp real64 1 Exponent of dynamic transmissibility multiplier +useDARTSL2Norm integer 1 Use L2 norm calculation similar to one used DARTS +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ReactiveFluidDriver.rst b/src/coreComponents/schema/docs/ReactiveFluidDriver.rst index b2f8296b046..fb258581b62 100644 --- a/src/coreComponents/schema/docs/ReactiveFluidDriver.rst +++ b/src/coreComponents/schema/docs/ReactiveFluidDriver.rst @@ -1,21 +1,21 @@ -================== ============ ======== ================================================================================================================================================================================================================================================================================ -Name Type Default Description -================== ============ ======== ================================================================================================================================================================================================================================================================================ -baseline path none Baseline file -feedComposition real64_array required Feed composition array: total concentration of the primary species -fluid groupNameRef required Fluid to test -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Print informations about ReactiveFluidDriver - | - Indicate at the end if the internal results are consistent -name groupName required A name is required for any non-unique nodes -output string none Output file -pressureControl groupNameRef required Function controlling pressure time history -steps integer required Number of load steps to take -temperatureControl groupNameRef required Function controlling temperature time history -================== ============ ======== ================================================================================================================================================================================================================================================================================ +================== ============ ======== ================================================================================================================================================================================================================================================================================== +Name Type Default Description +================== ============ ======== ================================================================================================================================================================================================================================================================================== +baseline path none Baseline file +feedComposition real64_array required Feed composition array: total concentration of the primary species +fluid groupNameRef required Fluid to test +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on ReactiveFluidDriver + | - Indicate at the end if the internal results are consistent +name groupName required A name is required for any non-unique nodes +output string none Output file +pressureControl groupNameRef required Function controlling pressure time history +steps integer required Number of load steps to take +temperatureControl groupNameRef required Function controlling temperature time history +================== ============ ======== ================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Rectangle.rst b/src/coreComponents/schema/docs/Rectangle.rst index f27ef28a511..bcbb485e9e8 100644 --- a/src/coreComponents/schema/docs/Rectangle.rst +++ b/src/coreComponents/schema/docs/Rectangle.rst @@ -1,19 +1,19 @@ -============ ============ ======== ====================================================================================================================================================================================================================================== -Name Type Default Description -============ ============ ======== ====================================================================================================================================================================================================================================== -dimensions real64_array required Length and width of the bounded plane -lengthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 2 : - | - Display informations about length and width of the bounded plane -name groupName required A name is required for any non-unique nodes -normal R1Tensor required Normal (n_x,n_y,n_z) to the plane (will be normalized automatically) -origin R1Tensor required Origin point (x,y,z) of the plane (basically, any point on the plane) -tolerance real64 1e-05 Tolerance to determine if a point sits on the plane or not. It is relative to the maximum dimension of the plane. -widthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. -============ ============ ======== ====================================================================================================================================================================================================================================== +============ ============ ======== ===================================================================================================================================================================================================================================== +Name Type Default Description +============ ============ ======== ===================================================================================================================================================================================================================================== +dimensions real64_array required Length and width of the bounded plane +lengthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 2 + | - Information on length and width of the bounded plane +name groupName required A name is required for any non-unique nodes +normal R1Tensor required Normal (n_x,n_y,n_z) to the plane (will be normalized automatically) +origin R1Tensor required Origin point (x,y,z) of the plane (basically, any point on the plane) +tolerance real64 1e-05 Tolerance to determine if a point sits on the plane or not. It is relative to the maximum dimension of the plane. +widthVector R1Tensor required Tangent vector defining the orthonormal basis along with the normal. +============ ============ ======== ===================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/RelpermDriver.rst b/src/coreComponents/schema/docs/RelpermDriver.rst index 43705b99755..5a3f0ac7e8b 100644 --- a/src/coreComponents/schema/docs/RelpermDriver.rst +++ b/src/coreComponents/schema/docs/RelpermDriver.rst @@ -1,18 +1,18 @@ -======== ============ ======== ====================================================================================================================================================================================================================================================================== -Name Type Default Description -======== ============ ======== ====================================================================================================================================================================================================================================================================== -baseline path none Baseline file -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Print informations about ReactiveFluidDriver - | - Indicate if the internal results are consistent -name groupName required A name is required for any non-unique nodes -output string none Output file -relperm groupNameRef required Relperm model to test -steps integer required Number of saturation steps to take -======== ============ ======== ====================================================================================================================================================================================================================================================================== +======== ============ ======== ================================================================================================================================================================================================================================================================= +Name Type Default Description +======== ============ ======== ================================================================================================================================================================================================================================================================= +baseline path none Baseline file +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on RelpermDriver + | - Indicate if the internal results are consistent +name groupName required A name is required for any non-unique nodes +output string none Output file +relperm groupNameRef required Relperm model to test +steps integer required Number of saturation steps to take +======== ============ ======== ================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SeismicityRate.rst b/src/coreComponents/schema/docs/SeismicityRate.rst index 492a69e75e2..b3faababf73 100644 --- a/src/coreComponents/schema/docs/SeismicityRate.rst +++ b/src/coreComponents/schema/docs/SeismicityRate.rst @@ -1,20 +1,40 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -backgroundStressingRate real64 required Background stressing rate -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -directEffect real64 required Rate-and-state friction direct effect parameter -faultNormalDirection R1Tensor {0,0,0} Fault normal direction -faultShearDirection R1Tensor {0,0,0} Fault shear direction -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -stressSolverName string Name of solver for computing stress -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +Name Type Default Description +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +backgroundStressingRate real64 required Background stressing rate +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +directEffect real64 required Rate-and-state friction direct effect parameter +faultNormalDirection R1Tensor {0,0,0} Fault normal direction +faultShearDirection R1Tensor {0,0,0} Fault shear direction +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +stressSolverName string Name of solver for computing stress +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/SinglePhaseFVM.rst b/src/coreComponents/schema/docs/SinglePhaseFVM.rst index 6379daa4deb..b5a093f8f36 100644 --- a/src/coreComponents/schema/docs/SinglePhaseFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseFVM.rst @@ -1,29 +1,46 @@ -============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display the residual values - | - | 1 and first nonlinear iterations : - | - Display the face boundary condition defined with pressure - | - Display the face boundary condition defined with temperature -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +Name Type Default Description +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Print pressure change + | - Information on negative pressure values + | - Print the residual values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst index 7e9d1db10d6..c1efd26fc4d 100644 --- a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst @@ -1,45 +1,46 @@ -============================== ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 1 : - | - Display the boundary conditions - | 1 and first nonlinear iteration : - | - Display the boundary conditions log message - | - | 1 and number of nonlinear iterations > 0 : - | - Display the boundary conditions log message - | - | 1 : - | - Display warnings about non-simulated region intersecting, that can cancel sourceFlux effects - | 1 : - | - Display the residuals values - | - | 1 : and first nonlinear iteration : - | - Display the face boundary conditions definied with pressure -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Print pressure change + | - Information on negative pressure values + | - Print the residual norm values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst index b2db7efd740..d561d6692cb 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst @@ -1,26 +1,42 @@ -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst index 7a5c65074bb..c00235f2391 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst @@ -1,22 +1,43 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 3 : - | - Display the summary of declared fields and coupling. - | -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) + | - The summary of declared fields and coupling +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst index b2db7efd740..d561d6692cb 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst @@ -1,26 +1,42 @@ -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst index 7fae6d809b6..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst @@ -1,13 +1,15 @@ -=========================== ============ ======== ============================================================================================================================================================= -Name Type Default Description -=========================== ============ ======== ============================================================================================================================================================= -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ============================================================================================================================================================= +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst index d4e4395ae2f..c58e773ecce 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst @@ -1,25 +1,41 @@ -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -poromechanicsSolverName groupNameRef required Name of the poromechanics solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -wellSolverName groupNameRef required Name of the well solver used by the coupled solver -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst index 6379daa4deb..b5a093f8f36 100644 --- a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst @@ -1,29 +1,46 @@ -============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display the residual values - | - | 1 and first nonlinear iterations : - | - Display the face boundary condition defined with pressure - | - Display the face boundary condition defined with temperature -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================== +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +Name Type Default Description +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Print pressure change + | - Information on negative pressure values + | - Print the residual values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoir.rst b/src/coreComponents/schema/docs/SinglePhaseReservoir.rst index 03ae85cf577..153978d50ce 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoir.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoir.rst @@ -1,25 +1,41 @@ -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -wellSolverName groupNameRef required Name of the well solver used by the coupled solver -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst index a60a5a925e8..870cbdbf3be 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst @@ -1,26 +1,42 @@ -=========================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -=========================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -=========================== ================== ======== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst index 7fae6d809b6..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst @@ -1,13 +1,15 @@ -=========================== ============ ======== ============================================================================================================================================================= -Name Type Default Description -=========================== ============ ======== ============================================================================================================================================================= -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -performStressInitialization integer required Flag to indicate that the solver is going to perform stress initialization -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -=========================== ============ ======== ============================================================================================================================================================= +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhaseStatistics.rst b/src/coreComponents/schema/docs/SinglePhaseStatistics.rst index 9234e338ad2..91ce4e74e4d 100644 --- a/src/coreComponents/schema/docs/SinglePhaseStatistics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseStatistics.rst @@ -1,13 +1,19 @@ -============== ============ ======== ============================================================================================================================================================= -Name Type Default Description -============== ============ ======== ============================================================================================================================================================= -flowSolverName groupNameRef required Name of the flow solver -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -writeCSV integer 0 Write statistics into a CSV file -============== ============ ======== ============================================================================================================================================================= +============== ============ ======== =================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============== ============ ======== =================================================================================================================================================================================================================================================================================================================================== +flowSolverName groupNameRef required Name of the flow solver +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel == 1 + | - Dipslay Indicative message + | logLevel == 1 and pore volume is zero + | - Display warning message + | logLevel >= 1 + | - Information on region statistics +name groupName required A name is required for any non-unique nodes +writeCSV integer 0 Write statistics into a CSV file +============== ============ ======== =================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseWell.rst b/src/coreComponents/schema/docs/SinglePhaseWell.rst index a934fd9334a..f915eedc796 100644 --- a/src/coreComponents/schema/docs/SinglePhaseWell.rst +++ b/src/coreComponents/schema/docs/SinglePhaseWell.rst @@ -1,37 +1,43 @@ -========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 0 : - | - Display the residuals norm values - | - | 1 : - | - Output well rates to a simple csv file - | - | 2 : - | - Display the BHP pressure - | - Display the surface density - | - | 2 and use surface conditions: - | - Display phase and total density in the reference element -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -writeCSV integer 0 Write rates into a CSV file -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -WellControls node :ref:`XML_WellControls` -========================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Infos on residual values + | - Output well rates to a simple csv file + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on BHP pressure + | - Infos on surface density + | logLevel >= 2 and use surface conditions + | - Information on the phase and total density in the reference element + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +writeCSV integer 0 Write rates into a CSV file +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +WellControls node :ref:`XML_WellControls` +========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst index 816f21abec1..ec7f583cf45 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst @@ -1,34 +1,54 @@ -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display informations about number of elements for each fracture states: - | 1 : - | - Display informations about residual norm for each fractures -massDamping real64 0 Value of mass based damping coefficient. -maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. -name groupName required A name is required for any non-unique nodes -newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. -newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option -stiffnessDamping real64 0 Value of stiffness based damping coefficient. -strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: - | 0 - Infinitesimal Strain - | 1 - Finite Strain -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -useStaticCondensation integer 0 Defines whether to use static condensation or not. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================== =============== ==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ====================================================== =============== ==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on number of elements for each fracture states + | - Infos on residual norm for each fractures + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on residuals values + | logLevel >= 2 and target set is empty + | - Warning about boundary conditions + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +useStaticCondensation integer 0 Defines whether to use static condensation or not. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== ==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst b/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst index b24c17cd4a5..90096899f7a 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst @@ -1,35 +1,55 @@ -=============================== ====================================================== =============== =================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -=============================== ====================================================== =============== =================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display informations about number of elements for each fracture states: - | 1 : - | - Display informations about risidual norm (Rdisplacement, Rtraction, Rtotal) -massDamping real64 0 Value of mass based damping coefficient. -maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. -name groupName required A name is required for any non-unique nodes -newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. -newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option -stabilizationName groupNameRef required Name of the stabilization to use in the lagrangian contact solver -stabilizationScalingCoefficient real64 1 It be used to increase the scale of the stabilization entries. A value < 1.0 results in larger entries in the stabilization matrix. -stiffnessDamping real64 0 Value of stiffness based damping coefficient. -strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: - | 0 - Infinitesimal Strain - | 1 - Finite Strain -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -=============================== ====================================================== =============== =================================================================================================================================================================================================================================================================================================================================== +=============================== ====================================================== =============== ==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=============================== ====================================================== =============== ==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on number of elements for each fracture states + | - Infos on risidual norm (Rdisplacement, Rtraction, Rtotal) + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on residuals values + | logLevel >= 2 and target set is empty + | - Warning about boundary conditions + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stabilizationName groupNameRef required Name of the stabilization to use in the lagrangian contact solver +stabilizationScalingCoefficient real64 1 It be used to increase the scale of the stabilization entries. A value < 1.0 results in larger entries in the stabilization matrix. +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +=============================== ====================================================== =============== ==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst b/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst index 511f50b3191..f3ecf2b759c 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst @@ -1,43 +1,53 @@ -========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 2 : - | Display a warning about boundary conditions - | - | 2 : - | Display residuals values -massDamping real64 0 Value of mass based damping coefficient. -maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. -name groupName required A name is required for any non-unique nodes -newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. -newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option -stiffnessDamping real64 0 Value of stiffness based damping coefficient. -strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: - | 0 - Infinitesimal Strain - | 1 - Finite Strain -surfaceGeneratorName string Name of the surface generator to use -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on residuals values + | logLevel >= 2 and target set is empty + | - Warning about boundary conditions + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +surfaceGeneratorName string Name of the surface generator to use +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst b/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst index ba6f587b61e..0f2fd92b13d 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst @@ -1,14 +1,18 @@ -=================== ============ ======== ============================================================================================================================================================= -Name Type Default Description -=================== ============ ======== ============================================================================================================================================================= -disableInelasticity integer 0 Flag to enable/disable inelastic behavior -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -resetDisplacements integer 1 Flag to reset displacements (and velocities) -solidSolverName groupNameRef required Name of the solid mechanics solver -=================== ============ ======== ============================================================================================================================================================= +=================== ============ ======== ================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=================== ============ ======== ================================================================================================================================================================================================================================================================================================================== +disableInelasticity integer 0 Flag to enable/disable inelastic behavior +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 and reset displacements + | - Information about physics solver during task + | logLevel >= 2 + | - Information about solid model during task +name groupName required A name is required for any non-unique nodes +resetDisplacements integer 1 Flag to reset displacements (and velocities) +solidSolverName groupNameRef required Name of the solid mechanics solver +=================== ============ ======== ================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst b/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst index fe77de7e265..8c3147902c9 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst @@ -1,13 +1,19 @@ -=============== ============ ======== ============================================================================================================================================================= -Name Type Default Description -=============== ============ ======== ============================================================================================================================================================= -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver -writeCSV integer 0 Write statistics into a CSV file -=============== ============ ======== ============================================================================================================================================================= +=============== ============ ======== ============================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=============== ============ ======== ============================================================================================================================================================================================================================================================================================================================================== +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel == 1 + | - Dipslay Indicative message + | logLevel == 1 and pore volume is zero + | - Display warning message + | logLevel >= 1 + | - Information on node statistics displacement +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver +writeCSV integer 0 Write statistics into a CSV file +=============== ============ ======== ============================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst b/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst index 511f50b3191..f3ecf2b759c 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst @@ -1,43 +1,53 @@ -========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 2 : - | Display a warning about boundary conditions - | - | 2 : - | Display residuals values -massDamping real64 0 Value of mass based damping coefficient. -maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. -name groupName required A name is required for any non-unique nodes -newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. -newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option -stiffnessDamping real64 0 Value of stiffness based damping coefficient. -strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: - | 0 - Infinitesimal Strain - | 1 - Finite Strain -surfaceGeneratorName string Name of the surface generator to use -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ====================================================== =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactRelationName groupNameRef NOCONTACT Name of contact relation to enforce constraints on fracture boundary. +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on residuals values + | logLevel >= 2 and target set is empty + | - Warning about boundary conditions + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +surfaceGeneratorName string Name of the surface generator to use +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SolidMechanics_MPM.rst b/src/coreComponents/schema/docs/SolidMechanics_MPM.rst index da7df8e05d4..e5a6e14a0cf 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_MPM.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_MPM.rst @@ -1,49 +1,61 @@ -============================== ============================================ =============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ============================================ =============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== -boundaryConditionTypes integer_array {0} | Boundary conditions on x-, x+, y-, y+, z- and z+ faces. Options are: - | * Outflow - | * Symmetry -boxAverageHistory integer 0 Flag for whether to output box average history -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactGapCorrection integer 0 Flag for mitigating contact gaps -cpdiDomainScaling integer 0 Option for CPDI domain scaling -damageFieldPartitioning integer 0 Flag for using the gradient of the particle damage field to partition material into separate velocity fields -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -fTableInterpType integer 0 The type of F table interpolation. Options are 0 (linear), 1 (cosine), 2 (quintic polynomial). -fTablePath path Path to f-table -frictionCoefficient real64 0 Coefficient of friction, currently assumed to be the same everywhere -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) -name groupName required A name is required for any non-unique nodes -needsNeighborList integer 0 Flag for whether to construct neighbor list -neighborRadius real64 -1 Neighbor radius for SPH-type calculations -planeStrain integer 0 Flag for performing plane strain calculations -prescribedBcTable integer 0 Flag for whether to have time-dependent boundary condition types -prescribedBoundaryFTable integer 0 Flag for whether to have time-dependent boundary conditions described by a global background grid F -reactionHistory integer 0 Flag for whether to output face reaction history -separabilityMinDamage real64 0.5 Damage threshold for field separability -solverProfiling integer 0 Flag for timing subroutines in the solver -surfaceDetection integer 0 Flag for automatic surface detection on the 1st cycle -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeIntegrationOption geos_SolidMechanicsMPM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: - | * QuasiStatic - | * ImplicitDynamic - | * ExplicitDynamic -treatFullyDamagedAsSingleField integer 1 Whether to consolidate fully damaged fields into a single field. Nice for modeling damaged mush. -useDamageAsSurfaceFlag integer 0 Indicates whether particle damage at the beginning of the simulation should be interpreted as a surface flag -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ============================================ =============== ========================================================================================================================================================================================================================================================================================================================================================================================================================== +============================== ============================================ =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +Name Type Default Description +============================== ============================================ =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +boundaryConditionTypes integer_array {0} | Boundary conditions on x-, x+, y-, y+, z- and z+ faces. Options are: + | * Outflow + | * Symmetry +boxAverageHistory integer 0 Flag for whether to output box average history +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactGapCorrection integer 0 Flag for mitigating contact gaps +cpdiDomainScaling integer 0 Option for CPDI domain scaling +damageFieldPartitioning integer 0 Flag for using the gradient of the particle damage field to partition material into separate velocity fields +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +fTableInterpType integer 0 The type of F table interpolation. Options are 0 (linear), 1 (cosine), 2 (quintic polynomial). +fTablePath path Path to f-table +frictionCoefficient real64 0 Coefficient of friction, currently assumed to be the same everywhere +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +needsNeighborList integer 0 Flag for whether to construct neighbor list +neighborRadius real64 -1 Neighbor radius for SPH-type calculations +planeStrain integer 0 Flag for performing plane strain calculations +prescribedBcTable integer 0 Flag for whether to have time-dependent boundary condition types +prescribedBoundaryFTable integer 0 Flag for whether to have time-dependent boundary conditions described by a global background grid F +reactionHistory integer 0 Flag for whether to output face reaction history +separabilityMinDamage real64 0.5 Damage threshold for field separability +solverProfiling integer 0 Flag for timing subroutines in the solver +surfaceDetection integer 0 Flag for automatic surface detection on the 1st cycle +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsMPM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +treatFullyDamagedAsSingleField integer 1 Whether to consolidate fully damaged fields into a single field. Nice for modeling damaged mush. +useDamageAsSurfaceFlag integer 0 Indicates whether particle damage at the beginning of the simulation should be interpreted as a surface flag +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ============================================ =============== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/SoloEvent.rst b/src/coreComponents/schema/docs/SoloEvent.rst index 2c63976fbad..af728b04e46 100644 --- a/src/coreComponents/schema/docs/SoloEvent.rst +++ b/src/coreComponents/schema/docs/SoloEvent.rst @@ -1,24 +1,26 @@ -==================== ============ ======== ================================================================================================================================================================= -Name Type Default Description -==================== ============ ======== ================================================================================================================================================================= -beginTime real64 0 Start time of this event. -endTime real64 1e+100 End time of this event. -finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. -forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). -name groupName required A name is required for any non-unique nodes -target groupNameRef Name of the object to be executed when the event criteria are met. -targetCycle integer -1 Targeted cycle to execute the event. -targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. -targetExactTimestep integer 1 If this option is set, the event will reduce its timestep requests to match the specified execution time exactly: dt_request = min(dt_request, t_target - time)). -targetTime real64 -1 Targeted time to execute the event. -HaltEvent node :ref:`XML_HaltEvent` -PeriodicEvent node :ref:`XML_PeriodicEvent` -SoloEvent node :ref:`XML_SoloEvent` -==================== ============ ======== ================================================================================================================================================================= +==================== ============ ======== ============================================================================================================================================================================================================ +Name Type Default Description +==================== ============ ======== ============================================================================================================================================================================================================ +beginTime real64 0 Start time of this event. +endTime real64 1e+100 End time of this event. +finalDtStretch real64 0.001 Allow the final dt request for this event to grow by this percentage to match the endTime exactly. +forceDt real64 -1 While active, this event will request this timestep value (ignoring any children/targets requests). +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about sub-event +maxEventDt real64 -1 While active, this event will request a timestep <= this value (depending upon any child/target requests). +name groupName required A name is required for any non-unique nodes +target groupNameRef Name of the object to be executed when the event criteria are met. +targetCycle integer -1 Targeted cycle to execute the event. +targetExactStartStop integer 1 If this option is set, the event will reduce its timestep requests to match any specified beginTime/endTimes exactly. +targetExactTimestep integer 1 If this option is set, the event will reduce its timestep requests to match the specified execution time exactly: dt_request = min(dt_request, t_target - time)). +targetTime real64 -1 Targeted time to execute the event. +HaltEvent node :ref:`XML_HaltEvent` +PeriodicEvent node :ref:`XML_PeriodicEvent` +SoloEvent node :ref:`XML_SoloEvent` +==================== ============ ======== ============================================================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/SourceFlux.rst b/src/coreComponents/schema/docs/SourceFlux.rst index e45ea333e5d..9322448e819 100644 --- a/src/coreComponents/schema/docs/SourceFlux.rst +++ b/src/coreComponents/schema/docs/SourceFlux.rst @@ -1,21 +1,33 @@ -====================== ================== ======== ============================================================================================================================================================= -Name Type Default Description -====================== ================== ======== ============================================================================================================================================================= -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ============================================================================================================================================================= +====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +component integer -1 Component of field (if tensor) to apply boundary condition to. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialCondition integer 0 Boundary condition is applied as an initial condition. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 and first newton iteration + | - Print the log message issued by the solver if the boundary condition is called + | logLevel >= 1 and first nonlinear iteration + | - Information on the face boundary condition defined with pressure and temperature + | - Information abonout the Dirichlet pressure, temperature boundary conditions + | logLevel >= 1 and first nonlinear iteration and this is a thermal simulation + | - Information on single phase thermal simulation + | logLevel >= 1 and regions with no dof + | - Warning about non simulated region + | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | logLevel >= 1 first nonlinear iteration + | - Print boundary conditions log messages +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SurfaceGenerator.rst b/src/coreComponents/schema/docs/SurfaceGenerator.rst index c491beabdd6..2d1c3f68809 100644 --- a/src/coreComponents/schema/docs/SurfaceGenerator.rst +++ b/src/coreComponents/schema/docs/SurfaceGenerator.rst @@ -1,37 +1,46 @@ -========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ -Name Type Default Description -========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -fractureRegion groupNameRef Fracture (no description available) -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isPoroelastic integer 0 Flag that defines whether the material is poroelastic or not. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display information about line search - | - Display global solution scaling factor - | 1 and step remaining : - | - Display informations about timestep - | only with loglevel = 2 : - | - Display informations about linear algebra objects (matrices and vectors) - | 1 : - | - Display informations about splitting node/edge/faces - | - | 2 : - | - Display informations about all elements attached to the nodeID - | - Display informations about all faces on their element - | - | 3 : - | - Display consistency checking of the maps -mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering -name groupName required A name is required for any non-unique nodes -nodeBasedSIF integer 0 Flag for choosing between node or edge based criteria: 1 for node based criterion -rockToughness real64 required Rock toughness of the solid material -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ +========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +fractureRegion groupNameRef Fracture (no description available) +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isPoroelastic integer 0 Flag that defines whether the material is poroelastic or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print splitting node along separation plane faces + | - Print splitting edge and face + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Print all elements attached to the nodeID + | - Print all faces on their element + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) + | - Information on the consistency checking of the maps + | - Print rupture rate +mpiCommOrder integer 0 Flag to enable MPI consistent communication ordering +name groupName required A name is required for any non-unique nodes +nodeBasedSIF integer 0 Flag for choosing between node or edge based criteria: 1 for node based criterion +rockToughness real64 required Rock toughness of the solid material +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Traction.rst b/src/coreComponents/schema/docs/Traction.rst index f31a5a7342f..a666143f201 100644 --- a/src/coreComponents/schema/docs/Traction.rst +++ b/src/coreComponents/schema/docs/Traction.rst @@ -1,25 +1,31 @@ -====================== =========================================== ============= =============================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -====================== =========================================== ============= =============================================================================================================================================================================================================================================================================================================================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -functionName groupNameRef Name of function that specifies variation of the boundary condition. -initialCondition integer 0 Boundary condition is applied as an initial condition. -inputStress R2SymTensor {0,0,0,0,0,0} Input stress for tractionType = stress -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Scale factor for value of the boundary condition. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -tractionType geos_TractionBoundaryCondition_TractionType vector | Type of traction boundary condition. Options are: - | vector - traction is applied to the faces as specified from the scale and direction, - | normal - traction is applied to the faces as a pressure specified from the product of scale and the outward face normal, - | stress - traction is applied to the faces as specified by the inner product of input stress and face normal. -====================== =========================================== ============= =============================================================================================================================================================================================================================================================================================================================================================================== +====================== =========================================== ============= ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +====================== =========================================== ============= ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. +beginTime real64 -1e+99 Time at which the boundary condition will start being applied. +direction R1Tensor {0,0,0} Direction to apply boundary condition to. +endTime real64 1e+99 Time at which the boundary condition will stop being applied. +functionName groupNameRef Name of function that specifies variation of the boundary condition. +initialCondition integer 0 Boundary condition is applied as an initial condition. +inputStress R2SymTensor {0,0,0,0,0,0} Input stress for tractionType = stress +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 and first nonlinear iteration + | - Information on the face boundary condition defined with pressure and temperature + | logLevel >= 1 and regions with no dof + | - Warning about non simulated region + | logLevel >= 1 first nonlinear iteration + | - Print boundary conditions log messages +name groupName required A name is required for any non-unique nodes +objectPath groupNameRef Path to the target field +scale real64 0 Scale factor for value of the boundary condition. +setNames groupNameRef_array required Name of sets that boundary condition is applied to. +tractionType geos_TractionBoundaryCondition_TractionType vector | Type of traction boundary condition. Options are: + | vector - traction is applied to the faces as specified from the scale and direction, + | normal - traction is applied to the faces as a pressure specified from the product of scale and the outward face normal, + | stress - traction is applied to the faces as specified by the inner product of input stress and face normal. +====================== =========================================== ============= ================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/TriaxialDriver.rst b/src/coreComponents/schema/docs/TriaxialDriver.rst index 371f0d67f96..de024cc2363 100644 --- a/src/coreComponents/schema/docs/TriaxialDriver.rst +++ b/src/coreComponents/schema/docs/TriaxialDriver.rst @@ -1,22 +1,22 @@ -============= ======================== ======== ================================================================================================================================================================================================================================================================ -Name Type Default Description -============= ======================== ======== ================================================================================================================================================================================================================================================================ -axialControl groupNameRef required Function controlling axial stress or strain (depending on test mode) -baseline path none Baseline file -initialStress real64 required Initial stress (scalar used to set an isotropic stress state) -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Print informations about TriaxialDriver - | - Indicate if the internal results are consistent -material groupNameRef required Solid material to test -mode geos_TriaxialDriver_Mode required Test mode [stressControl, strainControl, mixedControl] -name groupName required A name is required for any non-unique nodes -output string none Output file -radialControl groupNameRef required Function controlling radial stress or strain (depending on test mode) -steps integer required Number of load steps to take -============= ======================== ======== ================================================================================================================================================================================================================================================================ +============= ======================== ======== ================================================================================================================================================================================================================================================================== +Name Type Default Description +============= ======================== ======== ================================================================================================================================================================================================================================================================== +axialControl groupNameRef required Function controlling axial stress or strain (depending on test mode) +baseline path none Baseline file +initialStress real64 required Initial stress (scalar used to set an isotropic stress state) +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on TriaxialDriver + | - Indicate if the internal results are consistent +material groupNameRef required Solid material to test +mode geos_TriaxialDriver_Mode required Test mode [stressControl, strainControl, mixedControl] +name groupName required A name is required for any non-unique nodes +output string none Output file +radialControl groupNameRef required Function controlling radial stress or strain (depending on test mode) +steps integer required Number of load steps to take +============= ======================== ======== ================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/VTK.rst b/src/coreComponents/schema/docs/VTK.rst index 25eeb14615f..894b9a1bb59 100644 --- a/src/coreComponents/schema/docs/VTK.rst +++ b/src/coreComponents/schema/docs/VTK.rst @@ -7,8 +7,6 @@ childDirectory string Child directory pat fieldNames groupNameRef_array {} Names of the fields to output. If this attribute is specified, GEOSX outputs all the fields specified by the user, regardless of their `plotLevel` format geos_vtk_VTKOutputMode binary Output data format. Valid options: ``binary``, ``ascii`` levelNames string_array {} Names of mesh levels to output. -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. name groupName required A name is required for any non-unique nodes onlyPlotSpecifiedFieldNames integer 0 If this flag is equal to 1, then we only plot the fields listed in `fieldNames`. Otherwise, we plot all the fields with the required `plotLevel`, plus the fields listed in `fieldNames` outputRegionType geos_vtk_VTKRegionTypes all Output region types. Valid options: ``cell``, ``well``, ``surface``, ``particle``, ``all`` diff --git a/src/coreComponents/schema/docs/VTKMesh.rst b/src/coreComponents/schema/docs/VTKMesh.rst index c18077338ed..47a88acf690 100644 --- a/src/coreComponents/schema/docs/VTKMesh.rst +++ b/src/coreComponents/schema/docs/VTKMesh.rst @@ -7,16 +7,13 @@ faceBlocks groupNameRef_array {} For multi-block files, fieldNamesInGEOSX groupNameRef_array {} Names of the volumic fields in GEOSX to import into fieldsToImport groupNameRef_array {} Volumic fields to be imported from the external mesh file file path required Path to the mesh file -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display cell block names - | - | 2 : - | - Display node sets names - | - | 5 : - | - Display informations about redistribution + | logLevel >= 1 + | - Information on cell block names + | logLevel >= 2 + | - Information on node sets names + | - Print the mesh generation step mainBlockName groupNameRef main For multi-block files, name of the 3d mesh block. name groupName required A name is required for any non-unique nodes nodesetNames groupNameRef_array {} Names of the VTK nodesets to import diff --git a/src/coreComponents/schema/docs/VTKWell.rst b/src/coreComponents/schema/docs/VTKWell.rst index 2f458ebe9e0..3567f08b091 100644 --- a/src/coreComponents/schema/docs/VTKWell.rst +++ b/src/coreComponents/schema/docs/VTKWell.rst @@ -1,21 +1,23 @@ -===================== ========= ======== ====================================================================================================================================================================================================================================== -Name Type Default Description -===================== ========= ======== ====================================================================================================================================================================================================================================== -file path required Path to the well file -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | 1 : - | - Display informations about Internal wells and their perforations -minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] -minSegmentLength real64 0.01 Minimum length of a well segment [m] -name groupName required A name is required for any non-unique nodes -numElementsPerSegment integer required Number of well elements per polyline segment -radius real64 required Radius of the well [m] -wellControlsName string required Name of the set of constraints associated with this well -wellRegionName string required Name of the well element region -Perforation node :ref:`XML_Perforation` -===================== ========= ======== ====================================================================================================================================================================================================================================== +===================== ========= ======== ===================================================================================================================================================================================================================================================================================== +Name Type Default Description +===================== ========= ======== ===================================================================================================================================================================================================================================================================================== +file path required Path to the well file +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on Internal wells and their perforations + | logLevel >= 2 + | - Indicate the dataset reading +minElementLength real64 0.001 Minimum length of a well element, computed as (segment length / number of elements per segment ) [m] +minSegmentLength real64 0.01 Minimum length of a well segment [m] +name groupName required A name is required for any non-unique nodes +numElementsPerSegment integer required Number of well elements per polyline segment +radius real64 required Radius of the well [m] +wellControlsName string required Name of the set of constraints associated with this well +wellRegionName string required Name of the well element region +Perforation node :ref:`XML_Perforation` +===================== ========= ======== ===================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/WellControls.rst b/src/coreComponents/schema/docs/WellControls.rst index fb2e7a4bb8d..3d0d209bcb1 100644 --- a/src/coreComponents/schema/docs/WellControls.rst +++ b/src/coreComponents/schema/docs/WellControls.rst @@ -17,8 +17,10 @@ initialPressureCoefficient real64 0.1 | Tuning coefficie | - Producer pressure at reference depth initialized as: (1-initialPressureCoefficient)*reservoirPressureAtClosestPerforation + density*g*( zRef - zPerf ) injectionStream real64_array {-1} Global component densities of the injection stream [moles/m^3 or kg/m^3] injectionTemperature real64 -1 Temperature of the injection stream [K] -logLevel integer 1 | Sets the level of information to write in the standard output (the console typically). +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on well controls setting name groupName required A name is required for any non-unique nodes referenceElevation real64 required Reference elevation where BHP control is enforced [m] statusTableName groupNameRef | Name of the well status table when the status of the well is a time dependent function. diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index 15e0bcb501b..1dc175d6a75 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -921,8 +921,10 @@ - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about current sub-event--> + @@ -947,8 +949,10 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about sub-event--> + @@ -979,8 +983,10 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about sub-event--> + @@ -1017,8 +1023,10 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about sub-event--> + @@ -1095,8 +1103,16 @@ This keyword is ignored for single-phase flow simulations--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information on boundary conditions +logLevel >= 1 and first nonlinear iteration + - Information on the face boundary condition defined with pressure and temperature +logLevel >= 1 and regions with no dof + - Warning about non simulated region +logLevel >= 1 first nonlinear iteration + - Print boundary conditions log messages--> + @@ -1125,8 +1141,14 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 and first nonlinear iteration + - Information on the face boundary condition defined with pressure and temperature +logLevel >= 1 and regions with no dof + - Warning about non simulated region +logLevel >= 1 first nonlinear iteration + - Print boundary conditions log messages--> + @@ -1154,8 +1176,14 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 and first nonlinear iteration + - Information on the face boundary condition defined with pressure and temperature +logLevel >= 1 and regions with no dof + - Warning about non simulated region +logLevel >= 1 first nonlinear iteration + - Print boundary conditions log messages--> + @@ -1191,8 +1219,14 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 and first nonlinear iteration + - Information on the face boundary condition defined with pressure and temperature +logLevel >= 1 and regions with no dof + - Warning about non simulated region +logLevel >= 1 first nonlinear iteration + - Print boundary conditions log messages--> + @@ -1218,8 +1252,14 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 and first nonlinear iteration + - Information on the face boundary condition defined with pressure and temperature +logLevel >= 1 and regions with no dof + - Warning about non simulated region +logLevel >= 1 first nonlinear iteration + - Print boundary conditions log messages--> + @@ -1259,8 +1299,20 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 and first newton iteration + - Print the log message issued by the solver if the boundary condition is called +logLevel >= 1 and first nonlinear iteration + - Information on the face boundary condition defined with pressure and temperature + - Information abonout the Dirichlet pressure, temperature boundary conditions +logLevel >= 1 and first nonlinear iteration and this is a thermal simulation + - Information on single phase thermal simulation +logLevel >= 1 and regions with no dof + - Warning about non simulated region + - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects +logLevel >= 1 first nonlinear iteration + - Print boundary conditions log messages--> + @@ -1286,8 +1338,14 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 and first nonlinear iteration + - Information on the face boundary condition defined with pressure and temperature +logLevel >= 1 and regions with no dof + - Warning about non simulated region +logLevel >= 1 first nonlinear iteration + - Print boundary conditions log messages--> + @@ -1439,9 +1497,9 @@ stress - traction is applied to the faces as specified by the inner product of i - +logLevel >= 2 + - Information on length and width of the bounded plane--> + @@ -1499,9 +1557,9 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on imported field name on region/subRegion--> + @@ -1552,8 +1610,10 @@ A level of 0 outputs minimal information, higher levels require more. - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information on Internal wells and their perforations--> + @@ -1591,9 +1651,11 @@ A level of 0 outputs minimal information, higher levels require more.--> - +logLevel >= 1 + - Information on Internal wells and their perforations +logLevel >= 2 + - Indicate the dataset reading--> + @@ -1702,15 +1764,12 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on cell block names +logLevel >= 2 + - Information on node sets names + - Print the mesh generation step--> + @@ -1842,8 +1901,50 @@ the relative residual norm satisfies: - +A level of 0 outputs minimal information, higher levels require more. +logLevel == 1 + - Set UMFPACK_PRL to 1 +logLevel == 1 and TrilinosSover + - Sets SetAztecOption to AZ_summary +logLevel == 2 and TrilinosSover + - Sets SetAztecOption to AZ_all +logLevel == 2 or logLevel == 4 and HypreSolver + - Set print level for BoomerAMG +logLevel >= 1 + - Linear solver informations +logLevel >= 1 and Hypre + - Print results +logLevel >= 1 and HyprePreconditioner setup not existing + - Indicate arror +logLevel >= 1 and HypreSolver + - Set print level for mgr solver + - Information on MGR preconditioner +logLevel >= 1 and PetscSolver + - Print the residual/error +logLevel >= 1 and SuperLU solver + - Information on result + - Print the blocking parameters and options setting +logLevel >= 1 and incorrect SuperLU residual reduction + - Warning about residual reduction +logLevel >= 1 and incorrect final relative residual norm + - Warning about residual reduction +logLevel >= 2 + - Print information about symbolic and numeric factorization. + - Set UMFPACK_PRL to 6 +logLevel >= 2 and KrylovSolver + - Print residual norms + - Print the results +logLevel >= 2 and SuperLU solver + - Print the statistics. +logLevel >= 2 and value too close to zero. + - Information about exit solver iteration +logLevel >= 3 and Hypre + - Print convergence + iteration info +logLevel >= 3 and PetscSolver + - Informations on PetscSolver result +logLevel >= 3 and TrilinosSover + - Sets SetAztecOption to AZ_none--> + @@ -1927,9 +2028,9 @@ A level of 0 outputs minimal information, higher levels require more.--> - +logLevel >= 1 + - Information on NonLinearSolver parameters--> + @@ -2057,6 +2158,11 @@ A level of 0 outputs minimal information, higher levels require more. + + @@ -2131,9 +2237,6 @@ A level of 0 outputs minimal information, higher levels require more. - - @@ -2232,14 +2335,26 @@ A level of 0 outputs minimal information, higher levels require more.--> - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2274,14 +2389,27 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information about linear DAS +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2339,14 +2467,28 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information about linear DAS + - Print PML parameters +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2399,14 +2541,27 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information about linear DAS +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2455,25 +2610,47 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on pressure and temperature + - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + - Information about pressure, phase, temperature during time step + - Information on density during outer iteration + - Information on volume frations + - Information on CFL number + - Print the residual values + - Information about max pressure/max component density change +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and negative density + - Information on negative density values +logLevel >= 1 and negative pressure + - Information on negative pressure values +logLevel >= 1 and non first nonlinear iteration + - Information on the face boundary conditions log +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 1 and scaling type is local + - Print scaling factors +logLevel >= 1 and thermal simulation + - Information on max relative temperature + - Information about temperature changes +logLevel >= 1 and total density > 0 + - Information on total density values +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2552,22 +2729,35 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on pressure and temperature + - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + - Information about pressure, phase, temperature during time step + - Information on density during outer iteration + - Information on volume frations + - Information on CFL number + - Print the residual values +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 1 and thermal simulation + - Information on max relative temperature +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2620,9 +2810,32 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and if the well is injector and crossflow enabled + - Warnings about crossflow for injectors +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2643,14 +2856,31 @@ Display warnings about crossflow for injectors--> - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration + - Print phase volume fraction +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2688,26 +2918,32 @@ Local - Add stabilization only to interiors of macro elements.--> - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Infos on residual values + - Output well rates to a simple csv file +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Infos on the BHP pressure + - Infos on the surface density +logLevel >= 2 and use surface conditions + - Information on the phase and total density in the reference element +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2744,8 +2980,10 @@ only with loglevel = 2 : - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information on well controls setting--> + - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information about linear DAS +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2882,14 +3133,27 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information about linear DAS +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2934,14 +3198,28 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print number of embedded surface elements +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Print each cell index element fractured +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2964,14 +3242,31 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration + - Informations about convergance and iterations +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -2998,10 +3293,33 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration + - Output whether or not we Re-entering Newton Solve + - Information on aperture and hydraulic aperture +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors) + - Print time stepping--> + @@ -3037,14 +3355,26 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration + - Print phase volume fraction +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3109,9 +3456,32 @@ Local - Add stabilization only to interiors of macro elements.--> - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and if the well is injector and crossflow enabled + - Warnings about crossflow for injectors +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3142,19 +3512,28 @@ Display warnings about crossflow for injectors--> - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Output the jacobian matrix + - Output the residuals values +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3185,14 +3564,30 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3223,19 +3618,28 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on pressure and temperature + - Infos on residual norm values +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3280,23 +3684,28 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on pressure and temperature + - Print the residuals values +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3337,7 +3746,27 @@ only with loglevel = 2 : - + @@ -3363,13 +3792,30 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on pressure and temperature + - Print pressure change + - Information on negative pressure values + - Print the residual values +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3400,29 +3846,30 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on pressure and temperature + - Print pressure change + - Information on negative pressure values + - Print the residual norm values +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3451,14 +3898,30 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3481,10 +3944,31 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors) + - The summary of declared fields and coupling--> + @@ -3507,14 +3991,30 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3533,14 +4033,30 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3567,13 +4083,30 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on pressure and temperature + - Print pressure change + - Information on negative pressure values + - Print the residual values +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3600,14 +4133,30 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3628,14 +4177,30 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print solvers name + - Print residual norm + - Print time stepping + - Information on each iteration +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3657,26 +4222,32 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Infos on residual values + - Output well rates to a simple csv file +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Infos on BHP pressure + - Infos on surface density +logLevel >= 2 and use surface conditions + - Information on the phase and total density in the reference element +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3697,11 +4268,31 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on number of elements for each fracture states + - Infos on residual norm for each fractures +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Infos on residuals values +logLevel >= 2 and target set is empty + - Warning about boundary conditions +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3746,11 +4337,31 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Information on number of elements for each fracture states + - Infos on risidual norm (Rdisplacement, Rtraction, Rtotal) +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Infos on residuals values +logLevel >= 2 and target set is empty + - Warning about boundary conditions +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3794,19 +4405,29 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Infos on residuals values +logLevel >= 2 and target set is empty + - Warning about boundary conditions +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3848,19 +4469,29 @@ Display residuals values--> - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Infos on residuals values +logLevel >= 2 and target set is empty + - Warning about boundary conditions +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3918,14 +4549,26 @@ Display residuals values--> - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors)--> + @@ -3978,23 +4621,32 @@ only with loglevel = 2 : - +logLevel >= 1 + - Information on line search + - Information on global solution scaling factor + - Information on the timestep + - Print residual norm + - Print splitting node along separation plane faces + - Print splitting edge and face +logLevel >= 1 and configuration didn't converge + - Information about testing new configuration and print the time step +logLevel >= 1 and incorrect solution + - Information about line search failed +logLevel >= 1 and linear system + - Information on number of iterations and residual reduction +logLevel >= 1 and non linear system + - Information on each newton Iteration +logLevel >= 1 and residual norm above the max allowed residual norm + - Indicate allowed residual norm +logLevel >= 2 + - Output to screen the assembled linear system and solutions (matrices and vectors) + - Print all elements attached to the nodeID + - Print all faces on their element +logLevel >= 3 + - Output to file the assembled linear system and solutions (matrices and vectors) + - Information on the consistency checking of the maps + - Print rupture rate--> + @@ -4025,10 +4677,10 @@ only with loglevel = 2 : - - - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about physics solver stress initialization--> + @@ -4044,8 +4696,17 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel == 1 + - Dipslay Indicative message +logLevel == 1 and pore volume is zero + - Display warning message +logLevel >= 1 + - Information on the regions statistics + - Information on CFL numbers +logLevel >= 1 and pore volume equal 0 + - Warning on the impossibility to compute pressure--> + @@ -4055,8 +4716,10 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about physics solver stress initialization--> + @@ -4073,10 +4736,10 @@ A level of 0 outputs minimal information, higher levels require more.--> - +logLevel >= 1 + - Informations about PVT Driver + - Indicate consistency of results--> + @@ -4117,10 +4780,10 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on ReactiveFluidDriver + - Indicate at the end if the internal results are consistent--> + @@ -4137,10 +4800,10 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on RelpermDriver + - Indicate if the internal results are consistent--> + @@ -4152,8 +4815,10 @@ A level of 0 outputs minimal information, higher levels require more. - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about physics solver stress initialization--> + @@ -4163,8 +4828,10 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 + - Information about physics solver stress initialization--> + @@ -4176,8 +4843,14 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel == 1 + - Dipslay Indicative message +logLevel == 1 and pore volume is zero + - Display warning message +logLevel >= 1 + - Information on region statistics--> + @@ -4187,8 +4860,12 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel >= 1 and reset displacements + - Information about physics solver during task +logLevel >= 2 + - Information about solid model during task--> + @@ -4198,8 +4875,14 @@ A level of 0 outputs minimal information, higher levels require more.--> - +A level of 0 outputs minimal information, higher levels require more. +logLevel == 1 + - Dipslay Indicative message +logLevel == 1 and pore volume is zero + - Display warning message +logLevel >= 1 + - Information on node statistics displacement--> + @@ -4216,10 +4899,10 @@ A level of 0 outputs minimal information, higher levels require more.--> - +logLevel >= 1 + - Information on TriaxialDriver + - Indicate if the internal results are consistent--> + @@ -4448,9 +5131,9 @@ The expected format is "{ waterMax, oilMax }", in that order--> - +logLevel >= 1 + - Informations on PVT phase table--> + @@ -4471,9 +5154,9 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Informations on PVT phase table--> + @@ -4494,9 +5177,9 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Informations on PVT phase table--> + @@ -4517,9 +5200,9 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Informations on PVT phase table--> + @@ -5572,9 +6255,9 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia - +logLevel >= 1 + - Information on phase PVT Table--> + @@ -5591,9 +6274,9 @@ A level of 0 outputs minimal information, higher levels require more. - +logLevel >= 1 + - Information on phase PVT Table--> + From b47ffe829cb3f5b687d5bdecfad4ecfc4dd98b30 Mon Sep 17 00:00:00 2001 From: arng40 Date: Thu, 20 Jun 2024 14:57:13 +0200 Subject: [PATCH 16/18] fix and updates rst --- ...ePhasePoromechanicsConformingFractures.cpp | 3 +- .../schema/docs/AcousticFirstOrderSEM.rst | 103 +++--- .../schema/docs/AcousticSEM.rst | 105 +++--- .../schema/docs/AcousticVTISEM.rst | 103 +++--- .../docs/CompositionalMultiphaseFVM.rst | 167 +++++----- .../docs/CompositionalMultiphaseHybridFVM.rst | 125 +++---- ...tionalMultiphaseReservoirPoromechanics.rst | 10 +- .../docs/CompositionalMultiphaseWell.rst | 90 ++--- .../schema/docs/ElasticFirstOrderSEM.rst | 103 +++--- src/coreComponents/schema/docs/ElasticSEM.rst | 109 ++++--- src/coreComponents/schema/docs/Events.rst | 4 +- .../schema/docs/Hydrofracture.rst | 6 + .../docs/HydrofractureInitialization.rst | 19 +- .../schema/docs/MultiphasePoromechanics.rst | 10 +- .../schema/docs/SinglePhaseFVM.rst | 6 +- .../schema/docs/SinglePhaseHybridFVM.rst | 70 ++-- .../schema/docs/SinglePhasePoromechanics.rst | 82 ++--- ...ePhasePoromechanicsConformingFractures.rst | 84 ++--- ...anicsConformingFracturesInitialization.rst | 15 + ...onformingFracturesInitialization_other.rst | 9 + ...omechanicsConformingFracturesReservoir.rst | 41 +++ ...nicsConformingFracturesReservoir_other.rst | 14 + ...glePhasePoromechanicsEmbeddedFractures.rst | 82 ++--- ...chanicsEmbeddedFracturesInitialization.rst | 15 + ...sEmbeddedFracturesInitialization_other.rst | 9 + .../schema/docs/SinglePhaseProppantFVM.rst | 31 +- .../SinglePhaseReservoirPoromechanics.rst | 82 ++--- ...lidMechanicsAugmentedLagrangianContact.rst | 52 +++ ...hanicsAugmentedLagrangianContact_other.rst | 16 + src/coreComponents/schema/docs/Solvers.rst | 88 ++--- .../schema/docs/Solvers_other.rst | 86 ++--- src/coreComponents/schema/docs/SourceFlux.rst | 19 -- .../schema/docs/SourceFluxStatistics.rst | 24 +- src/coreComponents/schema/docs/Tasks.rst | 2 + .../schema/docs/Tasks_other.rst | 2 + src/coreComponents/schema/docs/VTK.rst | 3 +- src/coreComponents/schema/schema.xsd | 308 ++++++++++++++++-- src/coreComponents/schema/schema.xsd.other | 40 ++- src/docs/sphinx/CompleteXMLSchema.rst | 56 ++++ 39 files changed, 1379 insertions(+), 814 deletions(-) create mode 100644 src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst create mode 100644 src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst create mode 100644 src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst create mode 100644 src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst create mode 100644 src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst create mode 100644 src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst create mode 100644 src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst create mode 100644 src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index b74ca347636..795c674cadc 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -42,10 +42,9 @@ SinglePhasePoromechanicsConformingFractures< FLOW_SOLVER >::SinglePhasePoromecha Group * const parent ) : Base( name, parent ) { - appendLogLevelDescription( "logLevel >= 3", "The summary of declared fields and coupling" ); + this->appendLogLevelDescription( "logLevel >= 3", "The summary of declared fields and coupling" ); LinearSolverParameters & params = this->m_linearSolverParameters.get(); - LinearSolverParameters & params = m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; params.mgr.separateComponents = false; params.mgr.displacementFieldName = solidMechanics::totalDisplacement::key(); diff --git a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst index 34c3bd7b9de..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst @@ -1,54 +1,57 @@ -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/AcousticSEM.rst b/src/coreComponents/schema/docs/AcousticSEM.rst index 9fa66005d69..0dc6a094690 100644 --- a/src/coreComponents/schema/docs/AcousticSEM.rst +++ b/src/coreComponents/schema/docs/AcousticSEM.rst @@ -1,55 +1,58 @@ -========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | - Print PML parameters - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================== ==================================== ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ==================================== ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | - Print PML parameters + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/AcousticVTISEM.rst b/src/coreComponents/schema/docs/AcousticVTISEM.rst index 34c3bd7b9de..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/AcousticVTISEM.rst +++ b/src/coreComponents/schema/docs/AcousticVTISEM.rst @@ -1,54 +1,57 @@ -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst index 8e1db83c332..19fa18b946d 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst @@ -1,86 +1,89 @@ -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used -continuationDBC integer 1 Flag for enabling continuation parameter -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information on pressure and temperature - | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects - | - Information about pressure, phase, temperature during time step - | - Information on density during outer iteration - | - Information on volume frations - | - Information on CFL number - | - Print the residual values - | - Information about max pressure/max component density change - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and negative density - | - Information on negative density values - | logLevel >= 1 and negative pressure - | - Information on negative pressure values - | logLevel >= 1 and non first nonlinear iteration - | - Information on the face boundary conditions log - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 1 and scaling type is local - | - Print scaling factors - | logLevel >= 1 and thermal simulation - | - Information on max relative temperature - | - Information about temperature changes - | logLevel >= 1 and total density > 0 - | - Information on total density values - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility -name groupName required A name is required for any non-unique nodes -omegaDBC real64 1 Factor by which DBC flux is multiplied -scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: - | * Global - | * Local -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useDBC integer 0 Enable Dissipation-based continuation flux -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +========================================= =========================================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================================= =========================================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used +continuationDBC integer 1 Flag for enabling continuation parameter +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | - Information about pressure, phase, temperature during time step + | - Information on density during outer iteration + | - Information on volume frations + | - Information on CFL number + | - Print the residual values + | - Information about max pressure/max component density change + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and negative density + | - Information on negative density values + | logLevel >= 1 and negative pressure + | - Information on negative pressure values + | logLevel >= 1 and non first nonlinear iteration + | - Information on the face boundary conditions log + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 1 and scaling type is local + | - Print scaling factors + | logLevel >= 1 and thermal simulation + | - Information on max relative temperature + | - Information about temperature changes + | logLevel >= 1 and total density > 0 + | - Information on total density values + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativeCompDensChange real64 1.79769e+308 Maximum (relative) change in a component density in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +minScalingFactor real64 0.01 Minimum value for solution scaling factor +miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility +name groupName required A name is required for any non-unique nodes +omegaDBC real64 1 Factor by which DBC flux is multiplied +scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: + | * Global + | * Local +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativeCompDensChangeInTimeStep real64 1.79769e+308 Target (relative) change in component density in a time step +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useDBC integer 0 Enable Dissipation-based continuation flux +useMass integer 0 Use mass formulation instead of molar. Warning : Affects SourceFlux rates units. +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= =========================================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst index 8303e68b3a8..a73b3252efc 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst @@ -1,65 +1,68 @@ -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information on pressure and temperature - | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects - | - Information about pressure, phase, temperature during time step - | - Information on density during outer iteration - | - Information on volume frations - | - Information on CFL number - | - Print the residual values - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 1 and thermal simulation - | - Information on max relative temperature - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -name groupName required A name is required for any non-unique nodes -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================================= ================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================================= ================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | - Information about pressure, phase, temperature during time step + | - Information on density during outer iteration + | - Information on volume frations + | - Information on CFL number + | - Print the residual values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 1 and thermal simulation + | - Information on max relative temperature + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativeCompDensChange real64 1.79769e+308 Maximum (relative) change in a component density in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +minScalingFactor real64 0.01 Minimum value for solution scaling factor +name groupName required A name is required for any non-unique nodes +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativeCompDensChangeInTimeStep real64 1.79769e+308 Target (relative) change in component density in a time step +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useMass integer 0 Use mass formulation instead of molar. Warning : Affects SourceFlux rates units. +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= ================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst index e6895f5228c..0558fd89983 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst @@ -35,12 +35,12 @@ logLevel integer 0 | Sets name groupName required A name is required for any non-unique nodes reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst index 94dbc6be1d9..44dfcccdfe4 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst @@ -1,48 +1,50 @@ -============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Infos on residual values - | - Output well rates to a simple csv file - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | - Infos on the BHP pressure - | - Infos on the surface density - | logLevel >= 2 and use surface conditions - | - Information on the phase and total density in the reference element - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations -maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -useMass integer 0 Use total mass equation -writeCSV integer 0 Write rates into a CSV file -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -WellControls node :ref:`XML_WellControls` -============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================= ================== ============ ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================= ================== ============ ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Infos on residual values + | - Output well rates to a simple csv file + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on the BHP pressure + | - Infos on the surface density + | logLevel >= 2 and use surface conditions + | - Information on the phase and total density in the reference element + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations +maxRelativeCompDensChange real64 1.79769e+308 Maximum (relative) change in a component density between two Newton iterations +maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +useMass integer 0 Use mass formulation instead of molar +useTotalMassEquation integer 1 Use total mass equation +writeCSV integer 0 Write rates into a CSV file +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +WellControls node :ref:`XML_WellControls` +============================= ================== ============ ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst index 34c3bd7b9de..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst @@ -1,54 +1,57 @@ -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ElasticSEM.rst b/src/coreComponents/schema/docs/ElasticSEM.rst index b385d767058..b7195754890 100644 --- a/src/coreComponents/schema/docs/ElasticSEM.rst +++ b/src/coreComponents/schema/docs/ElasticSEM.rst @@ -1,57 +1,60 @@ -========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). -sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -useVTI integer 0 Flag to apply VTI anisotropy. The default is to use isotropic physic. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). +sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +useVTI integer 0 Flag to apply VTI anisotropy. The default is to use isotropic physic. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/Events.rst b/src/coreComponents/schema/docs/Events.rst index edf1c9286b6..b7201702306 100644 --- a/src/coreComponents/schema/docs/Events.rst +++ b/src/coreComponents/schema/docs/Events.rst @@ -7,8 +7,8 @@ logLevel integer 0 | Sets the leve | A level of 0 outputs minimal information, higher levels require more. | logLevel >= 1 | - Information about current sub-event -maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. -maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. +maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. Disabled by default. +maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. Disabled by default. minTime real64 0 Start simulation time for the global event loop. timeOutputFormat geos_EventManager_TimeOutputFormat seconds Format of the time in the GEOS log. HaltEvent node :ref:`XML_HaltEvent` diff --git a/src/coreComponents/schema/docs/Hydrofracture.rst b/src/coreComponents/schema/docs/Hydrofracture.rst index 1105baae110..c7d93ed9147 100644 --- a/src/coreComponents/schema/docs/Hydrofracture.rst +++ b/src/coreComponents/schema/docs/Hydrofracture.rst @@ -41,6 +41,12 @@ maxNumResolves integer name groupName required A name is required for any non-unique nodes newFractureInitializationType geos_HydrofractureSolver >_InitializationType Pressure Type of new fracture element initialization. Can be Pressure or Displacement. solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements surfaceGeneratorName groupNameRef required Name of the surface generator to use in the hydrofracture solver targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. useQuasiNewton integer 0 (no description available) diff --git a/src/coreComponents/schema/docs/HydrofractureInitialization.rst b/src/coreComponents/schema/docs/HydrofractureInitialization.rst index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/HydrofractureInitialization.rst +++ b/src/coreComponents/schema/docs/HydrofractureInitialization.rst @@ -1,12 +1,15 @@ -============================ ============ ======== =========================================== -Name Type Default Description -============================ ============ ======== =========================================== -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics -============================ ============ ======== =========================================== +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst index 8028a317831..8482d5e5c3c 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst @@ -35,12 +35,12 @@ logLevel integer 0 | Sets t | - Output to file the assembled linear system and solutions (matrices and vectors) name groupName required A name is required for any non-unique nodes solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` diff --git a/src/coreComponents/schema/docs/SinglePhaseFVM.rst b/src/coreComponents/schema/docs/SinglePhaseFVM.rst index b5a093f8f36..bb6fd73b18e 100644 --- a/src/coreComponents/schema/docs/SinglePhaseFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseFVM.rst @@ -7,7 +7,11 @@ allowNegativePressure integer 1 Flag indicating if ne cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. +isThermal integer 0 | + | SourceFluxes application if isThermal is enabled : + | - negative value (injection): the mass balance equation is modified to considered the additional source term, + | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. + | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. | logLevel >= 1 diff --git a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst index 01c0990701b..b718407d304 100644 --- a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst @@ -1,24 +1,50 @@ -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 | Flag indicating whether the problem is thermal or not. - | SourceFluxes application if isThermal is enabled : - | - negative value (injection): the mass balance equation is modified to considered the additional source term, - | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. - | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== + + +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 | + | SourceFluxes application if isThermal is enabled : + | - negative value (injection): the mass balance equation is modified to considered the additional source term, + | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. + | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Print pressure change + | - Information on negative pressure values + | - Print the residual norm values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst index d561d6692cb..840c91377df 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst @@ -1,42 +1,48 @@ -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst index c00235f2391..ac418081a75 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst @@ -1,43 +1,49 @@ -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) - | - The summary of declared fields and coupling -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) + | - The summary of declared fields and coupling +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst new file mode 100644 index 00000000000..5c3a3317d9c --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst @@ -0,0 +1,15 @@ + + +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst new file mode 100644 index 00000000000..adf1c1b8aec --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst @@ -0,0 +1,9 @@ + + +==== ==== ============================ +Name Type Description +==== ==== ============================ + (no documentation available) +==== ==== ============================ + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst new file mode 100644 index 00000000000..689e5d333c1 --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst @@ -0,0 +1,41 @@ + + +========================================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +poromechanicsConformingFracturesSolverName groupNameRef required Name of the poromechanicsConformingFractures solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst new file mode 100644 index 00000000000..cccf4603c70 --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst @@ -0,0 +1,14 @@ + + +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +Name Type Description +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +discretization groupNameRef Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +maxStableDt real64 Value of the Maximum Stable Timestep for this solver. +meshTargets geos_mapBase, LvArray_Array, int, LvArray_ChaiBuffer>, std_integral_constant > MeshBody/Region combinations that the solver will be applied to. +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst index d561d6692cb..840c91377df 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst @@ -1,42 +1,48 @@ -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst new file mode 100644 index 00000000000..5c3a3317d9c --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst @@ -0,0 +1,15 @@ + + +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst new file mode 100644 index 00000000000..adf1c1b8aec --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst @@ -0,0 +1,9 @@ + + +==== ==== ============================ +Name Type Description +==== ==== ============================ + (no documentation available) +==== ==== ============================ + + diff --git a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst index 85c6cefa39c..bb6fd73b18e 100644 --- a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst @@ -1,6 +1,5 @@ -<<<<<<< HEAD ============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ Name Type Default Description ============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ @@ -8,7 +7,11 @@ allowNegativePressure integer 1 Flag indicating if ne cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. +isThermal integer 0 | + | SourceFluxes application if isThermal is enabled : + | - negative value (injection): the mass balance equation is modified to considered the additional source term, + | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. + | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. | logLevel >= 1 @@ -43,29 +46,5 @@ temperature real64 0 Temperature LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` ============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ -======= -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 | Flag indicating whether the problem is thermal or not. - | SourceFluxes application if isThermal is enabled : - | - negative value (injection): the mass balance equation is modified to considered the additional source term, - | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. - | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== ->>>>>>> origin/develop diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst index 870cbdbf3be..deebaede0d7 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst @@ -1,42 +1,48 @@ -=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst new file mode 100644 index 00000000000..4469a1885d7 --- /dev/null +++ b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst @@ -0,0 +1,52 @@ + + +========================= ====================================================== =============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ====================================================== =============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on number of elements for each fracture states + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on residuals values + | logLevel >= 2 and target set is empty + | - Warning about boundary conditions + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== + + diff --git a/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst new file mode 100644 index 00000000000..1a9ad823675 --- /dev/null +++ b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst @@ -0,0 +1,16 @@ + + +========================= ====================================================================================================================================================== ===================================================================== +Name Type Description +========================= ====================================================================================================================================================== ===================================================================== +contactRelationName groupNameRef Name of contact relation to enforce constraints on fracture boundary. +maxForce real64 The maximum force contribution in the problem domain. +maxStableDt real64 Value of the Maximum Stable Timestep for this solver. +meshTargets geos_mapBase, LvArray_Array, int, LvArray_ChaiBuffer>, std_integral_constant > MeshBody/Region combinations that the solver will be applied to. +surfaceGeneratorName string Name of the surface generator to use +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ===================================================================== + + diff --git a/src/coreComponents/schema/docs/Solvers.rst b/src/coreComponents/schema/docs/Solvers.rst index 87f18a99508..a8779059e55 100644 --- a/src/coreComponents/schema/docs/Solvers.rst +++ b/src/coreComponents/schema/docs/Solvers.rst @@ -1,47 +1,49 @@ -============================================= ======== =========== ======================================================== -Name Type Default Description -============================================= ======== =========== ======================================================== -gravityVector R1Tensor {0,0,-9.81} Gravity vector used in the physics solvers -AcousticElasticSEM node :ref:`XML_AcousticElasticSEM` -AcousticFirstOrderSEM node :ref:`XML_AcousticFirstOrderSEM` -AcousticSEM node :ref:`XML_AcousticSEM` -AcousticVTISEM node :ref:`XML_AcousticVTISEM` -CompositionalMultiphaseFVM node :ref:`XML_CompositionalMultiphaseFVM` -CompositionalMultiphaseHybridFVM node :ref:`XML_CompositionalMultiphaseHybridFVM` -CompositionalMultiphaseReservoir node :ref:`XML_CompositionalMultiphaseReservoir` -CompositionalMultiphaseReservoirPoromechanics node :ref:`XML_CompositionalMultiphaseReservoirPoromechanics` -CompositionalMultiphaseWell node :ref:`XML_CompositionalMultiphaseWell` -ElasticFirstOrderSEM node :ref:`XML_ElasticFirstOrderSEM` -ElasticSEM node :ref:`XML_ElasticSEM` -EmbeddedSurfaceGenerator node :ref:`XML_EmbeddedSurfaceGenerator` -FlowProppantTransport node :ref:`XML_FlowProppantTransport` -Hydrofracture node :ref:`XML_Hydrofracture` -LaplaceFEM node :ref:`XML_LaplaceFEM` -MultiphasePoromechanics node :ref:`XML_MultiphasePoromechanics` -MultiphasePoromechanicsReservoir node :ref:`XML_MultiphasePoromechanicsReservoir` -PhaseFieldDamageFEM node :ref:`XML_PhaseFieldDamageFEM` -PhaseFieldFracture node :ref:`XML_PhaseFieldFracture` -ProppantTransport node :ref:`XML_ProppantTransport` -ReactiveCompositionalMultiphaseOBL node :ref:`XML_ReactiveCompositionalMultiphaseOBL` -SeismicityRate node :ref:`XML_SeismicityRate` -SinglePhaseFVM node :ref:`XML_SinglePhaseFVM` -SinglePhaseHybridFVM node :ref:`XML_SinglePhaseHybridFVM` -SinglePhasePoromechanics node :ref:`XML_SinglePhasePoromechanics` -SinglePhasePoromechanicsConformingFractures node :ref:`XML_SinglePhasePoromechanicsConformingFractures` -SinglePhasePoromechanicsEmbeddedFractures node :ref:`XML_SinglePhasePoromechanicsEmbeddedFractures` -SinglePhasePoromechanicsReservoir node :ref:`XML_SinglePhasePoromechanicsReservoir` -SinglePhaseProppantFVM node :ref:`XML_SinglePhaseProppantFVM` -SinglePhaseReservoir node :ref:`XML_SinglePhaseReservoir` -SinglePhaseReservoirPoromechanics node :ref:`XML_SinglePhaseReservoirPoromechanics` -SinglePhaseWell node :ref:`XML_SinglePhaseWell` -SolidMechanicsEmbeddedFractures node :ref:`XML_SolidMechanicsEmbeddedFractures` -SolidMechanicsLagrangeContact node :ref:`XML_SolidMechanicsLagrangeContact` -SolidMechanicsLagrangianSSLE node :ref:`XML_SolidMechanicsLagrangianSSLE` -SolidMechanics_LagrangianFEM node :ref:`XML_SolidMechanics_LagrangianFEM` -SolidMechanics_MPM node :ref:`XML_SolidMechanics_MPM` -SurfaceGenerator node :ref:`XML_SurfaceGenerator` -============================================= ======== =========== ======================================================== +==================================================== ======== =========== =============================================================== +Name Type Default Description +==================================================== ======== =========== =============================================================== +gravityVector R1Tensor {0,0,-9.81} Gravity vector used in the physics solvers +AcousticElasticSEM node :ref:`XML_AcousticElasticSEM` +AcousticFirstOrderSEM node :ref:`XML_AcousticFirstOrderSEM` +AcousticSEM node :ref:`XML_AcousticSEM` +AcousticVTISEM node :ref:`XML_AcousticVTISEM` +CompositionalMultiphaseFVM node :ref:`XML_CompositionalMultiphaseFVM` +CompositionalMultiphaseHybridFVM node :ref:`XML_CompositionalMultiphaseHybridFVM` +CompositionalMultiphaseReservoir node :ref:`XML_CompositionalMultiphaseReservoir` +CompositionalMultiphaseReservoirPoromechanics node :ref:`XML_CompositionalMultiphaseReservoirPoromechanics` +CompositionalMultiphaseWell node :ref:`XML_CompositionalMultiphaseWell` +ElasticFirstOrderSEM node :ref:`XML_ElasticFirstOrderSEM` +ElasticSEM node :ref:`XML_ElasticSEM` +EmbeddedSurfaceGenerator node :ref:`XML_EmbeddedSurfaceGenerator` +FlowProppantTransport node :ref:`XML_FlowProppantTransport` +Hydrofracture node :ref:`XML_Hydrofracture` +LaplaceFEM node :ref:`XML_LaplaceFEM` +MultiphasePoromechanics node :ref:`XML_MultiphasePoromechanics` +MultiphasePoromechanicsReservoir node :ref:`XML_MultiphasePoromechanicsReservoir` +PhaseFieldDamageFEM node :ref:`XML_PhaseFieldDamageFEM` +PhaseFieldFracture node :ref:`XML_PhaseFieldFracture` +ProppantTransport node :ref:`XML_ProppantTransport` +ReactiveCompositionalMultiphaseOBL node :ref:`XML_ReactiveCompositionalMultiphaseOBL` +SeismicityRate node :ref:`XML_SeismicityRate` +SinglePhaseFVM node :ref:`XML_SinglePhaseFVM` +SinglePhaseHybridFVM node :ref:`XML_SinglePhaseHybridFVM` +SinglePhasePoromechanics node :ref:`XML_SinglePhasePoromechanics` +SinglePhasePoromechanicsConformingFractures node :ref:`XML_SinglePhasePoromechanicsConformingFractures` +SinglePhasePoromechanicsConformingFracturesReservoir node :ref:`XML_SinglePhasePoromechanicsConformingFracturesReservoir` +SinglePhasePoromechanicsEmbeddedFractures node :ref:`XML_SinglePhasePoromechanicsEmbeddedFractures` +SinglePhasePoromechanicsReservoir node :ref:`XML_SinglePhasePoromechanicsReservoir` +SinglePhaseProppantFVM node :ref:`XML_SinglePhaseProppantFVM` +SinglePhaseReservoir node :ref:`XML_SinglePhaseReservoir` +SinglePhaseReservoirPoromechanics node :ref:`XML_SinglePhaseReservoirPoromechanics` +SinglePhaseWell node :ref:`XML_SinglePhaseWell` +SolidMechanicsAugmentedLagrangianContact node :ref:`XML_SolidMechanicsAugmentedLagrangianContact` +SolidMechanicsEmbeddedFractures node :ref:`XML_SolidMechanicsEmbeddedFractures` +SolidMechanicsLagrangeContact node :ref:`XML_SolidMechanicsLagrangeContact` +SolidMechanicsLagrangianSSLE node :ref:`XML_SolidMechanicsLagrangianSSLE` +SolidMechanics_LagrangianFEM node :ref:`XML_SolidMechanics_LagrangianFEM` +SolidMechanics_MPM node :ref:`XML_SolidMechanics_MPM` +SurfaceGenerator node :ref:`XML_SurfaceGenerator` +==================================================== ======== =========== =============================================================== diff --git a/src/coreComponents/schema/docs/Solvers_other.rst b/src/coreComponents/schema/docs/Solvers_other.rst index 3eca415d7e0..6a42cd06a7c 100644 --- a/src/coreComponents/schema/docs/Solvers_other.rst +++ b/src/coreComponents/schema/docs/Solvers_other.rst @@ -1,46 +1,48 @@ -============================================= ==== ================================================================== -Name Type Description -============================================= ==== ================================================================== -AcousticElasticSEM node :ref:`DATASTRUCTURE_AcousticElasticSEM` -AcousticFirstOrderSEM node :ref:`DATASTRUCTURE_AcousticFirstOrderSEM` -AcousticSEM node :ref:`DATASTRUCTURE_AcousticSEM` -AcousticVTISEM node :ref:`DATASTRUCTURE_AcousticVTISEM` -CompositionalMultiphaseFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseFVM` -CompositionalMultiphaseHybridFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM` -CompositionalMultiphaseReservoir node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoir` -CompositionalMultiphaseReservoirPoromechanics node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoirPoromechanics` -CompositionalMultiphaseWell node :ref:`DATASTRUCTURE_CompositionalMultiphaseWell` -ElasticFirstOrderSEM node :ref:`DATASTRUCTURE_ElasticFirstOrderSEM` -ElasticSEM node :ref:`DATASTRUCTURE_ElasticSEM` -EmbeddedSurfaceGenerator node :ref:`DATASTRUCTURE_EmbeddedSurfaceGenerator` -FlowProppantTransport node :ref:`DATASTRUCTURE_FlowProppantTransport` -Hydrofracture node :ref:`DATASTRUCTURE_Hydrofracture` -LaplaceFEM node :ref:`DATASTRUCTURE_LaplaceFEM` -MultiphasePoromechanics node :ref:`DATASTRUCTURE_MultiphasePoromechanics` -MultiphasePoromechanicsReservoir node :ref:`DATASTRUCTURE_MultiphasePoromechanicsReservoir` -PhaseFieldDamageFEM node :ref:`DATASTRUCTURE_PhaseFieldDamageFEM` -PhaseFieldFracture node :ref:`DATASTRUCTURE_PhaseFieldFracture` -ProppantTransport node :ref:`DATASTRUCTURE_ProppantTransport` -ReactiveCompositionalMultiphaseOBL node :ref:`DATASTRUCTURE_ReactiveCompositionalMultiphaseOBL` -SeismicityRate node :ref:`DATASTRUCTURE_SeismicityRate` -SinglePhaseFVM node :ref:`DATASTRUCTURE_SinglePhaseFVM` -SinglePhaseHybridFVM node :ref:`DATASTRUCTURE_SinglePhaseHybridFVM` -SinglePhasePoromechanics node :ref:`DATASTRUCTURE_SinglePhasePoromechanics` -SinglePhasePoromechanicsConformingFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFractures` -SinglePhasePoromechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFractures` -SinglePhasePoromechanicsReservoir node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsReservoir` -SinglePhaseProppantFVM node :ref:`DATASTRUCTURE_SinglePhaseProppantFVM` -SinglePhaseReservoir node :ref:`DATASTRUCTURE_SinglePhaseReservoir` -SinglePhaseReservoirPoromechanics node :ref:`DATASTRUCTURE_SinglePhaseReservoirPoromechanics` -SinglePhaseWell node :ref:`DATASTRUCTURE_SinglePhaseWell` -SolidMechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SolidMechanicsEmbeddedFractures` -SolidMechanicsLagrangeContact node :ref:`DATASTRUCTURE_SolidMechanicsLagrangeContact` -SolidMechanicsLagrangianSSLE node :ref:`DATASTRUCTURE_SolidMechanicsLagrangianSSLE` -SolidMechanics_LagrangianFEM node :ref:`DATASTRUCTURE_SolidMechanics_LagrangianFEM` -SolidMechanics_MPM node :ref:`DATASTRUCTURE_SolidMechanics_MPM` -SurfaceGenerator node :ref:`DATASTRUCTURE_SurfaceGenerator` -============================================= ==== ================================================================== +==================================================== ==== ========================================================================= +Name Type Description +==================================================== ==== ========================================================================= +AcousticElasticSEM node :ref:`DATASTRUCTURE_AcousticElasticSEM` +AcousticFirstOrderSEM node :ref:`DATASTRUCTURE_AcousticFirstOrderSEM` +AcousticSEM node :ref:`DATASTRUCTURE_AcousticSEM` +AcousticVTISEM node :ref:`DATASTRUCTURE_AcousticVTISEM` +CompositionalMultiphaseFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseFVM` +CompositionalMultiphaseHybridFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM` +CompositionalMultiphaseReservoir node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoir` +CompositionalMultiphaseReservoirPoromechanics node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoirPoromechanics` +CompositionalMultiphaseWell node :ref:`DATASTRUCTURE_CompositionalMultiphaseWell` +ElasticFirstOrderSEM node :ref:`DATASTRUCTURE_ElasticFirstOrderSEM` +ElasticSEM node :ref:`DATASTRUCTURE_ElasticSEM` +EmbeddedSurfaceGenerator node :ref:`DATASTRUCTURE_EmbeddedSurfaceGenerator` +FlowProppantTransport node :ref:`DATASTRUCTURE_FlowProppantTransport` +Hydrofracture node :ref:`DATASTRUCTURE_Hydrofracture` +LaplaceFEM node :ref:`DATASTRUCTURE_LaplaceFEM` +MultiphasePoromechanics node :ref:`DATASTRUCTURE_MultiphasePoromechanics` +MultiphasePoromechanicsReservoir node :ref:`DATASTRUCTURE_MultiphasePoromechanicsReservoir` +PhaseFieldDamageFEM node :ref:`DATASTRUCTURE_PhaseFieldDamageFEM` +PhaseFieldFracture node :ref:`DATASTRUCTURE_PhaseFieldFracture` +ProppantTransport node :ref:`DATASTRUCTURE_ProppantTransport` +ReactiveCompositionalMultiphaseOBL node :ref:`DATASTRUCTURE_ReactiveCompositionalMultiphaseOBL` +SeismicityRate node :ref:`DATASTRUCTURE_SeismicityRate` +SinglePhaseFVM node :ref:`DATASTRUCTURE_SinglePhaseFVM` +SinglePhaseHybridFVM node :ref:`DATASTRUCTURE_SinglePhaseHybridFVM` +SinglePhasePoromechanics node :ref:`DATASTRUCTURE_SinglePhasePoromechanics` +SinglePhasePoromechanicsConformingFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFractures` +SinglePhasePoromechanicsConformingFracturesReservoir node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesReservoir` +SinglePhasePoromechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFractures` +SinglePhasePoromechanicsReservoir node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsReservoir` +SinglePhaseProppantFVM node :ref:`DATASTRUCTURE_SinglePhaseProppantFVM` +SinglePhaseReservoir node :ref:`DATASTRUCTURE_SinglePhaseReservoir` +SinglePhaseReservoirPoromechanics node :ref:`DATASTRUCTURE_SinglePhaseReservoirPoromechanics` +SinglePhaseWell node :ref:`DATASTRUCTURE_SinglePhaseWell` +SolidMechanicsAugmentedLagrangianContact node :ref:`DATASTRUCTURE_SolidMechanicsAugmentedLagrangianContact` +SolidMechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SolidMechanicsEmbeddedFractures` +SolidMechanicsLagrangeContact node :ref:`DATASTRUCTURE_SolidMechanicsLagrangeContact` +SolidMechanicsLagrangianSSLE node :ref:`DATASTRUCTURE_SolidMechanicsLagrangianSSLE` +SolidMechanics_LagrangianFEM node :ref:`DATASTRUCTURE_SolidMechanics_LagrangianFEM` +SolidMechanics_MPM node :ref:`DATASTRUCTURE_SolidMechanics_MPM` +SurfaceGenerator node :ref:`DATASTRUCTURE_SurfaceGenerator` +==================================================== ==== ========================================================================= diff --git a/src/coreComponents/schema/docs/SourceFlux.rst b/src/coreComponents/schema/docs/SourceFlux.rst index 79e40b56f97..9322448e819 100644 --- a/src/coreComponents/schema/docs/SourceFlux.rst +++ b/src/coreComponents/schema/docs/SourceFlux.rst @@ -1,6 +1,5 @@ -<<<<<<< HEAD ====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== Name Type Default Description ====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== @@ -30,23 +29,5 @@ objectPath groupNameRef Path to the target field scale real64 0 Scale factor for value of the boundary condition. setNames groupNameRef_array required Name of sets that boundary condition is applied to. ====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -======= -====================== ================== ======== ======================================================================================================================================================================================================================================================================================== -Name Type Default Description -====================== ================== ======== ======================================================================================================================================================================================================================================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -functionName groupNameRef Name of a function that specifies the variation of the production rate variations of this SourceFlux.Multiplied by scale. If no function is provided, a constant value of 1 is used.The producted fluid rate unit is in kg by default, or in mole if the flow solver has a useMass of 0. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Multiplier of the functionName value. If no functionName is provided, this value is used directly. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ======================================================================================================================================================================================================================================================================================== ->>>>>>> origin/develop diff --git a/src/coreComponents/schema/docs/SourceFluxStatistics.rst b/src/coreComponents/schema/docs/SourceFluxStatistics.rst index a5ef4f42a89..4fc2c18b85f 100644 --- a/src/coreComponents/schema/docs/SourceFluxStatistics.rst +++ b/src/coreComponents/schema/docs/SourceFluxStatistics.rst @@ -1,16 +1,16 @@ -============== ================== ======== ===================================================================================================================================================================================== -Name Type Default Description -============== ================== ======== ===================================================================================================================================================================================== -flowSolverName groupNameRef required Name of the flow solver -fluxNames groupNameRef_array {*} Name(s) array of the SourceFlux(s) for which we want the statistics. Use "*" to target all SourceFlux. -logLevel integer 0 | Log level - | - Log Level 1 outputs the sum of all SourceFlux(s) produced rate & mass, - | - Log Level 2 details values for each SourceFlux, - | - Log Level 3 details values for each region. -name groupName required A name is required for any non-unique nodes -writeCSV integer 0 Write statistics into a CSV file -============== ================== ======== ===================================================================================================================================================================================== +============== ================== ======== ============================================================================================================================================================================ +Name Type Default Description +============== ================== ======== ============================================================================================================================================================================ +flowSolverName groupNameRef required Name of the flow solver +fluxNames groupNameRef_array {*} Name(s) array of the SourceFlux(s) for which we want the statistics. Use "*" to target all SourceFlux. +logLevel integer 0 | + | - Log Level 1 outputs the sum of all SourceFlux(s) produced rate & mass, + | - Log Level 2 details values for each SourceFlux, + | - Log Level 3 details values for each region. +name groupName required A name is required for any non-unique nodes +writeCSV integer 0 Write statistics into a CSV file +============== ================== ======== ============================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/Tasks.rst b/src/coreComponents/schema/docs/Tasks.rst index 4b2e9649e5a..7531175fa44 100644 --- a/src/coreComponents/schema/docs/Tasks.rst +++ b/src/coreComponents/schema/docs/Tasks.rst @@ -11,6 +11,8 @@ PVTDriver node :ref:`X PackCollection node :ref:`XML_PackCollection` ReactiveFluidDriver node :ref:`XML_ReactiveFluidDriver` RelpermDriver node :ref:`XML_RelpermDriver` +SinglePhasePoromechanicsConformingFracturesInitialization node :ref:`XML_SinglePhasePoromechanicsConformingFracturesInitialization` +SinglePhasePoromechanicsEmbeddedFracturesInitialization node :ref:`XML_SinglePhasePoromechanicsEmbeddedFracturesInitialization` SinglePhasePoromechanicsInitialization node :ref:`XML_SinglePhasePoromechanicsInitialization` SinglePhaseReservoirPoromechanicsInitialization node :ref:`XML_SinglePhaseReservoirPoromechanicsInitialization` SinglePhaseStatistics node :ref:`XML_SinglePhaseStatistics` diff --git a/src/coreComponents/schema/docs/Tasks_other.rst b/src/coreComponents/schema/docs/Tasks_other.rst index 991b7d3f475..7abafe4b3b2 100644 --- a/src/coreComponents/schema/docs/Tasks_other.rst +++ b/src/coreComponents/schema/docs/Tasks_other.rst @@ -11,6 +11,8 @@ PVTDriver node :ref:`DATASTRUC PackCollection node :ref:`DATASTRUCTURE_PackCollection` ReactiveFluidDriver node :ref:`DATASTRUCTURE_ReactiveFluidDriver` RelpermDriver node :ref:`DATASTRUCTURE_RelpermDriver` +SinglePhasePoromechanicsConformingFracturesInitialization node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesInitialization` +SinglePhasePoromechanicsEmbeddedFracturesInitialization node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFracturesInitialization` SinglePhasePoromechanicsInitialization node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsInitialization` SinglePhaseReservoirPoromechanicsInitialization node :ref:`DATASTRUCTURE_SinglePhaseReservoirPoromechanicsInitialization` SinglePhaseStatistics node :ref:`DATASTRUCTURE_SinglePhaseStatistics` diff --git a/src/coreComponents/schema/docs/VTK.rst b/src/coreComponents/schema/docs/VTK.rst index 002ceb9367b..842a9c48625 100644 --- a/src/coreComponents/schema/docs/VTK.rst +++ b/src/coreComponents/schema/docs/VTK.rst @@ -14,7 +14,8 @@ parallelThreads integer 1 Number of plot file plotFileRoot string VTK Name of the root file for this output. plotLevel integer 1 Level detail plot. Only fields with lower of equal plot level will be output. writeFEMFaces integer 0 (no description available) -writeGhostCells integer 0 Should the face elements be written as 3d volumes or not. +writeFaceElementsAs3D integer 0 Should the face elements be written as 3d volumes or not. +writeGhostCells integer 0 Should the vtk files contain the ghost cells or not. =========================== ======================= ======== ======================================================================================================================================================================================== diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index 9528c8931f6..e65a8a1fcdd 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -50,12 +50,12 @@ - + - + @@ -413,6 +413,10 @@ + + + + @@ -437,6 +441,10 @@ + + + + @@ -495,6 +503,14 @@ + + + + + + + + @@ -1302,7 +1318,7 @@ logLevel >= 1 first nonlinear iteration - + @@ -1323,7 +1339,7 @@ logLevel >= 1 first nonlinear iteration - + @@ -2259,7 +2275,9 @@ logLevel == 1 - + + + @@ -2307,6 +2325,7 @@ logLevel == 1 + @@ -2318,6 +2337,7 @@ logLevel == 1 + @@ -2375,6 +2395,8 @@ logLevel >= 3 + + @@ -2430,6 +2452,10 @@ logLevel >= 3 + + + + @@ -2438,11 +2464,16 @@ logLevel >= 3 - + + + + + + @@ -2453,6 +2484,8 @@ logLevel >= 3 + + @@ -2509,6 +2542,10 @@ logLevel >= 3 + + + + @@ -2517,7 +2554,7 @@ logLevel >= 3 - + @@ -2527,6 +2564,8 @@ logLevel >= 3 + + @@ -2582,6 +2621,10 @@ logLevel >= 3 + + + + @@ -2590,7 +2633,7 @@ logLevel >= 3 - + @@ -2665,6 +2708,8 @@ logLevel >= 3 + + @@ -2695,6 +2740,8 @@ logLevel >= 3 + + @@ -2774,6 +2821,8 @@ logLevel >= 3 + + @@ -2796,6 +2845,8 @@ logLevel >= 3 + + @@ -2899,14 +2950,14 @@ logLevel >= 3 - + - + @@ -2962,12 +3013,16 @@ logLevel >= 3 + + - + + + @@ -3050,6 +3105,8 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> + + @@ -3105,6 +3162,10 @@ logLevel >= 3 + + + + @@ -3113,7 +3174,7 @@ logLevel >= 3 - + @@ -3123,6 +3184,8 @@ logLevel >= 3 + + @@ -3178,6 +3241,10 @@ logLevel >= 3 + + + + @@ -3190,7 +3257,7 @@ logLevel >= 3 - + @@ -3340,6 +3407,15 @@ logLevel >= 3 + + + + + + @@ -3445,14 +3521,14 @@ logLevel >= 3 - + - + @@ -3802,7 +3878,7 @@ logLevel >= 3 - - + + + + + + @@ -3993,8 +4078,61 @@ logLevel >= 3 + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4039,6 +4177,15 @@ logLevel >= 3 + + + + + + @@ -4101,7 +4248,7 @@ logLevel >= 3 - + + + + + + @@ -4281,7 +4437,7 @@ logLevel >= 3 - + @@ -4300,7 +4456,6 @@ logLevel >= 1 - Information on the timestep - Print residual norm - Information on number of elements for each fracture states - - Infos on residual norm for each fractures logLevel >= 1 and configuration didn't converge - Information about testing new configuration and print the time step logLevel >= 1 and incorrect solution @@ -4340,8 +4495,6 @@ logLevel >= 3 * ImplicitDynamic * ExplicitDynamic--> - - @@ -4350,6 +4503,70 @@ logLevel >= 3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4694,6 +4911,8 @@ logLevel >= 3 + + @@ -4743,7 +4962,10 @@ logLevel >= 1 and pore volume equal 0 - + @@ -4851,6 +5073,32 @@ logLevel >= 1 + + + + + + + + + + + + + + + + + + + + - diff --git a/src/coreComponents/schema/schema.xsd.other b/src/coreComponents/schema/schema.xsd.other index a0fbfc4a731..89d10b3ae4e 100644 --- a/src/coreComponents/schema/schema.xsd.other +++ b/src/coreComponents/schema/schema.xsd.other @@ -50,12 +50,12 @@ - + - + @@ -528,12 +528,14 @@ + + @@ -1074,6 +1076,19 @@ + + + + + + + + + + + + + @@ -1155,6 +1170,23 @@ + + + + + + + + + + + + + + + + + @@ -1301,6 +1333,8 @@ + + @@ -1318,6 +1352,8 @@ + + diff --git a/src/docs/sphinx/CompleteXMLSchema.rst b/src/docs/sphinx/CompleteXMLSchema.rst index d15f17166bd..4fa19cfebea 100644 --- a/src/docs/sphinx/CompleteXMLSchema.rst +++ b/src/docs/sphinx/CompleteXMLSchema.rst @@ -1095,6 +1095,20 @@ Element: SinglePhasePoromechanicsConformingFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst +.. _XML_SinglePhasePoromechanicsConformingFracturesInitialization: + +Element: SinglePhasePoromechanicsConformingFracturesInitialization +================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst + + +.. _XML_SinglePhasePoromechanicsConformingFracturesReservoir: + +Element: SinglePhasePoromechanicsConformingFracturesReservoir +============================================================= +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst + + .. _XML_SinglePhasePoromechanicsEmbeddedFractures: Element: SinglePhasePoromechanicsEmbeddedFractures @@ -1102,6 +1116,13 @@ Element: SinglePhasePoromechanicsEmbeddedFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst +.. _XML_SinglePhasePoromechanicsEmbeddedFracturesInitialization: + +Element: SinglePhasePoromechanicsEmbeddedFracturesInitialization +================================================================ +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst + + .. _XML_SinglePhasePoromechanicsInitialization: Element: SinglePhasePoromechanicsInitialization @@ -1172,6 +1193,13 @@ Element: SolidInternalEnergy .. include:: ../../coreComponents/schema/docs/SolidInternalEnergy.rst +.. _XML_SolidMechanicsAugmentedLagrangianContact: + +Element: SolidMechanicsAugmentedLagrangianContact +================================================= +.. include:: ../../coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst + + .. _XML_SolidMechanicsEmbeddedFractures: Element: SolidMechanicsEmbeddedFractures @@ -2562,6 +2590,20 @@ Datastructure: SinglePhasePoromechanicsConformingFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures_other.rst +.. _DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesInitialization: + +Datastructure: SinglePhasePoromechanicsConformingFracturesInitialization +======================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst + + +.. _DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesReservoir: + +Datastructure: SinglePhasePoromechanicsConformingFracturesReservoir +=================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst + + .. _DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFractures: Datastructure: SinglePhasePoromechanicsEmbeddedFractures @@ -2569,6 +2611,13 @@ Datastructure: SinglePhasePoromechanicsEmbeddedFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures_other.rst +.. _DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFracturesInitialization: + +Datastructure: SinglePhasePoromechanicsEmbeddedFracturesInitialization +====================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst + + .. _DATASTRUCTURE_SinglePhasePoromechanicsInitialization: Datastructure: SinglePhasePoromechanicsInitialization @@ -2639,6 +2688,13 @@ Datastructure: SolidInternalEnergy .. include:: ../../coreComponents/schema/docs/SolidInternalEnergy_other.rst +.. _DATASTRUCTURE_SolidMechanicsAugmentedLagrangianContact: + +Datastructure: SolidMechanicsAugmentedLagrangianContact +======================================================= +.. include:: ../../coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst + + .. _DATASTRUCTURE_SolidMechanicsEmbeddedFractures: Datastructure: SolidMechanicsEmbeddedFractures From c56f007a7a73cf9b53d490a18a16df1dea2f0a0d Mon Sep 17 00:00:00 2001 From: arng40 Date: Thu, 27 Jun 2024 10:31:12 +0200 Subject: [PATCH 17/18] small update --- src/coreComponents/dataRepository/Group.cpp | 7 +------ src/coreComponents/dataRepository/Group.hpp | 7 ------- 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index c2c6f2eb6b5..f86b1907b4e 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -79,11 +79,6 @@ void Group::deregisterWrapper( string const & name ) m_conduitNode.remove( name ); } -void Group::addLogLevelEntry( string_view level, string_view description ) -{ - m_logLevelsDescriptions[ string( level ) ].push_back( string( description ) ); -} - void Group::appendLogLevelDescription( string_view levelCondition, string_view logDescription ) { Wrapper< integer > * wrapper = getWrapperPointer< integer >( viewKeyStruct::logLevelString() ); @@ -93,7 +88,7 @@ void Group::appendLogLevelDescription( string_view levelCondition, string_view l wrapper->setApplyDefaultValue( 0 ); wrapper->setInputFlag( InputFlags::OPTIONAL ); } - addLogLevelEntry( levelCondition, logDescription ); + m_logLevelsDescriptions[ string( levelCondition ) ].push_back( string( logDescription ) ); wrapper->buildLogLevelDescription( m_logLevelsDescriptions ); } diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index eb559826ca0..a17878bf623 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -1486,13 +1486,6 @@ class Group integer getLogLevel() const { return m_logLevel; } ///@} - /** - * @brief Add an entry to the description map - * @param level The log level key - * @param description The log description value - */ - void addLogLevelEntry( string_view level, string_view description ); - /** * @brief Performs re-initialization of certain variable depending on the solver being used. */ From 47cb158af10869b5cb376625313e501e4972eac6 Mon Sep 17 00:00:00 2001 From: arng40 Date: Thu, 11 Jul 2024 11:29:27 +0200 Subject: [PATCH 18/18] =?UTF-8?q?some=20cleaning=20=E2=9A=A1=EF=B8=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../multifluid/CO2Brine/CO2BrineFluid.cpp | 2 +- .../fluid/multifluid/PVTDriver.cpp | 4 +- .../reactive/ReactiveBrineFluid.cpp | 2 +- .../reactive/ReactiveFluidDriver.cpp | 4 +- .../relativePermeability/RelpermDriver.cpp | 4 +- .../constitutive/solid/TriaxialDriver.cpp | 4 +- src/coreComponents/dataRepository/Group.cpp | 2 +- src/coreComponents/dataRepository/Group.hpp | 2 +- .../dataRepository/WrapperBase.hpp | 20 ++++---- src/coreComponents/events/EventBase.cpp | 2 +- src/coreComponents/events/EventManager.cpp | 2 +- .../AquiferBoundaryCondition.cpp | 2 +- .../FieldSpecificationBase.cpp | 6 +-- .../SourceFluxBoundaryCondition.cpp | 8 ++-- .../fileIO/Outputs/ChomboIO.cpp | 2 +- .../fileIO/Outputs/VTKOutput.cpp | 2 +- src/coreComponents/mesh/DomainPartition.cpp | 2 +- src/coreComponents/mesh/MeshManager.cpp | 2 +- .../mesh/generators/VTKMeshGenerator.cpp | 6 +-- .../mesh/generators/VTKWellGenerator.cpp | 2 +- .../mesh/generators/WellGeneratorBase.cpp | 2 +- .../mesh/simpleGeometricObjects/Rectangle.cpp | 2 +- .../physicsSolvers/FieldStatisticsBase.hpp | 4 +- .../physicsSolvers/LinearSolverParameters.cpp | 46 +++++++++---------- .../NonlinearSolverParameters.cpp | 2 +- .../physicsSolvers/SolverBase.cpp | 22 ++++----- .../contact/ContactSolverBase.cpp | 2 +- .../SolidMechanicsEmbeddedFractures.cpp | 2 +- .../contact/SolidMechanicsLagrangeContact.cpp | 2 +- .../fluidFlow/CompositionalMultiphaseBase.cpp | 12 ++--- .../fluidFlow/CompositionalMultiphaseFVM.cpp | 16 +++---- .../CompositionalMultiphaseHybridFVM.cpp | 2 +- .../CompositionalMultiphaseStatistics.cpp | 6 +-- .../fluidFlow/FlowSolverBase.cpp | 2 +- .../ReactiveCompositionalMultiphaseOBL.cpp | 4 +- .../fluidFlow/SinglePhaseBase.cpp | 4 +- .../fluidFlow/SinglePhaseFVM.cpp | 2 +- .../fluidFlow/SinglePhaseHybridFVM.cpp | 2 +- .../fluidFlow/SinglePhaseStatistics.cpp | 2 +- .../proppantTransport/ProppantTransport.cpp | 2 +- .../wells/CompositionalMultiphaseWell.cpp | 10 ++-- .../fluidFlow/wells/SinglePhaseWell.cpp | 10 ++-- .../fluidFlow/wells/WellControls.cpp | 2 +- ...mpositionalMultiphaseReservoirAndWells.cpp | 2 +- .../multiphysics/CoupledSolver.hpp | 8 ++-- .../FlowProppantTransportSolver.cpp | 2 +- .../multiphysics/HydrofractureSolver.cpp | 6 +-- .../multiphysics/MultiphasePoromechanics.cpp | 2 +- .../PoromechanicsInitialization.cpp | 2 +- ...ePhasePoromechanicsConformingFractures.cpp | 2 +- .../simplePDE/PhaseFieldDamageFEM.cpp | 4 +- .../SolidMechanicsLagrangianFEM.cpp | 4 +- .../SolidMechanicsStateReset.cpp | 4 +- .../SolidMechanicsStatistics.cpp | 2 +- .../EmbeddedSurfaceGenerator.cpp | 4 +- .../surfaceGeneration/SurfaceGenerator.cpp | 12 ++--- .../isotropic/AcousticWaveEquationSEM.cpp | 2 +- .../wavePropagation/shared/WaveSolverBase.cpp | 2 +- 58 files changed, 148 insertions(+), 150 deletions(-) diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index 59833fad945..9deeb2a8ffd 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp @@ -111,7 +111,7 @@ CO2BrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevelDescription( "logLevel >= 1", "Informations on PVT phase table" ); + addLogLevel( "logLevel >= 1", "Informations on PVT phase table" ); } template< typename PHASE1, typename PHASE2, typename FLASH > diff --git a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp index 615fa47ace8..b0791d5a644 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/PVTDriver.cpp @@ -89,8 +89,8 @@ PVTDriver::PVTDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription( "logLevel >= 1", "Informations about PVT Driver" ); - appendLogLevelDescription( "logLevel >= 1", "Indicate consistency of results" ); + addLogLevel( "logLevel >= 1", "Informations about PVT Driver" ); + addLogLevel( "logLevel >= 1", "Indicate consistency of results" ); } void PVTDriver::postProcessInput() diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index 869e54085f3..95811ba665b 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -80,7 +80,7 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setRestartFlags( RestartFlags::WRITE_AND_READ ); } - appendLogLevelDescription( "logLevel >= 1", "Information on phase PVT Table" ); + addLogLevel( "logLevel >= 1", "Information on phase PVT Table" ); } template< typename PHASE > diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp index e1aba8f59fb..7484020f7ab 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveFluidDriver.cpp @@ -65,8 +65,8 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription( "logLevel >= 1", "Information on ReactiveFluidDriver" ); - appendLogLevelDescription( "logLevel >= 1", "Indicate at the end if the internal results are consistent" ); + addLogLevel( "logLevel >= 1", "Information on ReactiveFluidDriver" ); + addLogLevel( "logLevel >= 1", "Indicate at the end if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp index 4dfa3fd5426..cf8a36f7c39 100644 --- a/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp +++ b/src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp @@ -51,8 +51,8 @@ RelpermDriver::RelpermDriver( const geos::string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription( "logLevel >= 1", "Information on RelpermDriver" ); - appendLogLevelDescription( "logLevel >= 1", "Indicate if the internal results are consistent" ); + addLogLevel( "logLevel >= 1", "Information on RelpermDriver" ); + addLogLevel( "logLevel >= 1", "Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp index 1cdc8f7294f..4047f6a5eaa 100644 --- a/src/coreComponents/constitutive/solid/TriaxialDriver.cpp +++ b/src/coreComponents/constitutive/solid/TriaxialDriver.cpp @@ -66,8 +66,8 @@ TriaxialDriver::TriaxialDriver( const string & name, setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); - appendLogLevelDescription( "logLevel >= 1", "Information on TriaxialDriver" ); - appendLogLevelDescription( "logLevel >= 1", "Indicate if the internal results are consistent" ); + addLogLevel( "logLevel >= 1", "Information on TriaxialDriver" ); + addLogLevel( "logLevel >= 1", "Indicate if the internal results are consistent" ); } diff --git a/src/coreComponents/dataRepository/Group.cpp b/src/coreComponents/dataRepository/Group.cpp index f86b1907b4e..12be51a6cce 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -79,7 +79,7 @@ void Group::deregisterWrapper( string const & name ) m_conduitNode.remove( name ); } -void Group::appendLogLevelDescription( string_view levelCondition, string_view logDescription ) +void Group::addLogLevel( string_view levelCondition, string_view logDescription ) { Wrapper< integer > * wrapper = getWrapperPointer< integer >( viewKeyStruct::logLevelString() ); if( wrapper == nullptr ) diff --git a/src/coreComponents/dataRepository/Group.hpp b/src/coreComponents/dataRepository/Group.hpp index a17878bf623..7b6030e4d15 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -859,7 +859,7 @@ class Group * @param levelCondition The level condition to append * @param logDescription The log description to append */ - void appendLogLevelDescription( string_view levelCondition, string_view logDescription ); + void addLogLevel( string_view levelCondition, string_view logDescription ); /** * @name Schema generation methods diff --git a/src/coreComponents/dataRepository/WrapperBase.hpp b/src/coreComponents/dataRepository/WrapperBase.hpp index c6e5018cdd7..cab27ad9baa 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -510,7 +510,7 @@ class WrapperBase /** * @brief Add up more text to the existing description string of the wrapper. - * @param description the description to add to the end of the previous one. + * @param description the description to add * @return a pointer to this wrapper */ WrapperBase & appendDescription( string const & description ) @@ -524,21 +524,19 @@ class WrapperBase */ void buildLogLevelDescription( std::map< std::string, std::vector< std::string > > const & logLevelsDescriptions ) { - string descriptionToBuild; - descriptionToBuild.append( "Sets the level of information to write in the standard output (the console typically).\n" - "A level of 0 outputs minimal information, higher levels require more." ); + std::ostringstream description; + description << "Sets the level of information to write in the standard output (the console typically).\n" + "A level of 0 outputs minimal information, higher levels require more."; for( auto const & [logLevel, logDescriptions] : logLevelsDescriptions ) { - descriptionToBuild.append( GEOS_FMT( "\n{}\n", logLevel ) ); - size_t idxDescription = 0; - for( const auto & description : logDescriptions ) + description << GEOS_FMT( "\n{}\n", logLevel ); + for( size_t idxDesc = 0; idxDesc< logDescriptions.size(); idxDesc++ ) { - idxDescription == logDescriptions.size() - 1 ? descriptionToBuild.append( " - " + description ) - : descriptionToBuild.append( GEOS_FMT( " - {}\n", description ) ); - idxDescription++; + description << " - " << logDescriptions[idxDesc]; + if( idxDesc != logDescriptions.size() - 1 ) description << '\n'; } } - appendDescription( descriptionToBuild ); + appendDescription( description.str() ); } diff --git a/src/coreComponents/events/EventBase.cpp b/src/coreComponents/events/EventBase.cpp index 685f05e65ae..4d7700ca39c 100644 --- a/src/coreComponents/events/EventBase.cpp +++ b/src/coreComponents/events/EventBase.cpp @@ -104,7 +104,7 @@ EventBase::EventBase( const string & name, registerWrapper( viewKeyStruct::isTargetExecutingString(), &m_targetExecFlag ). setDescription( "Index of the current subevent" ); - appendLogLevelDescription( "logLevel >= 1", "Information about sub-event" ); + addLogLevel( "logLevel >= 1", "Information about sub-event" ); } diff --git a/src/coreComponents/events/EventManager.cpp b/src/coreComponents/events/EventManager.cpp index 5834897d403..e8782af8f92 100644 --- a/src/coreComponents/events/EventManager.cpp +++ b/src/coreComponents/events/EventManager.cpp @@ -80,7 +80,7 @@ EventManager::EventManager( string const & name, setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "Format of the time in the GEOS log." ); - appendLogLevelDescription( "logLevel >= 1", "Information about current sub-event" ); + addLogLevel( "logLevel >= 1", "Information about current sub-event" ); } diff --git a/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp b/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp index 8f5838522e8..d15e7cc4eaf 100644 --- a/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp +++ b/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp @@ -111,7 +111,7 @@ AquiferBoundaryCondition::AquiferBoundaryCondition( string const & name, Group * getWrapper< int >( FieldSpecificationBase::viewKeyStruct::componentString() ). setInputFlag( InputFlags::FALSE ); - appendLogLevelDescription( "logLevel >= 1", "Information on boundary conditions" ); + addLogLevel( "logLevel >= 1", "Information on boundary conditions" ); } void AquiferBoundaryCondition::postProcessInput() diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index 45b295e5d65..7bc9b89c9a2 100644 --- a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp +++ b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp @@ -84,9 +84,9 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par setInputFlag( InputFlags::OPTIONAL ). setDescription( "Time at which the boundary condition will stop being applied." ); - appendLogLevelDescription( "logLevel >= 1 and regions with no dof", "Warning about non simulated region" ); - appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Print boundary conditions log messages" ); - appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Information on the face boundary condition defined with pressure and temperature" ); + addLogLevel( "logLevel >= 1 and regions with no dof", "Warning about non simulated region" ); + addLogLevel( "logLevel >= 1 first nonlinear iteration", "Print boundary conditions log messages" ); + addLogLevel( "logLevel >= 1 and first nonlinear iteration", "Information on the face boundary condition defined with pressure and temperature" ); } diff --git a/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp b/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp index a2639d6f957..9289a36d0dc 100644 --- a/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp +++ b/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp @@ -31,10 +31,10 @@ SourceFluxBoundaryCondition::SourceFluxBoundaryCondition( string const & name, G setInputFlag( InputFlags::FALSE ); setFieldName( catalogName() ); - appendLogLevelDescription( "logLevel >= 1 and first newton iteration", "Print the log message issued by the solver if the boundary condition is called" ); - appendLogLevelDescription( "logLevel >= 1 and regions with no dof", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); - appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration", "Information abonout the Dirichlet pressure, temperature boundary conditions" ); - appendLogLevelDescription( "logLevel >= 1 and first nonlinear iteration and this is a thermal simulation", "Information on single phase thermal simulation" ); + addLogLevel( "logLevel >= 1 and first newton iteration", "Print the log message issued by the solver if the boundary condition is called" ); + addLogLevel( "logLevel >= 1 and regions with no dof", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); + addLogLevel( "logLevel >= 1 and first nonlinear iteration", "Information abonout the Dirichlet pressure, temperature boundary conditions" ); + addLogLevel( "logLevel >= 1 and first nonlinear iteration and this is a thermal simulation", "Information on single phase thermal simulation" ); } REGISTER_CATALOG_ENTRY( FieldSpecificationBase, SourceFluxBoundaryCondition, string const &, Group * const ) diff --git a/src/coreComponents/fileIO/Outputs/ChomboIO.cpp b/src/coreComponents/fileIO/Outputs/ChomboIO.cpp index 21bea044374..f63ccf184c8 100644 --- a/src/coreComponents/fileIO/Outputs/ChomboIO.cpp +++ b/src/coreComponents/fileIO/Outputs/ChomboIO.cpp @@ -61,7 +61,7 @@ ChomboIO::ChomboIO( string const & name, Group * const parent ): setDefaultValue( 0 ). setDescription( "True iff geosx should use the pressures chombo writes out." ); - appendLogLevelDescription( "logLevel == 1", "Indicate chombo initializing" ); + addLogLevel( "logLevel == 1", "Indicate chombo initializing" ); } ChomboIO::~ChomboIO() diff --git a/src/coreComponents/fileIO/Outputs/VTKOutput.cpp b/src/coreComponents/fileIO/Outputs/VTKOutput.cpp index 5bad555c380..21a83537785 100644 --- a/src/coreComponents/fileIO/Outputs/VTKOutput.cpp +++ b/src/coreComponents/fileIO/Outputs/VTKOutput.cpp @@ -120,7 +120,7 @@ void VTKOutput::postProcessInput() catalogName(), getDataContext(), std::to_string( m_fieldNames.size() ), fieldNamesString, m_plotLevel ) ); - appendLogLevelDescription( "logLevel >= 1", "Print field name and cycle number during execution" ); + addLogLevel( "logLevel >= 1", "Print field name and cycle number during execution" ); GEOS_ERROR_IF( m_writeFaceElementsAs3D, GEOS_FMT( "{} `{}`: 3D vtk plot of faceElements is not yet supported.", catalogName(), getDataContext() ) ); diff --git a/src/coreComponents/mesh/DomainPartition.cpp b/src/coreComponents/mesh/DomainPartition.cpp index c02ecf46889..449bccc3c4d 100644 --- a/src/coreComponents/mesh/DomainPartition.cpp +++ b/src/coreComponents/mesh/DomainPartition.cpp @@ -46,7 +46,7 @@ DomainPartition::DomainPartition( string const & name, registerGroup( groupKeys.meshBodies ); registerGroup< constitutive::ConstitutiveManager >( groupKeys.constitutiveManager ); - appendLogLevelDescription( "logLevel >= 3", "Indication about setup communication" ); + addLogLevel( "logLevel >= 3", "Indication about setup communication" ); } diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index 9d3650740ac..b6bd0d26ca0 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -37,7 +37,7 @@ MeshManager::MeshManager( string const & name, setInputFlags( InputFlags::REQUIRED ); - appendLogLevelDescription( "logLevel >= 1", "Information on imported field name on region/subRegion" ); + addLogLevel( "logLevel >= 1", "Information on imported field name on region/subRegion" ); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp index 03f2b46d618..deb42dcc00d 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -75,9 +75,9 @@ VTKMeshGenerator::VTKMeshGenerator( string const & name, " If set to a negative value, the GlobalId arrays in the input mesh are not used, and generated global Ids are automatically generated." " If set to a positive value, the GlobalId arrays in the input mesh are used and required, and the simulation aborts if they are not available" ); - appendLogLevelDescription( "logLevel >= 1", "Information on cell block names" ); - appendLogLevelDescription( "logLevel >= 2", "Information on node sets names" ); - appendLogLevelDescription( "logLevel >= 2", "Print the mesh generation step" ); + addLogLevel( "logLevel >= 1", "Information on cell block names" ); + addLogLevel( "logLevel >= 2", "Information on node sets names" ); + addLogLevel( "logLevel >= 2", "Print the mesh generation step" ); } void VTKMeshGenerator::fillCellBlockManager( CellBlockManager & cellBlockManager, SpatialPartition & partition ) diff --git a/src/coreComponents/mesh/generators/VTKWellGenerator.cpp b/src/coreComponents/mesh/generators/VTKWellGenerator.cpp index dc0d94d1849..146195e9eb6 100644 --- a/src/coreComponents/mesh/generators/VTKWellGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKWellGenerator.cpp @@ -37,7 +37,7 @@ VTKWellGenerator::VTKWellGenerator( string const & name, Group * const parent ): setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "Path to the well file" ); - appendLogLevelDescription( "logLevel >= 2", "Indicate the dataset reading" ); + addLogLevel( "logLevel >= 2", "Indicate the dataset reading" ); } void VTKWellGenerator::fillPolylineDataStructure( ) diff --git a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp index 1f82bc8420c..d449c6ffb02 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -76,7 +76,7 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); - appendLogLevelDescription( "logLevel >= 1", "Information on Internal wells and their perforations" ); + addLogLevel( "logLevel >= 1", "Information on Internal wells and their perforations" ); } Group * WellGeneratorBase::createChild( string const & childKey, string const & childName ) diff --git a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp index 7a7955d04f3..063ac92f705 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -42,7 +42,7 @@ Rectangle::Rectangle( const string & name, Group * const parent ): setDescription( "Tolerance to determine if a point sits on the plane or not. " "It is relative to the maximum dimension of the plane." ); - appendLogLevelDescription( "logLevel >= 2", "Information on length and width of the bounded plane" ); + addLogLevel( "logLevel >= 2", "Information on length and width of the bounded plane" ); m_points.resize( 4, 3 ); } diff --git a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp index d4a2ef50173..7182f41bcd8 100644 --- a/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp +++ b/src/coreComponents/physicsSolvers/FieldStatisticsBase.hpp @@ -60,8 +60,8 @@ class FieldStatisticsBase : public TaskBase setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Write statistics into a CSV file" ); - appendLogLevelDescription( "logLevel == 1 and pore volume is zero", "Display warning message" ); - appendLogLevelDescription( "logLevel == 1 ", "Dipslay Indicative message" ); + addLogLevel( "logLevel == 1 and pore volume is zero", "Display warning message" ); + addLogLevel( "logLevel == 1 ", "Dipslay Indicative message" ); } diff --git a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp index a96d53109ba..71b96f87a81 100644 --- a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp @@ -199,29 +199,29 @@ LinearSolverParametersInput::LinearSolverParametersInput( string const & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "ILU(T) threshold factor" ); - appendLogLevelDescription( "logLevel >= 2", "Print information about symbolic and numeric factorization." ); - appendLogLevelDescription( "logLevel >= 2", "Set UMFPACK_PRL to 6" ); - appendLogLevelDescription( "logLevel == 1", "Set UMFPACK_PRL to 1" ); - appendLogLevelDescription( "logLevel >= 1 and incorrect final relative residual norm", "Warning about residual reduction" ); - appendLogLevelDescription( "logLevel >= 1", "Linear solver informations" ); - appendLogLevelDescription( "logLevel >= 1 and incorrect SuperLU residual reduction", "Warning about residual reduction" ); - appendLogLevelDescription( "logLevel >= 1 and SuperLU solver", "Information on result" ); - appendLogLevelDescription( "logLevel >= 2 and SuperLU solver", "Print the statistics." ); - appendLogLevelDescription( "logLevel >= 1 and SuperLU solver", "Print the blocking parameters and options setting" ); - appendLogLevelDescription( "logLevel >= 1 and HypreSolver", "Set print level for mgr solver" ); - appendLogLevelDescription( "logLevel >= 1 and HypreSolver", "Information on MGR preconditioner" ); - appendLogLevelDescription( "logLevel == 2 or logLevel == 4 and HypreSolver", "Set print level for BoomerAMG" ); - appendLogLevelDescription( "logLevel >= 1 and HyprePreconditioner setup not existing", "Indicate arror" ); - appendLogLevelDescription( "logLevel >= 3 and Hypre", "Print convergence + iteration info" ); - appendLogLevelDescription( "logLevel >= 1 and Hypre", "Print results" ); - appendLogLevelDescription( "logLevel >= 3 and PetscSolver ", "Informations on PetscSolver result" ); - appendLogLevelDescription( "logLevel >= 1 and PetscSolver ", "Print the residual/error" ); - appendLogLevelDescription( "logLevel == 1 and TrilinosSover ", "Sets SetAztecOption to AZ_summary" ); - appendLogLevelDescription( "logLevel == 2 and TrilinosSover ", "Sets SetAztecOption to AZ_all" ); - appendLogLevelDescription( "logLevel >= 3 and TrilinosSover ", "Sets SetAztecOption to AZ_none" ); - appendLogLevelDescription( "logLevel >= 2 and KrylovSolver ", "Print residual norms" ); - appendLogLevelDescription( "logLevel >= 2 and KrylovSolver ", "Print the results" ); - appendLogLevelDescription( "logLevel >= 2 and value too close to zero. ", "Information about exit solver iteration" ); + addLogLevel( "logLevel >= 2", "Print information about symbolic and numeric factorization." ); + addLogLevel( "logLevel >= 2", "Set UMFPACK_PRL to 6" ); + addLogLevel( "logLevel == 1", "Set UMFPACK_PRL to 1" ); + addLogLevel( "logLevel >= 1 and incorrect final relative residual norm", "Warning about residual reduction" ); + addLogLevel( "logLevel >= 1", "Linear solver informations" ); + addLogLevel( "logLevel >= 1 and incorrect SuperLU residual reduction", "Warning about residual reduction" ); + addLogLevel( "logLevel >= 1 and SuperLU solver", "Information on result" ); + addLogLevel( "logLevel >= 2 and SuperLU solver", "Print the statistics." ); + addLogLevel( "logLevel >= 1 and SuperLU solver", "Print the blocking parameters and options setting" ); + addLogLevel( "logLevel >= 1 and HypreSolver", "Set print level for mgr solver" ); + addLogLevel( "logLevel >= 1 and HypreSolver", "Information on MGR preconditioner" ); + addLogLevel( "logLevel == 2 or logLevel == 4 and HypreSolver", "Set print level for BoomerAMG" ); + addLogLevel( "logLevel >= 1 and HyprePreconditioner setup not existing", "Indicate arror" ); + addLogLevel( "logLevel >= 3 and Hypre", "Print convergence + iteration info" ); + addLogLevel( "logLevel >= 1 and Hypre", "Print results" ); + addLogLevel( "logLevel >= 3 and PetscSolver ", "Informations on PetscSolver result" ); + addLogLevel( "logLevel >= 1 and PetscSolver ", "Print the residual/error" ); + addLogLevel( "logLevel == 1 and TrilinosSover ", "Sets SetAztecOption to AZ_summary" ); + addLogLevel( "logLevel == 2 and TrilinosSover ", "Sets SetAztecOption to AZ_all" ); + addLogLevel( "logLevel >= 3 and TrilinosSover ", "Sets SetAztecOption to AZ_none" ); + addLogLevel( "logLevel >= 2 and KrylovSolver ", "Print residual norms" ); + addLogLevel( "logLevel >= 2 and KrylovSolver ", "Print the results" ); + addLogLevel( "logLevel >= 2 and value too close to zero. ", "Information about exit solver iteration" ); } void LinearSolverParametersInput::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index 3824cbd1b0b..1d30e24a771 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -173,7 +173,7 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); - appendLogLevelDescription( "logLevel >= 1", "Information on NonLinearSolver parameters" ); + addLogLevel( "logLevel >= 1", "Information on NonLinearSolver parameters" ); } diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index e488f2bfefa..f568cc23c1d 100644 --- a/src/coreComponents/physicsSolvers/SolverBase.cpp +++ b/src/coreComponents/physicsSolvers/SolverBase.cpp @@ -86,17 +86,17 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Initial time-step value required by the solver to the event manager." ); - appendLogLevelDescription( "logLevel >= 1", "Information on line search" ); - appendLogLevelDescription( "logLevel >= 1", "Information on global solution scaling factor" ); - appendLogLevelDescription( "logLevel >= 1", "Information on the timestep" ); - appendLogLevelDescription( "logLevel >= 2", "Output to screen the assembled linear system and solutions (matrices and vectors)" ); - appendLogLevelDescription( "logLevel >= 3", "Output to file the assembled linear system and solutions (matrices and vectors)" ); - appendLogLevelDescription( "logLevel >= 1 and incorrect solution", "Information about line search failed" ); - appendLogLevelDescription( "logLevel >= 1", "Print residual norm" ); - appendLogLevelDescription( "logLevel >= 1 and configuration didn't converge", "Information about testing new configuration and print the time step" ); - appendLogLevelDescription( "logLevel >= 1 and non linear system", "Information on each newton Iteration " ); - appendLogLevelDescription( "logLevel >= 1 and linear system", "Information on number of iterations and residual reduction" ); - appendLogLevelDescription( "logLevel >= 1 and residual norm above the max allowed residual norm", "Indicate allowed residual norm" ); + addLogLevel( "logLevel >= 1", "Information on line search" ); + addLogLevel( "logLevel >= 1", "Information on global solution scaling factor" ); + addLogLevel( "logLevel >= 1", "Information on the timestep" ); + addLogLevel( "logLevel >= 2", "Output to screen the assembled linear system and solutions (matrices and vectors)" ); + addLogLevel( "logLevel >= 3", "Output to file the assembled linear system and solutions (matrices and vectors)" ); + addLogLevel( "logLevel >= 1 and incorrect solution", "Information about line search failed" ); + addLogLevel( "logLevel >= 1", "Print residual norm" ); + addLogLevel( "logLevel >= 1 and configuration didn't converge", "Information about testing new configuration and print the time step" ); + addLogLevel( "logLevel >= 1 and non linear system", "Information on each newton Iteration " ); + addLogLevel( "logLevel >= 1 and linear system", "Information on number of iterations and residual reduction" ); + addLogLevel( "logLevel >= 1 and residual norm above the max allowed residual norm", "Indicate allowed residual norm" ); registerGroup( groupKeyStruct::linearSolverParametersString(), &m_linearSolverParameters ); registerGroup( groupKeyStruct::nonlinearSolverParametersString(), &m_nonlinearSolverParameters ); diff --git a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index 32d70c2ab65..7fe54369099 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -50,7 +50,7 @@ ContactSolverBase::ContactSolverBase( const string & name, this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); - appendLogLevelDescription( "logLevel >= 1", "Information on number of elements for each fracture states" ); + addLogLevel( "logLevel >= 1", "Information on number of elements for each fracture states" ); } void ContactSolverBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp index 4041fb0f183..013c63b5604 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp @@ -51,7 +51,7 @@ SolidMechanicsEmbeddedFractures::SolidMechanicsEmbeddedFractures( const string & setApplyDefaultValue( 0 ). setDescription( "Defines whether to use static condensation or not." ); - appendLogLevelDescription( "logLevel >= 1", "Infos on residual norm for each fractures" ); + addLogLevel( "logLevel >= 1", "Infos on residual norm for each fractures" ); } SolidMechanicsEmbeddedFractures::~SolidMechanicsEmbeddedFractures() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp index 2ff7db5a36e..15955d34109 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp @@ -69,7 +69,7 @@ SolidMechanicsLagrangeContact::SolidMechanicsLagrangeContact( const string & nam setApplyDefaultValue( 1.0 ). setDescription( "It be used to increase the scale of the stabilization entries. A value < 1.0 results in larger entries in the stabilization matrix." ); - appendLogLevelDescription( "logLevel >= 1", "Infos on risidual norm (Rdisplacement, Rtraction, Rtotal)" ); + addLogLevel( "logLevel >= 1", "Infos on risidual norm (Rdisplacement, Rtraction, Rtotal)" ); LinearSolverParameters & linSolParams = m_linearSolverParameters.get(); linSolParams.mgr.strategy = LinearSolverParameters::MGR::StrategyType::lagrangianContactMechanics; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp index 2b91b619a22..d975442297c 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -171,12 +171,12 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setApplyDefaultValue( 0.01 ). setDescription( "Minimum value for solution scaling factor" ); - appendLogLevelDescription( "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); - appendLogLevelDescription( "logLevel >= 1", "Information about pressure, phase, temperature during time step" ); - appendLogLevelDescription( "logLevel >= 1", "Information on density during outer iteration" ); - appendLogLevelDescription( "logLevel >= 1 and thermal simulation", "Information on max relative temperature" ); - appendLogLevelDescription( "logLevel >= 1", "Information on volume frations" ); - appendLogLevelDescription( "logLevel >= 1", "Information on CFL number" ); + addLogLevel( "logLevel >= 1", "Warnings about non-simulated region intersecting, that can cancel sourceFlux effects" ); + addLogLevel( "logLevel >= 1", "Information about pressure, phase, temperature during time step" ); + addLogLevel( "logLevel >= 1", "Information on density during outer iteration" ); + addLogLevel( "logLevel >= 1 and thermal simulation", "Information on max relative temperature" ); + addLogLevel( "logLevel >= 1", "Information on volume frations" ); + addLogLevel( "logLevel >= 1", "Information on CFL number" ); } void CompositionalMultiphaseBase::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index c56053968f1..baa2d676188 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -87,14 +87,14 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); - appendLogLevelDescription( "logLevel >= 1", "Print the residual values" ); - appendLogLevelDescription( "logLevel >= 1 and non first nonlinear iteration", "Information on the face boundary conditions log" ); - appendLogLevelDescription( "logLevel >= 1", "Information about max pressure/max component density change" ); - appendLogLevelDescription( "logLevel >= 1 and thermal simulation", "Information about temperature changes" ); - appendLogLevelDescription( "logLevel >= 1 and scaling type is local", "Print scaling factors" ); - appendLogLevelDescription( "logLevel >= 1 and negative pressure", "Information on negative pressure values" ); - appendLogLevelDescription( "logLevel >= 1 and negative density", "Information on negative density values" ); - appendLogLevelDescription( "logLevel >= 1 and total density > 0", "Information on total density values" ); + addLogLevel( "logLevel >= 1", "Print the residual values" ); + addLogLevel( "logLevel >= 1 and non first nonlinear iteration", "Information on the face boundary conditions log" ); + addLogLevel( "logLevel >= 1", "Information about max pressure/max component density change" ); + addLogLevel( "logLevel >= 1 and thermal simulation", "Information about temperature changes" ); + addLogLevel( "logLevel >= 1 and scaling type is local", "Print scaling factors" ); + addLogLevel( "logLevel >= 1 and negative pressure", "Information on negative pressure values" ); + addLogLevel( "logLevel >= 1 and negative density", "Information on negative density values" ); + addLogLevel( "logLevel >= 1 and total density > 0", "Information on total density values" ); } void CompositionalMultiphaseFVM::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp index a7a2aefb814..f4da7069ce1 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,7 +49,7 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { - appendLogLevelDescription( "logLevel >= 1", "Print the residual values" ); + addLogLevel( "logLevel >= 1", "Print the residual values" ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::compositionalMultiphaseHybridFVM; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp index c2e5d0d0e4f..9c4518767df 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.cpp @@ -60,9 +60,9 @@ CompositionalMultiphaseStatistics::CompositionalMultiphaseStatistics( const stri setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to decide whether a phase is considered mobile (when the relperm is above the threshold) or immobile (when the relperm is below the threshold) in metric 2" ); - appendLogLevelDescription( "logLevel >= 1 and pore volume equal 0", "Warning on the impossibility to compute pressure" ); - appendLogLevelDescription( "logLevel >= 1", "Information on the regions statistics" ); - appendLogLevelDescription( "logLevel >= 1", "Information on CFL numbers" ); + addLogLevel( "logLevel >= 1 and pore volume equal 0", "Warning on the impossibility to compute pressure" ); + addLogLevel( "logLevel >= 1", "Information on the regions statistics" ); + addLogLevel( "logLevel >= 1", "Information on CFL numbers" ); } void CompositionalMultiphaseStatistics::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp index 1579fded932..13eed6a24e2 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -121,7 +121,7 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); - appendLogLevelDescription( "logLevel >= 1", "Information on pressure and temperature" ); + addLogLevel( "logLevel >= 1", "Information on pressure and temperature" ); // allow the user to select a norm getNonlinearSolverParameters().getWrapper< solverBaseKernels::NormType >( NonlinearSolverParameters::viewKeysStruct::normTypeString() ).setInputFlag( InputFlags::OPTIONAL ); diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp index d4fafd300a9..de0f6214604 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -116,8 +116,8 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); - appendLogLevelDescription( "logLevel >= 1", "Print the residuals values" ); - //appendLogLevelDescription( "logLevel >= 1 first nonlinear iteration", "Information on the source flux boundary conditions" ); + addLogLevel( "logLevel >= 1", "Print the residuals values" ); + //addLogLevel( "logLevel >= 1 first nonlinear iteration", "Information on the source flux boundary conditions" ); m_linearSolverParameters.get().mgr.strategy = LinearSolverParameters::MGR::StrategyType::reactiveCompositionalMultiphaseOBL; } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp index 862d1332118..997c74c1121 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -66,8 +66,8 @@ SinglePhaseBase::SinglePhaseBase( const string & name, "For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced.", viewKeyStruct::isThermalString() ) ); - appendLogLevelDescription( "logLevel >= 1", "Print pressure change" ); - appendLogLevelDescription( "logLevel >= 1", "Information on negative pressure values" ); + addLogLevel( "logLevel >= 1", "Print pressure change" ); + addLogLevel( "logLevel >= 1", "Information on negative pressure values" ); } diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp index 41862751b55..011de5449b6 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -60,7 +60,7 @@ SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, Group * const parent ): BASE( name, parent ) { - SinglePhaseBase::appendLogLevelDescription( "logLevel >= 1", "Print the residual values" ); + SinglePhaseBase::addLogLevel( "logLevel >= 1", "Print the residual values" ); } template< typename BASE > diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index fc90349e219..a8516665795 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -46,7 +46,7 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, SinglePhaseBase( name, parent ), m_areaRelTol( 1e-8 ) { - appendLogLevelDescription( "logLevel >= 1", "Print the residual norm values" ); + addLogLevel( "logLevel >= 1", "Print the residual norm values" ); // one cell-centered dof per cell m_numDofPerCell = 1; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp index fc1e9024f33..54cc667e434 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatistics.cpp @@ -35,7 +35,7 @@ SinglePhaseStatistics::SinglePhaseStatistics( const string & name, Group * const parent ): Base( name, parent ) { - appendLogLevelDescription( "logLevel >= 1", "Information on region statistics" ); + addLogLevel( "logLevel >= 1", "Information on region statistics" ); } void SinglePhaseStatistics::registerDataOnMesh( Group & meshBodies ) diff --git a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp index c7f1e9aea3a..880a2d255b9 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp @@ -80,7 +80,7 @@ ProppantTransport::ProppantTransport( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag that enables/disables proppant-packing update" ); - appendLogLevelDescription( "logLevel >= 1", "Infos on residual norm values" ); + addLogLevel( "logLevel >= 1", "Infos on residual norm values" ); } void ProppantTransport::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 23e22213343..4b693d71845 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -108,11 +108,11 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setApplyDefaultValue( 1 ). setDescription( "Flag indicating whether local (cell-wise) chopping of negative compositions is allowed" ); - appendLogLevelDescription( "logLevel >= 1", "Infos on residual values" ); - appendLogLevelDescription( "logLevel >= 1", "Output well rates to a simple csv file" ); - appendLogLevelDescription( "logLevel >= 2", "Infos on the BHP pressure" ); - appendLogLevelDescription( "logLevel >= 2", "Infos on the surface density" ); - appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Information on the phase and total density in the reference element" ); + addLogLevel( "logLevel >= 1", "Infos on residual values" ); + addLogLevel( "logLevel >= 1", "Output well rates to a simple csv file" ); + addLogLevel( "logLevel >= 2", "Infos on the BHP pressure" ); + addLogLevel( "logLevel >= 2", "Infos on the surface density" ); + addLogLevel( "logLevel >= 2 and use surface conditions", "Information on the phase and total density in the reference element" ); } void CompositionalMultiphaseWell::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index 384c147fa6c..d01f3756d44 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -46,11 +46,11 @@ SinglePhaseWell::SinglePhaseWell( const string & name, Group * const parent ): WellSolverBase( name, parent ) { - appendLogLevelDescription( "logLevel >= 1", "Infos on residual values" ); - appendLogLevelDescription( "logLevel >= 1", "Output well rates to a simple csv file" ); - appendLogLevelDescription( "logLevel >= 2", "Infos on BHP pressure" ); - appendLogLevelDescription( "logLevel >= 2", "Infos on surface density" ); - appendLogLevelDescription( "logLevel >= 2 and use surface conditions", "Information on the phase and total density in the reference element" ); + addLogLevel( "logLevel >= 1", "Infos on residual values" ); + addLogLevel( "logLevel >= 1", "Output well rates to a simple csv file" ); + addLogLevel( "logLevel >= 2", "Infos on BHP pressure" ); + addLogLevel( "logLevel >= 2", "Infos on surface density" ); + addLogLevel( "logLevel >= 2 and use surface conditions", "Information on the phase and total density in the reference element" ); m_numDofPerWellElement = 2; m_numDofPerResElement = 1; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp index e9bf64190fa..1eaf24686ab 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -161,7 +161,7 @@ WellControls::WellControls( string const & name, Group * const parent ) setDescription( "Name of the well status table when the status of the well is a time dependent function. \n" "If the status function evaluates to a positive value at the current time, the well will be open otherwise the well will be shut." ); - appendLogLevelDescription( "logLevel >= 1", "Information on well controls setting" ); + addLogLevel( "logLevel >= 1", "Information on well controls setting" ); } diff --git a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp index fd320ef2f0e..c2347258338 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -43,7 +43,7 @@ CompositionalMultiphaseReservoirAndWells( const string & name, Group * const parent ) : Base( name, parent ) { - Base::appendLogLevelDescription( "logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors" ); + Base::addLogLevel( "logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors" ); } template< typename RESERVOIR_SOLVER > diff --git a/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp index d6355f02efc..e2b32570a53 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp @@ -55,10 +55,10 @@ class CoupledSolver : public SolverBase this->getWrapper< string >( SolverBase::viewKeyStruct::discretizationString() ). setInputFlag( dataRepository::InputFlags::FALSE ); - appendLogLevelDescription( "logLevel >= 1", "Print solvers name" ); - appendLogLevelDescription( "logLevel >= 1", "Print residual norm" ); - appendLogLevelDescription( "logLevel >= 1", "Print time stepping" ); - appendLogLevelDescription( "logLevel >= 1", "Information on each iteration" ); + addLogLevel( "logLevel >= 1", "Print solvers name" ); + addLogLevel( "logLevel >= 1", "Print residual norm" ); + addLogLevel( "logLevel >= 1", "Print time stepping" ); + addLogLevel( "logLevel >= 1", "Information on each iteration" ); } /// deleted copy constructor diff --git a/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp index b610999ab1f..50b037f8d9d 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/FlowProppantTransportSolver.cpp @@ -33,7 +33,7 @@ FlowProppantTransportSolver::FlowProppantTransportSolver( const string & name, Group * const parent ): Base( name, parent ) { - appendLogLevelDescription( "logLevel >= 1", "Informations about convergance and iterations " ); + addLogLevel( "logLevel >= 1", "Informations about convergance and iterations " ); } void FlowProppantTransportSolver::preStepUpdate( real64 const & time_n, diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index 5d9f409ce19..ebbe516ab1b 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -75,9 +75,9 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); - Base::appendLogLevelDescription( "logLevel >= 1", "Output whether or not we Re-entering Newton Solve" ); - Base::appendLogLevelDescription( "logLevel >= 1", "Information on aperture and hydraulic aperture" ); - Base::appendLogLevelDescription( "logLevel >= 3", "Print time stepping" ); + Base::addLogLevel( "logLevel >= 1", "Output whether or not we Re-entering Newton Solve" ); + Base::addLogLevel( "logLevel >= 1", "Information on aperture and hydraulic aperture" ); + Base::addLogLevel( "logLevel >= 3", "Print time stepping" ); m_numResolves[0] = 0; diff --git a/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp b/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp index e23b3f1cc5f..fe5df0261ed 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp @@ -45,7 +45,7 @@ MultiphasePoromechanics< FLOW_SOLVER, MECHANICS_SOLVER >::MultiphasePoromechanic : Base( name, parent ) { - Base::appendLogLevelDescription( "logLevel >= 1", "Print phase volume fraction" ); + Base::addLogLevel( "logLevel >= 1", "Print phase volume fraction" ); LinearSolverParameters & linearSolverParameters = this->m_linearSolverParameters.get(); linearSolverParameters.mgr.strategy = LinearSolverParameters::MGR::StrategyType::multiphasePoromechanics; diff --git a/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp b/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp index 66d158f8f62..51ec1c79856 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp @@ -56,7 +56,7 @@ PoromechanicsInitialization( const string & name, setApplyDefaultValue( "" ). setDescription( "Name of the solid mechanics statistics" ); - appendLogLevelDescription( "logLevel >= 1", "Information about physics solver stress initialization" ); + addLogLevel( "logLevel >= 1", "Information about physics solver stress initialization" ); } template< typename POROMECHANICS_SOLVER > diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index 795c674cadc..f75456aa719 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -42,7 +42,7 @@ SinglePhasePoromechanicsConformingFractures< FLOW_SOLVER >::SinglePhasePoromecha Group * const parent ) : Base( name, parent ) { - this->appendLogLevelDescription( "logLevel >= 3", "The summary of declared fields and coupling" ); + this->addLogLevel( "logLevel >= 3", "The summary of declared fields and coupling" ); LinearSolverParameters & params = this->m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; diff --git a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp index 73952eedbda..85115c9ce4a 100644 --- a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp +++ b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp @@ -81,8 +81,8 @@ PhaseFieldDamageFEM::PhaseFieldDamageFEM( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "The upper bound of the damage" ); - appendLogLevelDescription( "logLevel >= 2", "Output the jacobian matrix" ); - appendLogLevelDescription( "logLevel >= 2", "Output the residuals values" ); + addLogLevel( "logLevel >= 2", "Output the jacobian matrix" ); + addLogLevel( "logLevel >= 2", "Output the residuals values" ); } PhaseFieldDamageFEM::~PhaseFieldDamageFEM() diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp index e1e17cc8bb2..cf6d7358d4a 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp @@ -120,8 +120,8 @@ SolidMechanicsLagrangianFEM::SolidMechanicsLagrangianFEM( const string & name, setInputFlag( InputFlags::FALSE ). setDescription( "The maximum force contribution in the problem domain." ); - appendLogLevelDescription( "logLevel >= 2 and target set is empty", "Warning about boundary conditions" ); - appendLogLevelDescription( "logLevel >= 2", "Infos on residuals values" ); + addLogLevel( "logLevel >= 2 and target set is empty", "Warning about boundary conditions" ); + addLogLevel( "logLevel >= 2", "Infos on residuals values" ); } diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp index 0ea5a0ad5fb..f2b0937ad94 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp @@ -51,8 +51,8 @@ SolidMechanicsStateReset::SolidMechanicsStateReset( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to enable/disable inelastic behavior" ); - appendLogLevelDescription( "logLevel >= 1 and reset displacements", "Information about physics solver during task" ); - appendLogLevelDescription( "logLevel >= 2", "Information about solid model during task" ); + addLogLevel( "logLevel >= 1 and reset displacements", "Information about physics solver during task" ); + addLogLevel( "logLevel >= 2", "Information about solid model during task" ); } SolidMechanicsStateReset::~SolidMechanicsStateReset() diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp index c729be5cb52..860567022d9 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStatistics.cpp @@ -36,7 +36,7 @@ SolidMechanicsStatistics::SolidMechanicsStatistics( const string & name, Group * const parent ): Base( name, parent ) { - appendLogLevelDescription( "logLevel >= 1", "Information on node statistics displacement" ); + addLogLevel( "logLevel >= 1", "Information on node statistics displacement" ); } void SolidMechanicsStatistics::registerDataOnMesh( Group & meshBodies ) diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp index 4c0da3ea920..e9c29b12373 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/EmbeddedSurfaceGenerator.cpp @@ -81,8 +81,8 @@ EmbeddedSurfaceGenerator::EmbeddedSurfaceGenerator( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to enable MPI consistent communication ordering" ); - appendLogLevelDescription( "logLevel >= 2", "Print each cell index element fractured" ); - appendLogLevelDescription( "logLevel >= 1", "Print number of embedded surface elements" ); + addLogLevel( "logLevel >= 2", "Print each cell index element fractured" ); + addLogLevel( "logLevel >= 1", "Print number of embedded surface elements" ); } EmbeddedSurfaceGenerator::~EmbeddedSurfaceGenerator() diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index 115c869256d..d0659b4f919 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -220,12 +220,12 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); - appendLogLevelDescription( "logLevel >= 1", "Print splitting node along separation plane faces" ); - appendLogLevelDescription( "logLevel >= 1", "Print splitting edge and face" ); - appendLogLevelDescription( "logLevel >= 2", "Print all elements attached to the nodeID" ); - appendLogLevelDescription( "logLevel >= 2", "Print all faces on their element" ); - appendLogLevelDescription( "logLevel >= 3", "Information on the consistency checking of the maps" ); - appendLogLevelDescription( "logLevel >= 3", "Print rupture rate" ); + addLogLevel( "logLevel >= 1", "Print splitting node along separation plane faces" ); + addLogLevel( "logLevel >= 1", "Print splitting edge and face" ); + addLogLevel( "logLevel >= 2", "Print all elements attached to the nodeID" ); + addLogLevel( "logLevel >= 2", "Print all faces on their element" ); + addLogLevel( "logLevel >= 3", "Information on the consistency checking of the maps" ); + addLogLevel( "logLevel >= 3", "Print rupture rate" ); } void SurfaceGenerator::postProcessInput() diff --git a/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp b/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp index c957c415dfc..a89404491be 100644 --- a/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp +++ b/src/coreComponents/physicsSolvers/wavePropagation/sem/acoustic/secondOrderEqn/isotropic/AcousticWaveEquationSEM.cpp @@ -50,7 +50,7 @@ AcousticWaveEquationSEM::AcousticWaveEquationSEM( const std::string & name, setSizedFromParent( 0 ). setDescription( "Pressure value at each receiver for each timestep" ); - appendLogLevelDescription( "logLevel >= 1", "Print PML parameters" ); + addLogLevel( "logLevel >= 1", "Print PML parameters" ); } AcousticWaveEquationSEM::~AcousticWaveEquationSEM() diff --git a/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp b/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp index 66cd65a1ea2..c7fe45d143b 100644 --- a/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp @@ -219,7 +219,7 @@ WaveSolverBase::WaveSolverBase( const std::string & name, setDescription( "Flag to indicate which attenuation model to use: \"none\" for no attenuation, \"sls\\" " for the standard-linear-solid (SLS) model (Fichtner, 2014)." ); - appendLogLevelDescription( "logLevel >= 1", "Information about linear DAS" ); + addLogLevel( "logLevel >= 1", "Information about linear DAS" ); } WaveSolverBase::~WaveSolverBase()