diff --git a/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp index 87cbcdcec4c..46159e3fa8a 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 ). @@ -112,6 +110,8 @@ CO2BrineFluid( string const & name, Group * const parent ): setPlotLevel( PlotLevel::LEVEL_0 ). setRestartFlags( RestartFlags::WRITE_AND_READ ); } + + 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 6184280deb1..18c5406b452 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 ). @@ -90,6 +88,9 @@ PVTDriver::PVTDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + addLogLevel( "logLevel >= 1", "Informations about PVT Driver" ); + addLogLevel( "logLevel >= 1", "Indicate consistency of results" ); } void PVTDriver::postInputInitialization() diff --git a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp index dce987363f0..2a58a93eb6e 100644 --- a/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp +++ b/src/coreComponents/constitutive/fluid/multifluid/reactive/ReactiveBrineFluid.cpp @@ -79,6 +79,8 @@ ReactiveBrineFluid( string const & name, Group * const parent ): setPlotLevel( PlotLevel::LEVEL_0 ). setRestartFlags( RestartFlags::WRITE_AND_READ ); } + + 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 48ad15e5730..c9eed92b249 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 ). @@ -66,6 +64,9 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + 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 3d22f910972..3e6f5370f6d 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 ). @@ -52,6 +50,9 @@ RelpermDriver::RelpermDriver( const geos::string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + 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 26646693f50..ffec6dbec0d 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 ). @@ -67,6 +65,9 @@ TriaxialDriver::TriaxialDriver( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "none" ). setDescription( "Baseline file" ); + + 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 a6cc0126a8e..ad483637327 100644 --- a/src/coreComponents/dataRepository/Group.cpp +++ b/src/coreComponents/dataRepository/Group.cpp @@ -79,6 +79,18 @@ void Group::deregisterWrapper( string const & name ) m_conduitNode.remove( name ); } +void Group::addLogLevel( string_view levelCondition, string_view logDescription ) +{ + Wrapper< integer > * wrapper = getWrapperPointer< integer >( viewKeyStruct::logLevelString() ); + if( wrapper == nullptr ) + { + wrapper = ®isterWrapper( viewKeyStruct::logLevelString(), &m_logLevel ); + wrapper->setApplyDefaultValue( 0 ); + wrapper->setInputFlag( InputFlags::OPTIONAL ); + } + m_logLevelsDescriptions[ string( levelCondition ) ].push_back( string( logDescription ) ); + wrapper->buildLogLevelDescription( m_logLevelsDescriptions ); +} void Group::resize( indexType const newSize ) { @@ -638,15 +650,6 @@ void Group::postRestartInitializationRecursive() postRestartInitialization(); } -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 ). - setInputFlag( InputFlags::OPTIONAL ). - setDescription( "Log level" ); -} - 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 3361848d7a4..871f84953b8 100644 --- a/src/coreComponents/dataRepository/Group.hpp +++ b/src/coreComponents/dataRepository/Group.hpp @@ -854,6 +854,13 @@ class Group ///@} //END_SPHINX_INCLUDE_REGISTER_WRAPPER + /** + * @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 addLogLevel( string_view levelCondition, string_view logDescription ); + /** * @name Schema generation methods */ @@ -1469,9 +1476,6 @@ class Group */ void loadFromConduit(); - /// Enable verbosity input for object - void enableLogLevelInput(); - /** * @brief Set verbosity level * @param logLevel new verbosity level value @@ -1606,6 +1610,11 @@ class Group /// Verbosity flag for group logs integer m_logLevel; + + /// Map for building the log level string for each wrapper + /// 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 /// 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..cab27ad9baa 100644 --- a/src/coreComponents/dataRepository/WrapperBase.hpp +++ b/src/coreComponents/dataRepository/WrapperBase.hpp @@ -510,15 +510,36 @@ 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 ) { - m_description += description; + m_description = description; return *this; } + /** + * @brief Construct the log level string description for a wrapper + */ + void buildLogLevelDescription( std::map< std::string, std::vector< std::string > > const & logLevelsDescriptions ) + { + 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 ) + { + description << GEOS_FMT( "\n{}\n", logLevel ); + for( size_t idxDesc = 0; idxDesc< logDescriptions.size(); idxDesc++ ) + { + description << " - " << logDescriptions[idxDesc]; + if( idxDesc != logDescriptions.size() - 1 ) description << '\n'; + } + } + appendDescription( description.str() ); + } + + /** * @brief Get the description string of the wrapper. * @return this wrapper's description string @@ -782,7 +803,7 @@ class WrapperBase parallelDeviceEvents & events ) const = 0; }; -} /// namespace dataRepository +} /// namespace dataRepository } /// namespace geos #endif /* GEOS_DATAREPOSITORY_WRAPPERBASE_HPP_ */ diff --git a/src/coreComponents/events/EventBase.cpp b/src/coreComponents/events/EventBase.cpp index 93059a355a4..4d7700ca39c 100644 --- a/src/coreComponents/events/EventBase.cpp +++ b/src/coreComponents/events/EventBase.cpp @@ -52,9 +52,6 @@ EventBase::EventBase( const string & name, { setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); - // This enables logLevel filtering - enableLogLevelInput(); - registerWrapper( viewKeyStruct::eventTargetString(), &m_eventTarget ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::OPTIONAL ). @@ -106,6 +103,8 @@ EventBase::EventBase( const string & name, registerWrapper( viewKeyStruct::isTargetExecutingString(), &m_targetExecFlag ). setDescription( "Index of the current subevent" ); + + addLogLevel( "logLevel >= 1", "Information about sub-event" ); } diff --git a/src/coreComponents/events/EventManager.cpp b/src/coreComponents/events/EventManager.cpp index 33f02a151c5..e8782af8f92 100644 --- a/src/coreComponents/events/EventManager.cpp +++ b/src/coreComponents/events/EventManager.cpp @@ -44,9 +44,6 @@ EventManager::EventManager( string const & name, { setInputFlags( InputFlags::REQUIRED ); - // This enables logLevel filtering - enableLogLevelInput(); - registerWrapper( viewKeyStruct::minTimeString(), &m_minTime ). setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ). @@ -82,6 +79,8 @@ EventManager::EventManager( string const & name, setInputFlag( InputFlags::OPTIONAL ). setRestartFlags( RestartFlags::NO_WRITE ). setDescription( "Format of the time in the GEOS log." ); + + addLogLevel( "logLevel >= 1", "Information about current sub-event" ); } diff --git a/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp b/src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp index 678d33eb4de..ec756e3d798 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 ); + addLogLevel( "logLevel >= 1", "Information on boundary conditions" ); } void AquiferBoundaryCondition::postInputInitialization() diff --git a/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp b/src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp index 09f92109054..7bc9b89c9a2 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(); + 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 53007480a30..9289a36d0dc 100644 --- a/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp +++ b/src/coreComponents/fieldSpecification/SourceFluxBoundaryCondition.cpp @@ -31,17 +31,10 @@ SourceFluxBoundaryCondition::SourceFluxBoundaryCondition( string const & name, G setInputFlag( InputFlags::FALSE ); setFieldName( catalogName() ); - getWrapper< string >( FieldSpecificationBase::viewKeyStruct::functionNameString() ). - setDescription( GEOS_FMT( "Name of a function that specifies the variation of the production rate variations of this {}." - "Multiplied by {}. 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 {} of 0.", - catalogName(), - FieldSpecificationBase::viewKeyStruct::scaleString(), - CompositionalMultiphaseBase::viewKeyStruct::useMassFlagString() ) ); - - getWrapper< real64 >( FieldSpecificationBase::viewKeyStruct::scaleString() ). - setDescription( GEOS_FMT( "Multiplier of the {0} value. If no {0} is provided, this value is used directly.", - FieldSpecificationBase::viewKeyStruct::functionNameString() ) ); + 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 ffabfe63b05..f63ccf184c8 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." ); + + 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 3ab88e16050..7f0b8a68aa7 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 ). @@ -122,6 +120,8 @@ void VTKOutput::postInputInitialization() catalogName(), getDataContext(), std::to_string( m_fieldNames.size() ), fieldNamesString, m_plotLevel ) ); + 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/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..449bccc3c4d 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 ); + + addLogLevel( "logLevel >= 3", "Indication about setup communication" ); } diff --git a/src/coreComponents/mesh/MeshManager.cpp b/src/coreComponents/mesh/MeshManager.cpp index d1e48b4f419..b6bd0d26ca0 100644 --- a/src/coreComponents/mesh/MeshManager.cpp +++ b/src/coreComponents/mesh/MeshManager.cpp @@ -34,7 +34,10 @@ MeshManager::MeshManager( string const & name, Group * const parent ): Group( name, parent ) { + setInputFlags( InputFlags::REQUIRED ); + + addLogLevel( "logLevel >= 1", "Information on imported field name on region/subRegion" ); } MeshManager::~MeshManager() diff --git a/src/coreComponents/mesh/generators/ExternalMeshGeneratorBase.cpp b/src/coreComponents/mesh/generators/ExternalMeshGeneratorBase.cpp index 97ef2424bfe..5354bae63d4 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 e598ce6d522..ca1fda00cd6 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 b45ed3f9e30..deb42dcc00d 100644 --- a/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp +++ b/src/coreComponents/mesh/generators/VTKMeshGenerator.cpp @@ -74,6 +74,10 @@ 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" ); + + 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 ) @@ -84,7 +88,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..146195e9eb6 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" ); + 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 896d6d6fa9b..72ad228de51 100644 --- a/src/coreComponents/mesh/generators/WellGeneratorBase.cpp +++ b/src/coreComponents/mesh/generators/WellGeneratorBase.cpp @@ -40,6 +40,8 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent , m_nDims( 3 ) , m_polylineHeadNodeId( -1 ) { + + setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); registerWrapper( viewKeyStruct::radiusString(), &m_radius ). @@ -73,6 +75,8 @@ WellGeneratorBase::WellGeneratorBase( string const & name, Group * const parent setInputFlag( InputFlags::REQUIRED ). setSizedFromParent( 0 ). setDescription( "Name of the set of constraints associated with this well" ); + + 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 cb0b25f94f8..ad8f2d6d7f9 100644 --- a/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp +++ b/src/coreComponents/mesh/simpleGeometricObjects/Rectangle.cpp @@ -42,6 +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." ); + 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 ff692298342..469fc828980 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" ); + + 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 740c5cb29a0..7be458a9851 100644 --- a/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/LinearSolverParameters.cpp @@ -29,7 +29,6 @@ LinearSolverParametersInput::LinearSolverParametersInput( string const & name, Group( name, parent ) { setInputFlags( InputFlags::OPTIONAL ); - enableLogLevelInput(); registerWrapper( viewKeyStruct::solverTypeString(), &m_parameters.solverType ). setApplyDefaultValue( m_parameters.solverType ). @@ -199,6 +198,30 @@ LinearSolverParametersInput::LinearSolverParametersInput( string const & name, setApplyDefaultValue( m_parameters.ifact.threshold ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "ILU(T) threshold factor" ); + + 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::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp index 9cc659715ca..10c57014399 100644 --- a/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp +++ b/src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp @@ -27,9 +27,6 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, { setInputFlags( InputFlags::OPTIONAL ); - // This enables logLevel filtering - enableLogLevelInput(); - registerWrapper( viewKeysStruct::lineSearchActionString(), &m_lineSearchAction ). setApplyDefaultValue( LineSearchAction::Attempt ). setInputFlag( InputFlags::OPTIONAL ). @@ -176,6 +173,8 @@ NonlinearSolverParameters::NonlinearSolverParameters( string const & name, setInputFlag( dataRepository::InputFlags::OPTIONAL ). setDescription( "Nonlinear acceleration type for sequential solver." ); + addLogLevel( "logLevel >= 1", "Information on NonLinearSolver parameters" ); + } void NonlinearSolverParameters::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/SolverBase.cpp b/src/coreComponents/physicsSolvers/SolverBase.cpp index 18fe7b4a680..3c94dcff9af 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 ); @@ -95,6 +92,18 @@ SolverBase::SolverBase( string const & name, setRestartFlags( RestartFlags::WRITE_AND_READ ). setDescription( "Write matrix, rhs, solution to screen ( = 1) or file ( = 2)." ); + 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 ); registerGroup( groupKeyStruct::solverStatisticsString(), &m_solverStatistics ); @@ -782,7 +791,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. ----------" ); } } @@ -857,6 +865,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/contact/ContactSolverBase.cpp b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp index d45ddd77e9b..c05185deb69 100644 --- a/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/contact/ContactSolverBase.cpp @@ -42,11 +42,15 @@ ContactSolverBase::ContactSolverBase( const string & name, Group * const parent ): SolidMechanicsLagrangianFEM( name, parent ) { + + this->getWrapper< string >( viewKeyStruct::contactRelationNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); this->getWrapper< string >( viewKeyStruct::surfaceGeneratorNameString() ). setInputFlag( dataRepository::InputFlags::FALSE ); + + addLogLevel( "logLevel >= 1", "Information on number of elements for each fracture states" ); } void ContactSolverBase::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp index a86adc24351..e257964ba93 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsEmbeddedFractures.cpp @@ -50,6 +50,8 @@ SolidMechanicsEmbeddedFractures::SolidMechanicsEmbeddedFractures( const string & setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0 ). setDescription( "Defines whether to use static condensation or not." ); + + 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 4e5bd37fc44..8fa45aa013b 100644 --- a/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp +++ b/src/coreComponents/physicsSolvers/contact/SolidMechanicsLagrangeContact.cpp @@ -70,6 +70,8 @@ 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." ); + addLogLevel( "logLevel >= 1", "Infos on 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 7a3ac6e99f1..cd5d5e9f8f7 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseBase.cpp @@ -170,6 +170,13 @@ CompositionalMultiphaseBase::CompositionalMultiphaseBase( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 0.01 ). setDescription( "Minimum value for solution scaling factor" ); + + 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::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp index 3245cb8df57..390207e9de8 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseFVM.cpp @@ -86,6 +86,15 @@ CompositionalMultiphaseFVM::CompositionalMultiphaseFVM( const string & name, setApplyDefaultValue( ScalingType::Global ). setDescription( "Solution scaling type." "Valid options:\n* " + EnumStrings< ScalingType >::concat( "\n* " ) ); + + 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::postInputInitialization() @@ -434,6 +443,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} )", @@ -1052,6 +1062,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 f7db21f60d6..f4da7069ce1 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/CompositionalMultiphaseHybridFVM.cpp @@ -49,6 +49,8 @@ CompositionalMultiphaseHybridFVM::CompositionalMultiphaseHybridFVM( const std::s CompositionalMultiphaseBase( name, parent ), m_lengthTolerance( 0 ) { + 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 e2326f63b26..4420b964359 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" ); + + 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::postInputInitialization() @@ -394,7 +398,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 3c8554d6c4d..5148574176b 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/FlowSolverBase.cpp @@ -122,6 +122,8 @@ FlowSolverBase::FlowSolverBase( string const & name, setApplyDefaultValue( 0.1 ). setDescription( "Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check" ); + 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 ); } @@ -792,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 2d558811898..34356582688 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ReactiveCompositionalMultiphaseOBL.cpp @@ -116,6 +116,9 @@ ReactiveCompositionalMultiphaseOBL::ReactiveCompositionalMultiphaseOBL( const st setInputFlag( InputFlags::OPTIONAL ). setDescription( "List of fluid phases" ); + 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 3fddc4300bc..d8952d3c380 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBase.cpp @@ -65,6 +65,9 @@ SinglePhaseBase::SinglePhaseBase( const string & name, "- positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term.\n" "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() ) ); + + addLogLevel( "logLevel >= 1", "Print pressure change" ); + addLogLevel( "logLevel >= 1", "Information on negative pressure values" ); } @@ -1053,6 +1056,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 35023530b12..011de5449b6 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseFVM.cpp @@ -59,7 +59,9 @@ template< typename BASE > SinglePhaseFVM< BASE >::SinglePhaseFVM( const string & name, Group * const parent ): BASE( name, parent ) -{} +{ + SinglePhaseBase::addLogLevel( "logLevel >= 1", "Print the residual values" ); +} template< typename BASE > void SinglePhaseFVM< BASE >::initializePreSubGroups() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp index 4bf626b5b91..a8516665795 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseHybridFVM.cpp @@ -46,6 +46,7 @@ SinglePhaseHybridFVM::SinglePhaseHybridFVM( const string & name, SinglePhaseBase( name, parent ), m_areaRelTol( 1e-8 ) { + 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 73b34b0703b..54cc667e434 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 ) -{} +{ + 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 f936c32418d..2d36500d686 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/proppantTransport/ProppantTransport.cpp @@ -80,6 +80,7 @@ ProppantTransport::ProppantTransport( const string & name, setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag that enables/disables proppant-packing update" ); + addLogLevel( "logLevel >= 1", "Infos on residual norm values" ); } void ProppantTransport::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp index 175e7166bcb..ce06115e620 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp @@ -107,6 +107,12 @@ CompositionalMultiphaseWell::CompositionalMultiphaseWell( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( 1 ). setDescription( "Flag indicating whether local (cell-wise) chopping of negative compositions is allowed" ); + + 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::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp index f495b15a488..d01f3756d44 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp @@ -46,6 +46,12 @@ SinglePhaseWell::SinglePhaseWell( const string & name, Group * const parent ): WellSolverBase( name, parent ) { + 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 06b3b71d924..8fb324e7f27 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp @@ -50,8 +50,6 @@ WellControls::WellControls( string const & name, Group * const parent ) { setInputFlags( InputFlags::OPTIONAL_NONUNIQUE ); - enableLogLevelInput(); - registerWrapper( viewKeyStruct::typeString(), &m_type ). setInputFlag( InputFlags::REQUIRED ). setDescription( "Well type. Valid options:\n* " + EnumStrings< Type >::concat( "\n* " ) ); @@ -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." ); + + 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 6cb5b0f5a6d..c2347258338 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/CompositionalMultiphaseReservoirAndWells.cpp @@ -42,7 +42,9 @@ CompositionalMultiphaseReservoirAndWells< RESERVOIR_SOLVER >:: CompositionalMultiphaseReservoirAndWells( const string & name, Group * const parent ) : Base( name, parent ) -{} +{ + Base::addLogLevel( "logLevel >= 1 and if the well is injector and crossflow enabled", "Warnings about crossflow for injectors" ); +} template< typename RESERVOIR_SOLVER > CompositionalMultiphaseReservoirAndWells< RESERVOIR_SOLVER >:: diff --git a/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledReservoirAndWellsBase.hpp index 515d778271e..cbf261af6c2 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 ) { + // + 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/CoupledSolver.hpp b/src/coreComponents/physicsSolvers/multiphysics/CoupledSolver.hpp index bdc04aa666a..e3c5ed4513d 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 ); + + 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 @@ -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 */ @@ -578,7 +582,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 *****" ); @@ -650,7 +653,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..50b037f8d9d 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 ) -{} +{ + addLogLevel( "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 36ea5524709..2dc56d272b4 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -46,7 +46,7 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & m_isMatrixPoroelastic(), m_newFractureInitializationType() { - 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" ); @@ -80,6 +80,11 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setInputFlag( InputFlags::OPTIONAL ). setDescription( "Flag to determine whether or not to apply lagging update for the fracture stencil weights. " ); + 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; // This may need to be different depending on whether poroelasticity is on or not. @@ -920,7 +925,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 4a154328982..b6cc3f48764 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/MultiphasePoromechanics.cpp @@ -45,6 +45,8 @@ MultiphasePoromechanics< FLOW_SOLVER, MECHANICS_SOLVER >::MultiphasePoromechanic : Base( name, parent ) { + Base::addLogLevel( "logLevel >= 1", "Print phase volume fraction" ); + LinearSolverParameters & linearSolverParameters = this->m_linearSolverParameters.get(); linearSolverParameters.mgr.strategy = LinearSolverParameters::MGR::StrategyType::multiphasePoromechanics; linearSolverParameters.mgr.separateComponents = true; @@ -243,7 +245,6 @@ void MultiphasePoromechanics< FLOW_SOLVER, MECHANICS_SOLVER >::updateState( 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 fef990acbc0..534ec20fe44 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/PoromechanicsInitialization.cpp @@ -45,8 +45,6 @@ PoromechanicsInitialization( const string & name, m_solidMechanicsStatistics(), m_solidMechanicsStateResetTask( name, parent ) { - enableLogLevelInput(); - registerWrapper( viewKeyStruct::poromechanicsSolverNameString(), &m_poromechanicsSolverName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). setInputFlag( InputFlags::REQUIRED ). @@ -57,6 +55,8 @@ PoromechanicsInitialization( const string & name, setInputFlag( InputFlags::OPTIONAL ). setApplyDefaultValue( "" ). setDescription( "Name of the solid mechanics statistics" ); + + 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 e4591b67a1a..003a94ca4bd 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -43,6 +43,8 @@ SinglePhasePoromechanicsConformingFractures< FLOW_SOLVER >::SinglePhasePoromecha Group * const parent ) : Base( name, parent ) { + this->addLogLevel( "logLevel >= 3", "The summary of declared fields and coupling" ); + LinearSolverParameters & params = this->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 b8ad1f6eea7..f691d1c8e8c 100644 --- a/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp +++ b/src/coreComponents/physicsSolvers/simplePDE/PhaseFieldDamageFEM.cpp @@ -80,6 +80,9 @@ PhaseFieldDamageFEM::PhaseFieldDamageFEM( const string & name, setApplyDefaultValue( 1.5 ). setInputFlag( InputFlags::OPTIONAL ). setDescription( "The upper bound of the damage" ); + + addLogLevel( "logLevel >= 2", "Output the jacobian matrix" ); + addLogLevel( "logLevel >= 2", "Output the residuals values" ); } PhaseFieldDamageFEM::~PhaseFieldDamageFEM() @@ -451,8 +454,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 98527ef0164..dfd5cc4906c 100644 --- a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp +++ b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsLagrangianFEM.cpp @@ -120,6 +120,9 @@ SolidMechanicsLagrangianFEM::SolidMechanicsLagrangianFEM( const string & name, setInputFlag( InputFlags::FALSE ). setDescription( "The maximum force contribution in the problem domain." ); + addLogLevel( "logLevel >= 2 and target set is empty", "Warning about boundary conditions" ); + addLogLevel( "logLevel >= 2", "Infos on residuals values" ); + } void SolidMechanicsLagrangianFEM::postInputInitialization() diff --git a/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp b/src/coreComponents/physicsSolvers/solidMechanics/SolidMechanicsStateReset.cpp index 3b2fc88a032..ceb8ffe8bae 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" ); + + 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 855fb547a3f..860567022d9 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 ) -{} +{ + 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 85d2fbc2aa9..e9c29b12373 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" ); + + 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 c7044e4a161..712be6d49c2 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -219,6 +219,13 @@ SurfaceGenerator::SurfaceGenerator( const string & name, this->getWrapper< string >( viewKeyStruct::discretizationString() ). setInputFlag( InputFlags::FALSE ); + + 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::postInputInitialization() @@ -743,7 +750,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; @@ -1769,7 +1775,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 ) ); @@ -2061,8 +2066,6 @@ void SurfaceGenerator::performFracture( const localIndex nodeID, } } - - // 2b) loop over all faces on element. if( getLogLevel() > 1 ) { @@ -2331,7 +2334,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 ) { @@ -2362,7 +2364,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= 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 dff7e2d1b6d..9d052bd8ef0 100644 --- a/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp +++ b/src/coreComponents/physicsSolvers/wavePropagation/shared/WaveSolverBase.cpp @@ -218,6 +218,8 @@ WaveSolverBase::WaveSolverBase( const std::string & name, setApplyDefaultValue( WaveSolverUtils::AttenuationType::none ). setDescription( "Flag to indicate which attenuation model to use: \"none\" for no attenuation, \"sls\\" " for the standard-linear-solid (SLS) model (Fichtner, 2014)." ); + + addLogLevel( "logLevel >= 1", "Information about linear DAS" ); } WaveSolverBase::~WaveSolverBase() diff --git a/src/coreComponents/schema/docs/AcousticElasticSEM.rst b/src/coreComponents/schema/docs/AcousticElasticSEM.rst index 8dc0c8b4e21..9b3de635d99 100644 --- a/src/coreComponents/schema/docs/AcousticElasticSEM.rst +++ b/src/coreComponents/schema/docs/AcousticElasticSEM.rst @@ -1,19 +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 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 0d655628fe6..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst @@ -1,37 +1,57 @@ -============================== ==================================== ========== ======================================================================================================================================================================================================================================================================================================================== -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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 0d655628fe6..0dc6a094690 100644 --- a/src/coreComponents/schema/docs/AcousticSEM.rst +++ b/src/coreComponents/schema/docs/AcousticSEM.rst @@ -1,37 +1,58 @@ -============================== ==================================== ========== ======================================================================================================================================================================================================================================================================================================================== -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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 0d655628fe6..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/AcousticVTISEM.rst +++ b/src/coreComponents/schema/docs/AcousticVTISEM.rst @@ -1,37 +1,57 @@ -============================== ==================================== ========== ======================================================================================================================================================================================================================================================================================================================== -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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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/Aquifer.rst b/src/coreComponents/schema/docs/Aquifer.rst index 20c477d38bc..a8a97af2ad9 100644 --- a/src/coreComponents/schema/docs/Aquifer.rst +++ b/src/coreComponents/schema/docs/Aquifer.rst @@ -27,7 +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 0 Log level +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 8d5cb05986a..269464937be 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 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 8d5cb05986a..269464937be 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 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 8d5cb05986a..269464937be 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 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 8d5cb05986a..269464937be 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 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 a2b0c70f5fc..33e2a2e5cb5 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst @@ -1,49 +1,46 @@ -========================================= =========================================== ============ ======================================================================================================================================================================================================================================================================================================================== -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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 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 +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. +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 2cf53fd6857..a73b3252efc 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst @@ -1,40 +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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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/CompositionalMultiphaseReservoir.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst index 9b67dda6230..7b540496fe9 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir.rst @@ -1,18 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 6ec494e2d08..0558fd89983 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst @@ -1,25 +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 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 | 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 | 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/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanicsInitialization.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/CompositionalMultiphaseStatistics.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst index 4a386d1d1c3..a1e565dfbe6 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseStatistics.rst @@ -1,15 +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 0 Log level -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 197e006821f..44dfcccdfe4 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst @@ -1,25 +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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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/Dirichlet.rst b/src/coreComponents/schema/docs/Dirichlet.rst index 81d6fead75e..260b86169b7 100644 --- a/src/coreComponents/schema/docs/Dirichlet.rst +++ b/src/coreComponents/schema/docs/Dirichlet.rst @@ -1,21 +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 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 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 0d655628fe6..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst @@ -1,37 +1,57 @@ -============================== ==================================== ========== ======================================================================================================================================================================================================================================================================================================================== -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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 924f4d2c984..b7195754890 100644 --- a/src/coreComponents/schema/docs/ElasticSEM.rst +++ b/src/coreComponents/schema/docs/ElasticSEM.rst @@ -1,40 +1,60 @@ -============================== ==================================== ============= ======================================================================================================================================================================================================================================================================================================================== -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 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 -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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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/EmbeddedSurfaceGenerator.rst b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst index 4dc73219d88..bb9959443c2 100644 --- a/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst +++ b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator.rst @@ -1,20 +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 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 a9963170314..b7201702306 100644 --- a/src/coreComponents/schema/docs/Events.rst +++ b/src/coreComponents/schema/docs/Events.rst @@ -1,16 +1,19 @@ -================ ================================== ============ ======================================================================== -Name Type Default Description -================ ================================== ============ ======================================================================== -logLevel integer 0 Log level -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` -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. 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` +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..260b86169b7 100644 --- a/src/coreComponents/schema/docs/FieldSpecification.rst +++ b/src/coreComponents/schema/docs/FieldSpecification.rst @@ -1,21 +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 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 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 1444704a5ed..be8c4b259e4 100644 --- a/src/coreComponents/schema/docs/FlowProppantTransport.rst +++ b/src/coreComponents/schema/docs/FlowProppantTransport.rst @@ -1,18 +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 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 de2a154b525..8b020024353 100644 --- a/src/coreComponents/schema/docs/HaltEvent.rst +++ b/src/coreComponents/schema/docs/HaltEvent.rst @@ -1,21 +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 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 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 896a5cb77b0..c7d93ed9147 100644 --- a/src/coreComponents/schema/docs/Hydrofracture.rst +++ b/src/coreComponents/schema/docs/Hydrofracture.rst @@ -1,32 +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] -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. -isLaggingFractureStencilWeightsUpdate integer 0 Flag to determine whether or not to apply lagging update for the fracture stencil weights. -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 -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 -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) -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 +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) +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== 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/HydrostaticEquilibrium.rst b/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst index 3b1f86b4003..9e0204e0ddb 100644 --- a/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst +++ b/src/coreComponents/schema/docs/HydrostaticEquilibrium.rst @@ -1,26 +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 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 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 bb26958fc59..f23d8057442 100644 --- a/src/coreComponents/schema/docs/InternalWell.rst +++ b/src/coreComponents/schema/docs/InternalWell.rst @@ -1,19 +1,22 @@ -===================== =================== ======== ==================================================================================================== -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 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 21ff08859ec..73c2c973b56 100644 --- a/src/coreComponents/schema/docs/LaplaceFEM.rst +++ b/src/coreComponents/schema/docs/LaplaceFEM.rst @@ -1,21 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 67d62e850dd..15ee7731950 100644 --- a/src/coreComponents/schema/docs/LinearSolverParameters.rst +++ b/src/coreComponents/schema/docs/LinearSolverParameters.rst @@ -1,43 +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 0 Log level -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 b64bf1d9e19..22773cd454e 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 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 002c98b6c89..8482d5e5c3c 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst @@ -1,25 +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 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 | 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 | 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/MultiphasePoromechanicsInitialization.rst b/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanicsInitialization.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/MultiphasePoromechanicsReservoir.rst b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst index abe1a84cf22..07859d72a8b 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir.rst @@ -1,18 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 536793a2dea..6a7a0c08b8e 100644 --- a/src/coreComponents/schema/docs/NonlinearSolverParameters.rst +++ b/src/coreComponents/schema/docs/NonlinearSolverParameters.rst @@ -19,7 +19,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 0 Log level +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 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..c6876deef6a 100644 --- a/src/coreComponents/schema/docs/PML.rst +++ b/src/coreComponents/schema/docs/PML.rst @@ -1,26 +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 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 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 3f1c9b21b88..69f6896e2d9 100644 --- a/src/coreComponents/schema/docs/PeriodicEvent.rst +++ b/src/coreComponents/schema/docs/PeriodicEvent.rst @@ -1,28 +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 0 Log level -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 738d26eb91a..1120325f8ca 100644 --- a/src/coreComponents/schema/docs/PhaseFieldDamageFEM.rst +++ b/src/coreComponents/schema/docs/PhaseFieldDamageFEM.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] -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 eb49f03806a..12082b10238 100644 --- a/src/coreComponents/schema/docs/PhaseFieldFracture.rst +++ b/src/coreComponents/schema/docs/PhaseFieldFracture.rst @@ -1,18 +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 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 6d381b82584..4c05cf8b0b4 100644 --- a/src/coreComponents/schema/docs/ProppantTransport.rst +++ b/src/coreComponents/schema/docs/ProppantTransport.rst @@ -1,29 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 d710c396a38..38e344376bb 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 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 d710c396a38..38e344376bb 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 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 c3f5cebfb57..a444f68c5c2 100644 --- a/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst +++ b/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL.rst @@ -1,32 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 b2c089baae6..fb258581b62 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 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 2413e9f671b..bcbb485e9e8 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 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 090a04d2c45..5a3f0ac7e8b 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 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 a4e6bddb031..b3faababf73 100644 --- a/src/coreComponents/schema/docs/SeismicityRate.rst +++ b/src/coreComponents/schema/docs/SeismicityRate.rst @@ -1,21 +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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 f95554a5d12..bb6fd73b18e 100644 --- a/src/coreComponents/schema/docs/SinglePhaseFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseFVM.rst @@ -1,27 +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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 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 f95554a5d12..b718407d304 100644 --- a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst @@ -1,27 +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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 002c98b6c89..840c91377df 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst @@ -1,25 +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 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 | 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 002c98b6c89..ac418081a75 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst @@ -1,25 +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 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 | 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.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/SinglePhasePoromechanicsConformingFracturesReservoir.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst index af1c8e817b3..689e5d333c1 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst @@ -1,18 +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 Log level -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 +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/SinglePhasePoromechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst index 002c98b6c89..840c91377df 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst @@ -1,25 +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 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 | 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.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/SinglePhasePoromechanicsInitialization.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsInitialization.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/SinglePhasePoromechanicsReservoir.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst index abe1a84cf22..c58e773ecce 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir.rst @@ -1,18 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 f95554a5d12..bb6fd73b18e 100644 --- a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst @@ -1,27 +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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 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 9b67dda6230..153978d50ce 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoir.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoir.rst @@ -1,18 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 6ec494e2d08..aaafbda4e1d 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst @@ -1,5 +1,51 @@ +<<<<<<< HEAD +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +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` +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +======= =========================== ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== Name Type Default Description =========================== ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== @@ -21,5 +67,6 @@ writeLinearSystem integer 0 Write LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` =========================== ==================================== ======== ====================================================================================================================================================================================================================================================================================================================== +>>>>>>> origin/develop diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanicsInitialization.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/SinglePhaseStatistics.rst b/src/coreComponents/schema/docs/SinglePhaseStatistics.rst index ff3105519bd..91ce4e74e4d 100644 --- a/src/coreComponents/schema/docs/SinglePhaseStatistics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseStatistics.rst @@ -1,12 +1,19 @@ -============== ============ ======== =========================================== -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 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 0e07797aec9..f915eedc796 100644 --- a/src/coreComponents/schema/docs/SinglePhaseWell.rst +++ b/src/coreComponents/schema/docs/SinglePhaseWell.rst @@ -1,18 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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/SolidMechanicsAugmentedLagrangianContact.rst b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst index 9b736b1b4d6..4469a1885d7 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst @@ -1,29 +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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 + | 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/SolidMechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst index eca5d02f2ed..ec7f583cf45 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures.rst @@ -1,30 +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 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 -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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 ea949482327..90096899f7a 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact.rst @@ -1,31 +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 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 -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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 bed0562d496..f3ecf2b759c 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE.rst @@ -1,31 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 c8483e51e88..0f2fd92b13d 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsStateReset.rst @@ -1,13 +1,18 @@ -=================== ============ ======== ============================================ -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 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 2395830a112..8c3147902c9 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsStatistics.rst @@ -1,12 +1,19 @@ -=============== ============ ======== =========================================== -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 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 bed0562d496..f3ecf2b759c 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM.rst @@ -1,31 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 35d3b93b477..e5a6e14a0cf 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_MPM.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_MPM.rst @@ -1,42 +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 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 -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 de9a7ad86ee..af728b04e46 100644 --- a/src/coreComponents/schema/docs/SoloEvent.rst +++ b/src/coreComponents/schema/docs/SoloEvent.rst @@ -1,23 +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 0 Log level -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 660880a3b49..9322448e819 100644 --- a/src/coreComponents/schema/docs/SourceFlux.rst +++ b/src/coreComponents/schema/docs/SourceFlux.rst @@ -1,20 +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 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. -====================== ================== ======== ======================================================================================================================================================================================================================================================================================== +====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +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/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/SurfaceGenerator.rst b/src/coreComponents/schema/docs/SurfaceGenerator.rst index 4160911ec7b..2d1c3f68809 100644 --- a/src/coreComponents/schema/docs/SurfaceGenerator.rst +++ b/src/coreComponents/schema/docs/SurfaceGenerator.rst @@ -1,21 +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 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. -writeLinearSystem integer 0 Write matrix, rhs, solution to screen ( = 1) or file ( = 2). -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 58522e086bc..a666143f201 100644 --- a/src/coreComponents/schema/docs/Traction.rst +++ b/src/coreComponents/schema/docs/Traction.rst @@ -1,24 +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 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. -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 d8144999bee..de024cc2363 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 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 952b60a3267..842a9c48625 100644 --- a/src/coreComponents/schema/docs/VTK.rst +++ b/src/coreComponents/schema/docs/VTK.rst @@ -7,7 +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 0 Log level 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..47a88acf690 100644 --- a/src/coreComponents/schema/docs/VTKMesh.rst +++ b/src/coreComponents/schema/docs/VTKMesh.rst @@ -7,7 +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 0 Log level +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 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 0df45b1798d..3567f08b091 100644 --- a/src/coreComponents/schema/docs/VTKWell.rst +++ b/src/coreComponents/schema/docs/VTKWell.rst @@ -1,17 +1,23 @@ -===================== ========= ======== ==================================================================================================== -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 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 c31d40067e7..3d0d209bcb1 100644 --- a/src/coreComponents/schema/docs/WellControls.rst +++ b/src/coreComponents/schema/docs/WellControls.rst @@ -17,7 +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 0 Log level +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 ecbf7a1b217..e09491f33fa 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -936,7 +936,10 @@ - + @@ -961,7 +964,10 @@ - + @@ -992,7 +998,10 @@ - + @@ -1029,7 +1038,10 @@ - + @@ -1106,7 +1118,16 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1135,7 +1156,14 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1163,7 +1191,14 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1199,7 +1234,14 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1225,7 +1267,14 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1261,15 +1310,28 @@ This keyword is ignored for single-phase flow simulations--> - + - + - + @@ -1291,7 +1353,14 @@ This keyword is ignored for single-phase flow simulations--> - + @@ -1442,6 +1511,11 @@ stress - traction is applied to the faces as specified by the inner product of i + + @@ -1497,6 +1571,11 @@ stress - traction is applied to the faces as specified by the inner product of i + + @@ -1546,7 +1625,10 @@ stress - traction is applied to the faces as specified by the inner product of i - + @@ -1583,6 +1665,13 @@ stress - traction is applied to the faces as specified by the inner product of i + + @@ -1689,7 +1778,13 @@ stress - traction is applied to the faces as specified by the inner product of i - + @@ -1821,7 +1916,50 @@ the relative residual norm satisfies: - + @@ -1906,7 +2044,10 @@ the relative residual norm satisfies: - + @@ -2035,6 +2176,11 @@ the relative residual norm satisfies: + + @@ -2111,8 +2257,6 @@ the relative residual norm satisfies: - - @@ -2213,7 +2357,27 @@ the relative residual norm satisfies: - + @@ -2251,7 +2415,28 @@ the relative residual norm satisfies: - + @@ -2321,7 +2506,29 @@ the relative residual norm satisfies: - + @@ -2381,7 +2588,28 @@ the relative residual norm satisfies: - + @@ -2435,7 +2663,48 @@ the relative residual norm satisfies: - + @@ -2521,7 +2790,36 @@ the relative residual norm satisfies: - + @@ -2581,7 +2879,33 @@ the relative residual norm satisfies: - + @@ -2603,7 +2927,32 @@ the relative residual norm satisfies: - + @@ -2642,7 +2991,33 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -2685,7 +3060,10 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -2763,7 +3141,28 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - + @@ -2823,7 +3222,28 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - + @@ -2873,7 +3293,29 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - + @@ -2897,7 +3339,32 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - + @@ -2927,7 +3394,34 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> - + @@ -2973,7 +3467,27 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3004,7 +3518,32 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3033,7 +3572,33 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3065,7 +3630,29 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3097,7 +3684,31 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3129,7 +3740,29 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3175,7 +3808,29 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3219,7 +3874,27 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3243,13 +3918,37 @@ Local- Add jump stabilization on interior of macro elements--> - - + @@ -3279,13 +3978,37 @@ For the energy balance equation, the mass flux is multipied by the enthalpy in t - - + @@ -3315,7 +4038,31 @@ For the energy balance equation, the mass flux is multipied by the enthalpy in t - + @@ -3348,7 +4095,32 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3363,8 +4135,11 @@ Local- Add jump stabilization on interior of macro elements--> +<<<<<<< HEAD +======= +>>>>>>> origin/develop @@ -3377,7 +4152,35 @@ Local- Add jump stabilization on interior of macro elements--> +<<<<<<< HEAD + +======= +>>>>>>> origin/develop @@ -3385,8 +4188,11 @@ Local- Add jump stabilization on interior of macro elements--> +<<<<<<< HEAD +======= +>>>>>>> origin/develop @@ -3403,7 +4209,31 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3432,7 +4262,31 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3458,13 +4312,37 @@ Local- Add jump stabilization on interior of macro elements--> - - + @@ -3492,7 +4370,31 @@ For the energy balance equation, the mass flux is multipied by the enthalpy in t - + @@ -3514,7 +4416,31 @@ For the energy balance equation, the mass flux is multipied by the enthalpy in t - + @@ -3546,7 +4472,33 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3568,7 +4520,31 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3591,8 +4567,11 @@ Local- Add jump stabilization on interior of macro elements--> * ImplicitDynamic * ExplicitDynamic--> +<<<<<<< HEAD +======= +>>>>>>> origin/develop @@ -3612,7 +4591,36 @@ Local- Add jump stabilization on interior of macro elements--> +<<<<<<< HEAD + +======= +>>>>>>> origin/develop @@ -3637,8 +4645,11 @@ Local- Add jump stabilization on interior of macro elements--> +<<<<<<< HEAD +======= +>>>>>>> origin/develop @@ -3653,7 +4664,32 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3698,7 +4734,30 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3741,7 +4800,30 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3800,7 +4882,27 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3854,7 +4956,33 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3891,7 +5019,10 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3907,7 +5038,17 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3917,7 +5058,10 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3927,7 +5071,10 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3943,7 +5090,11 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3983,7 +5134,11 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -3999,7 +5154,11 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -4011,7 +5170,14 @@ Local- Add jump stabilization on interior of macro elements--> +<<<<<<< HEAD + +======= +>>>>>>> origin/develop @@ -4021,7 +5187,14 @@ Local- Add jump stabilization on interior of macro elements--> +<<<<<<< HEAD + +======= +>>>>>>> origin/develop @@ -4031,7 +5204,10 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -4041,7 +5217,10 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -4053,7 +5232,14 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -4063,7 +5249,12 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -4073,7 +5264,14 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -4087,7 +5285,7 @@ Local- Add jump stabilization on interior of macro elements--> - @@ -4104,7 +5302,11 @@ Local- Add jump stabilization on interior of macro elements--> - + @@ -4330,7 +5532,10 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + @@ -4350,7 +5555,10 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + @@ -4370,7 +5578,10 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + @@ -4390,7 +5601,10 @@ The expected format is "{ waterMax, oilMax }", in that order--> - + @@ -5407,6 +6621,11 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia + + @@ -5421,6 +6640,11 @@ If you want to do a three-phase simulation, please use instead wettingIntermedia + +