diff --git a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp index b74ca347636..795c674cadc 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/SinglePhasePoromechanicsConformingFractures.cpp @@ -42,10 +42,9 @@ SinglePhasePoromechanicsConformingFractures< FLOW_SOLVER >::SinglePhasePoromecha Group * const parent ) : Base( name, parent ) { - appendLogLevelDescription( "logLevel >= 3", "The summary of declared fields and coupling" ); + this->appendLogLevelDescription( "logLevel >= 3", "The summary of declared fields and coupling" ); LinearSolverParameters & params = this->m_linearSolverParameters.get(); - LinearSolverParameters & params = m_linearSolverParameters.get(); params.mgr.strategy = LinearSolverParameters::MGR::StrategyType::singlePhasePoromechanicsConformingFractures; params.mgr.separateComponents = false; params.mgr.displacementFieldName = solidMechanics::totalDisplacement::key(); diff --git a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst index 34c3bd7b9de..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/AcousticFirstOrderSEM.rst @@ -1,54 +1,57 @@ -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/AcousticSEM.rst b/src/coreComponents/schema/docs/AcousticSEM.rst index 9fa66005d69..0dc6a094690 100644 --- a/src/coreComponents/schema/docs/AcousticSEM.rst +++ b/src/coreComponents/schema/docs/AcousticSEM.rst @@ -1,55 +1,58 @@ -========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | - Print PML parameters - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================== ==================================== ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================== ==================================== ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | - Print PML parameters + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/AcousticVTISEM.rst b/src/coreComponents/schema/docs/AcousticVTISEM.rst index 34c3bd7b9de..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/AcousticVTISEM.rst +++ b/src/coreComponents/schema/docs/AcousticVTISEM.rst @@ -1,54 +1,57 @@ -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst index 8e1db83c332..19fa18b946d 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM.rst @@ -1,86 +1,89 @@ -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used -continuationDBC integer 1 Flag for enabling continuation parameter -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information on pressure and temperature - | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects - | - Information about pressure, phase, temperature during time step - | - Information on density during outer iteration - | - Information on volume frations - | - Information on CFL number - | - Print the residual values - | - Information about max pressure/max component density change - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and negative density - | - Information on negative density values - | logLevel >= 1 and negative pressure - | - Information on negative pressure values - | logLevel >= 1 and non first nonlinear iteration - | - Information on the face boundary conditions log - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 1 and scaling type is local - | - Print scaling factors - | logLevel >= 1 and thermal simulation - | - Information on max relative temperature - | - Information about temperature changes - | logLevel >= 1 and total density > 0 - | - Information on total density values - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility -name groupName required A name is required for any non-unique nodes -omegaDBC real64 1 Factor by which DBC flux is multiplied -scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: - | * Global - | * Local -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useDBC integer 0 Enable Dissipation-based continuation flux -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= =========================================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +========================================= =========================================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +========================================= =========================================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contMultiplierDBC real64 0.5 Factor by which continuation parameter is changed every newton when DBC is used +continuationDBC integer 1 Flag for enabling continuation parameter +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +kappaminDBC real64 1e-20 Factor that controls how much dissipation is kept in the system when continuation is used +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | - Information about pressure, phase, temperature during time step + | - Information on density during outer iteration + | - Information on volume frations + | - Information on CFL number + | - Print the residual values + | - Information about max pressure/max component density change + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and negative density + | - Information on negative density values + | logLevel >= 1 and negative pressure + | - Information on negative pressure values + | logLevel >= 1 and non first nonlinear iteration + | - Information on the face boundary conditions log + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 1 and scaling type is local + | - Print scaling factors + | logLevel >= 1 and thermal simulation + | - Information on max relative temperature + | - Information about temperature changes + | logLevel >= 1 and total density > 0 + | - Information on total density values + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativeCompDensChange real64 1.79769e+308 Maximum (relative) change in a component density in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +minScalingFactor real64 0.01 Minimum value for solution scaling factor +miscibleDBC integer 0 Flag for enabling DBC formulation with/without miscibility +name groupName required A name is required for any non-unique nodes +omegaDBC real64 1 Factor by which DBC flux is multiplied +scalingType geos_CompositionalMultiphaseFVM_ScalingType Global | Solution scaling type.Valid options: + | * Global + | * Local +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativeCompDensChangeInTimeStep real64 1.79769e+308 Target (relative) change in component density in a time step +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useDBC integer 0 Enable Dissipation-based continuation flux +useMass integer 0 Use mass formulation instead of molar. Warning : Affects SourceFlux rates units. +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= =========================================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst index 8303e68b3a8..a73b3252efc 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM.rst @@ -1,65 +1,68 @@ -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information on pressure and temperature - | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects - | - Information about pressure, phase, temperature during time step - | - Information on density during outer iteration - | - Information on volume frations - | - Information on CFL number - | - Print the residual values - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 1 and thermal simulation - | - Information on max relative temperature - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration -maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration -maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration -maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -minCompDens real64 1e-10 Minimum allowed global component density -name groupName required A name is required for any non-unique nodes -solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets -targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. -targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) -targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) -temperature real64 required Temperature -useMass integer 0 Use mass formulation instead of molar -useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used -useTotalMassEquation integer 1 Flag indicating whether total mass equation is used -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================================= ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================================= ================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================================= ================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Warnings about non-simulated region intersecting, that can cancel sourceFlux effects + | - Information about pressure, phase, temperature during time step + | - Information on density during outer iteration + | - Information on volume frations + | - Information on CFL number + | - Print the residual values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 1 and thermal simulation + | - Information on max relative temperature + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 0.5 Maximum (absolute) change in a component fraction in a Newton iteration +maxRelativeCompDensChange real64 1.79769e+308 Maximum (relative) change in a component density in a Newton iteration +maxRelativePressureChange real64 0.5 Maximum (relative) change in pressure in a Newton iteration +maxRelativeTemperatureChange real64 0.5 Maximum (relative) change in temperature in a Newton iteration +maxSequentialCompDensChange real64 1 Maximum (absolute) component density change in a sequential iteration, used for outer loop convergence check +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +minCompDens real64 1e-10 Minimum allowed global component density +minScalingFactor real64 0.01 Minimum value for solution scaling factor +name groupName required A name is required for any non-unique nodes +solutionChangeScalingFactor real64 0.5 Damping factor for solution change targets +targetFlowCFL real64 -1 Target CFL condition `CFL condition `_when computing the next timestep. +targetPhaseVolFractionChangeInTimeStep real64 0.2 Target (absolute) change in phase volume fraction in a time step +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +targetRelativeCompDensChangeInTimeStep real64 1.79769e+308 Target (relative) change in component density in a time step +targetRelativePressureChangeInTimeStep real64 0.2 Target (relative) change in pressure in a time step (expected value between 0 and 1) +targetRelativeTemperatureChangeInTimeStep real64 0.2 Target (relative) change in temperature in a time step (expected value between 0 and 1) +temperature real64 required Temperature +useMass integer 0 Use mass formulation instead of molar. Warning : Affects SourceFlux rates units. +useSimpleAccumulation integer 1 Flag indicating whether simple accumulation form is used +useTotalMassEquation integer 1 Flag indicating whether total mass equation is used +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================= ================== ============ ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst index e6895f5228c..0558fd89983 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics.rst @@ -35,12 +35,12 @@ logLevel integer 0 | Sets name groupName required A name is required for any non-unique nodes reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst index 94dbc6be1d9..44dfcccdfe4 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseWell.rst @@ -1,48 +1,50 @@ -============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Infos on residual values - | - Output well rates to a simple csv file - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | - Infos on the BHP pressure - | - Infos on the surface density - | logLevel >= 2 and use surface conditions - | - Information on the phase and total density in the reference element - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations -maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -useMass integer 0 Use total mass equation -writeCSV integer 0 Write rates into a CSV file -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -WellControls node :ref:`XML_WellControls` -============================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +============================= ================== ============ ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================= ================== ============ ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +allowLocalCompDensityChopping integer 1 Flag indicating whether local (cell-wise) chopping of negative compositions is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Infos on residual values + | - Output well rates to a simple csv file + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on the BHP pressure + | - Infos on the surface density + | logLevel >= 2 and use surface conditions + | - Information on the phase and total density in the reference element + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxCompFractionChange real64 1 Maximum (absolute) change in a component fraction between two Newton iterations +maxRelativeCompDensChange real64 1.79769e+308 Maximum (relative) change in a component density between two Newton iterations +maxRelativePressureChange real64 1 Maximum (relative) change in pressure between two Newton iterations (recommended with rate control) +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +useMass integer 0 Use mass formulation instead of molar +useTotalMassEquation integer 1 Use total mass equation +writeCSV integer 0 Write rates into a CSV file +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +WellControls node :ref:`XML_WellControls` +============================= ================== ============ ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst index 34c3bd7b9de..59d12f66aa9 100644 --- a/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst +++ b/src/coreComponents/schema/docs/ElasticFirstOrderSEM.rst @@ -1,54 +1,57 @@ -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ========== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/ElasticSEM.rst b/src/coreComponents/schema/docs/ElasticSEM.rst index b385d767058..b7195754890 100644 --- a/src/coreComponents/schema/docs/ElasticSEM.rst +++ b/src/coreComponents/schema/docs/ElasticSEM.rst @@ -1,57 +1,60 @@ -========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -Name Type Default Description -========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -dtSeismoTrace real64 0 Time step for output pressure at receivers -enableLifo integer 0 Set to 1 to enable LIFO storage feature -forward integer 1 Set to 1 to compute forward propagation -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) -lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) -lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) -linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) -linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Information about linear DAS - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise -receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers -rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default -saveFields integer 0 Set to 1 to save fields during forward and restore them during backward -shotIndex integer 0 Set the current shot for temporary files -sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources -sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). -sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -timeSourceDelay real32 -1 Source time delay (1 / f0 by default) -timeSourceFrequency real32 0 Central frequency for the time source -useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: 1 for strain integration, 2 for displacement difference -useVTI integer 0 Flag to apply VTI anisotropy. The default is to use isotropic physic. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ============================ ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +============================== ==================================== ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ==================================== ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +attenuationType geos_WaveSolverUtils_AttenuationType none Flag to indicate which attenuation model to use: "none" for no attenuation, "sls\ for the standard-linear-solid (SLS) model (Fichtner, 2014). +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +dtSeismoTrace real64 0 Time step for output pressure at receivers +enableLifo integer 0 Set to 1 to enable LIFO storage feature +forward integer 1 Set to 1 to compute forward propagation +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +lifoOnDevice integer -80 Set the capacity of the lifo device storage (if negative, opposite of percentage of remaining memory) +lifoOnHost integer -80 Set the capacity of the lifo host storage (if negative, opposite of percentage of remaining memory) +lifoSize integer 2147483647 Set the capacity of the lifo storage (should be the total number of buffers to store in the LIFO) +linearDASGeometry real64_array2d {{0}} Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length) +linearDASSamples integer 5 Number of sample points to be used for strain integration when integrating the strain for the DAS signal +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information about linear DAS + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +outputSeismoTrace integer 0 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise +receiverCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the receivers +rickerOrder integer 2 Flag that indicates the order of the Ricker to be used o, 1 or 2. Order 2 by default +saveFields integer 0 Set to 1 to save fields during forward and restore them during backward +shotIndex integer 0 Set the current shot for temporary files +slsAnelasticityCoefficients real32_array {0} Anelasticity coefficients for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding reference frequencies must be provided. +slsReferenceAngularFrequencies real32_array {0} Reference angular frequencies (omega) for the standard-linear-solid (SLS) anelasticity.The default value is { }, corresponding to no attenuation. An array with the corresponding anelasticity coefficients must be provided. +sourceCoordinates real64_array2d {{0}} Coordinates (x,y,z) of the sources +sourceForce R1Tensor {0,0,0} Force of the source: 3 real values for a vector source, and 6 real values for a tensor source (in Voigt notation).The default value is { 0, 0, 0 } (no net force). +sourceMoment R2SymTensor {1,1,1,0,0,0} Moment of the source: 6 real values describing a symmetric tensor in Voigt notation.The default value is { 1, 1, 1, 0, 0, 0 } (diagonal moment, corresponding to a pure explosion). +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeSourceDelay real32 -1 Source time delay (1 / f0 by default) +timeSourceFrequency real32 0 Central frequency for the time source +useDAS geos_WaveSolverUtils_DASType none Flag to indicate if DAS data will be modeled, and which DAS type to use: "none" to deactivate DAS, "strainIntegration" for strain integration, "dipole" for displacement difference +useVTI integer 0 Flag to apply VTI anisotropy. The default is to use isotropic physic. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ==================================== ============= ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/Events.rst b/src/coreComponents/schema/docs/Events.rst index edf1c9286b6..b7201702306 100644 --- a/src/coreComponents/schema/docs/Events.rst +++ b/src/coreComponents/schema/docs/Events.rst @@ -7,8 +7,8 @@ logLevel integer 0 | Sets the leve | A level of 0 outputs minimal information, higher levels require more. | logLevel >= 1 | - Information about current sub-event -maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. -maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. +maxCycle integer 2147483647 Maximum simulation cycle for the global event loop. Disabled by default. +maxTime real64 1.79769e+308 Maximum simulation time for the global event loop. Disabled by default. minTime real64 0 Start simulation time for the global event loop. timeOutputFormat geos_EventManager_TimeOutputFormat seconds Format of the time in the GEOS log. HaltEvent node :ref:`XML_HaltEvent` diff --git a/src/coreComponents/schema/docs/Hydrofracture.rst b/src/coreComponents/schema/docs/Hydrofracture.rst index 1105baae110..c7d93ed9147 100644 --- a/src/coreComponents/schema/docs/Hydrofracture.rst +++ b/src/coreComponents/schema/docs/Hydrofracture.rst @@ -41,6 +41,12 @@ maxNumResolves integer name groupName required A name is required for any non-unique nodes newFractureInitializationType geos_HydrofractureSolver >_InitializationType Pressure Type of new fracture element initialization. Can be Pressure or Displacement. solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements surfaceGeneratorName groupNameRef required Name of the surface generator to use in the hydrofracture solver targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. useQuasiNewton integer 0 (no description available) diff --git a/src/coreComponents/schema/docs/HydrofractureInitialization.rst b/src/coreComponents/schema/docs/HydrofractureInitialization.rst index 18e3a0dd9e7..5c3a3317d9c 100644 --- a/src/coreComponents/schema/docs/HydrofractureInitialization.rst +++ b/src/coreComponents/schema/docs/HydrofractureInitialization.rst @@ -1,12 +1,15 @@ -============================ ============ ======== =========================================== -Name Type Default Description -============================ ============ ======== =========================================== -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -poromechanicsSolverName groupNameRef required Name of the poromechanics solver -solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics -============================ ============ ======== =========================================== +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst index 8028a317831..8482d5e5c3c 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanics.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanics.rst @@ -35,12 +35,12 @@ logLevel integer 0 | Sets t | - Output to file the assembled linear system and solutions (matrices and vectors) name groupName required A name is required for any non-unique nodes solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -stabilizationMultiplier real64 1 Constant multiplier of stabilization strength. +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. -stabilizationType geos_stabilization_StabilizationType None | Stabilization type. Options are: - | None - Add no stabilization to mass equation, - | Global - Add stabilization to all faces, - | Local - Add stabilization only to interiors of macro elements. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` diff --git a/src/coreComponents/schema/docs/SinglePhaseFVM.rst b/src/coreComponents/schema/docs/SinglePhaseFVM.rst index b5a093f8f36..bb6fd73b18e 100644 --- a/src/coreComponents/schema/docs/SinglePhaseFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseFVM.rst @@ -7,7 +7,11 @@ allowNegativePressure integer 1 Flag indicating if ne cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. +isThermal integer 0 | + | SourceFluxes application if isThermal is enabled : + | - negative value (injection): the mass balance equation is modified to considered the additional source term, + | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. + | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. | logLevel >= 1 diff --git a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst index 01c0990701b..b718407d304 100644 --- a/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseHybridFVM.rst @@ -1,24 +1,50 @@ -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 | Flag indicating whether the problem is thermal or not. - | SourceFluxes application if isThermal is enabled : - | - negative value (injection): the mass balance equation is modified to considered the additional source term, - | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. - | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== + + +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +Name Type Default Description +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= +allowNegativePressure integer 1 Flag indicating if negative pressure is allowed +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 | + | SourceFluxes application if isThermal is enabled : + | - negative value (injection): the mass balance equation is modified to considered the additional source term, + | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. + | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on pressure and temperature + | - Print pressure change + | - Information on negative pressure values + | - Print the residual norm values + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration +maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check +maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check +name groupName required A name is required for any non-unique nodes +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +temperature real64 0 Temperature +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================== ================== ======== ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst index d561d6692cb..840c91377df 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanics.rst @@ -1,42 +1,48 @@ -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst index c00235f2391..ac418081a75 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst @@ -1,43 +1,49 @@ -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) - | - The summary of declared fields and coupling -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) + | - The summary of declared fields and coupling +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst new file mode 100644 index 00000000000..5c3a3317d9c --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst @@ -0,0 +1,15 @@ + + +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst new file mode 100644 index 00000000000..adf1c1b8aec --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst @@ -0,0 +1,9 @@ + + +==== ==== ============================ +Name Type Description +==== ==== ============================ + (no documentation available) +==== ==== ============================ + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst new file mode 100644 index 00000000000..689e5d333c1 --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst @@ -0,0 +1,41 @@ + + +========================================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +poromechanicsConformingFracturesSolverName groupNameRef required Name of the poromechanicsConformingFractures solver used by the coupled solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +wellSolverName groupNameRef required Name of the well solver used by the coupled solver +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst new file mode 100644 index 00000000000..cccf4603c70 --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst @@ -0,0 +1,14 @@ + + +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +Name Type Description +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +discretization groupNameRef Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +maxStableDt real64 Value of the Maximum Stable Timestep for this solver. +meshTargets geos_mapBase, LvArray_Array, int, LvArray_ChaiBuffer>, std_integral_constant > MeshBody/Region combinations that the solver will be applied to. +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst index d561d6692cb..840c91377df 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst @@ -1,42 +1,48 @@ -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst new file mode 100644 index 00000000000..5c3a3317d9c --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst @@ -0,0 +1,15 @@ + + +============================ ============ ======== ======================================================================================================================================================================================================================================= +Name Type Default Description +============================ ============ ======== ======================================================================================================================================================================================================================================= +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information about physics solver stress initialization +name groupName required A name is required for any non-unique nodes +poromechanicsSolverName groupNameRef required Name of the poromechanics solver +solidMechanicsStatisticsName groupNameRef Name of the solid mechanics statistics +============================ ============ ======== ======================================================================================================================================================================================================================================= + + diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst new file mode 100644 index 00000000000..adf1c1b8aec --- /dev/null +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst @@ -0,0 +1,9 @@ + + +==== ==== ============================ +Name Type Description +==== ==== ============================ + (no documentation available) +==== ==== ============================ + + diff --git a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst index 85c6cefa39c..bb6fd73b18e 100644 --- a/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst +++ b/src/coreComponents/schema/docs/SinglePhaseProppantFVM.rst @@ -1,6 +1,5 @@ -<<<<<<< HEAD ============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ Name Type Default Description ============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ @@ -8,7 +7,11 @@ allowNegativePressure integer 1 Flag indicating if ne cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. +isThermal integer 0 | + | SourceFluxes application if isThermal is enabled : + | - negative value (injection): the mass balance equation is modified to considered the additional source term, + | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. + | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). | A level of 0 outputs minimal information, higher levels require more. | logLevel >= 1 @@ -43,29 +46,5 @@ temperature real64 0 Temperature LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` ============================== ================== ======== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ -======= -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -allowNegativePressure integer 1 Flag indicating if negative pressure is allowed -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 | Flag indicating whether the problem is thermal or not. - | SourceFluxes application if isThermal is enabled : - | - negative value (injection): the mass balance equation is modified to considered the additional source term, - | - positive value (production): both the mass balance and the energy balance equations are modified to considered the additional source term. - | For the energy balance equation, the mass flux is multipied by the enthalpy in the cell from which the fluid is being produced. -logLevel integer 0 Log level -maxAbsolutePressureChange real64 -1 Maximum (absolute) pressure change in a Newton iteration -maxSequentialPressureChange real64 100000 Maximum (absolute) pressure change in a sequential iteration, used for outer loop convergence check -maxSequentialTemperatureChange real64 0.1 Maximum (absolute) temperature change in a sequential iteration, used for outer loop convergence check -name groupName required A name is required for any non-unique nodes -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -temperature real64 0 Temperature -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -============================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== ->>>>>>> origin/develop diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst index 870cbdbf3be..deebaede0d7 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics.rst @@ -1,42 +1,48 @@ -=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). - | A level of 0 outputs minimal information, higher levels require more. - | logLevel >= 1 - | - Information on line search - | - Information on global solution scaling factor - | - Information on the timestep - | - Print residual norm - | - Print solvers name - | - Print residual norm - | - Print time stepping - | - Information on each iteration - | logLevel >= 1 and configuration didn't converge - | - Information about testing new configuration and print the time step - | logLevel >= 1 and incorrect solution - | - Information about line search failed - | logLevel >= 1 and linear system - | - Information on number of iterations and residual reduction - | logLevel >= 1 and non linear system - | - Information on each newton Iteration - | logLevel >= 1 and residual norm above the max allowed residual norm - | - Indicate allowed residual norm - | logLevel >= 2 - | - Output to screen the assembled linear system and solutions (matrices and vectors) - | logLevel >= 3 - | - Output to file the assembled linear system and solutions (matrices and vectors) -name groupName required A name is required for any non-unique nodes -reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -=========================== ================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Print solvers name + | - Print residual norm + | - Print time stepping + | - Information on each iteration + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +name groupName required A name is required for any non-unique nodes +reservoirAndWellsSolverName groupNameRef required Name of the reservoirAndWells solver used by the coupled solver +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +stabilizationMultiplier real64 1 Constant multiplier of stabilization strength +stabilizationRegionNames groupNameRef_array {} Regions where stabilization is applied. +stabilizationType geos_stabilization_StabilizationType None | StabilizationType. Options are: + | None- Add no stabilization to mass equation + | Global- Add jump stabilization to all faces + | Local- Add jump stabilization on interior of macro elements +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +=========================== ==================================== ======== ===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst new file mode 100644 index 00000000000..4469a1885d7 --- /dev/null +++ b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst @@ -0,0 +1,52 @@ + + +========================= ====================================================== =============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +========================= ====================================================== =============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +discretization groupNameRef required Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified. +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +logLevel integer 0 | Sets the level of information to write in the standard output (the console typically). + | A level of 0 outputs minimal information, higher levels require more. + | logLevel >= 1 + | - Information on line search + | - Information on global solution scaling factor + | - Information on the timestep + | - Print residual norm + | - Information on number of elements for each fracture states + | logLevel >= 1 and configuration didn't converge + | - Information about testing new configuration and print the time step + | logLevel >= 1 and incorrect solution + | - Information about line search failed + | logLevel >= 1 and linear system + | - Information on number of iterations and residual reduction + | logLevel >= 1 and non linear system + | - Information on each newton Iteration + | logLevel >= 1 and residual norm above the max allowed residual norm + | - Indicate allowed residual norm + | logLevel >= 2 + | - Output to screen the assembled linear system and solutions (matrices and vectors) + | - Infos on residuals values + | logLevel >= 2 and target set is empty + | - Warning about boundary conditions + | logLevel >= 3 + | - Output to file the assembled linear system and solutions (matrices and vectors) +massDamping real64 0 Value of mass based damping coefficient. +maxNumResolves integer 10 Value to indicate how many resolves may be executed after some other event is executed. For example, if a SurfaceGenerator is specified, it will be executed after the mechanics solve. However if a new surface is generated, then the mechanics solve must be executed again due to the change in topology. +name groupName required A name is required for any non-unique nodes +newmarkBeta real64 0.25 Value of :math:`\beta` in the Newmark Method for Implicit Dynamic time integration option. This should be pow(newmarkGamma+0.5,2.0)/4.0 unless you know what you are doing. +newmarkGamma real64 0.5 Value of :math:`\gamma` in the Newmark Method for Implicit Dynamic time integration option +stiffnessDamping real64 0 Value of stiffness based damping coefficient. +strainTheory integer 0 | Indicates whether or not to use `Infinitesimal Strain Theory `_, or `Finite Strain Theory `_. Valid Inputs are: + | 0 - Infinitesimal Strain + | 1 - Finite Strain +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +timeIntegrationOption geos_SolidMechanicsLagrangianFEM_TimeIntegrationOption ExplicitDynamic | Time integration method. Options are: + | * QuasiStatic + | * ImplicitDynamic + | * ExplicitDynamic +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +========================= ====================================================== =============== ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== + + diff --git a/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst new file mode 100644 index 00000000000..1a9ad823675 --- /dev/null +++ b/src/coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst @@ -0,0 +1,16 @@ + + +========================= ====================================================================================================================================================== ===================================================================== +Name Type Description +========================= ====================================================================================================================================================== ===================================================================== +contactRelationName groupNameRef Name of contact relation to enforce constraints on fracture boundary. +maxForce real64 The maximum force contribution in the problem domain. +maxStableDt real64 Value of the Maximum Stable Timestep for this solver. +meshTargets geos_mapBase, LvArray_Array, int, LvArray_ChaiBuffer>, std_integral_constant > MeshBody/Region combinations that the solver will be applied to. +surfaceGeneratorName string Name of the surface generator to use +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ===================================================================== + + diff --git a/src/coreComponents/schema/docs/Solvers.rst b/src/coreComponents/schema/docs/Solvers.rst index 87f18a99508..a8779059e55 100644 --- a/src/coreComponents/schema/docs/Solvers.rst +++ b/src/coreComponents/schema/docs/Solvers.rst @@ -1,47 +1,49 @@ -============================================= ======== =========== ======================================================== -Name Type Default Description -============================================= ======== =========== ======================================================== -gravityVector R1Tensor {0,0,-9.81} Gravity vector used in the physics solvers -AcousticElasticSEM node :ref:`XML_AcousticElasticSEM` -AcousticFirstOrderSEM node :ref:`XML_AcousticFirstOrderSEM` -AcousticSEM node :ref:`XML_AcousticSEM` -AcousticVTISEM node :ref:`XML_AcousticVTISEM` -CompositionalMultiphaseFVM node :ref:`XML_CompositionalMultiphaseFVM` -CompositionalMultiphaseHybridFVM node :ref:`XML_CompositionalMultiphaseHybridFVM` -CompositionalMultiphaseReservoir node :ref:`XML_CompositionalMultiphaseReservoir` -CompositionalMultiphaseReservoirPoromechanics node :ref:`XML_CompositionalMultiphaseReservoirPoromechanics` -CompositionalMultiphaseWell node :ref:`XML_CompositionalMultiphaseWell` -ElasticFirstOrderSEM node :ref:`XML_ElasticFirstOrderSEM` -ElasticSEM node :ref:`XML_ElasticSEM` -EmbeddedSurfaceGenerator node :ref:`XML_EmbeddedSurfaceGenerator` -FlowProppantTransport node :ref:`XML_FlowProppantTransport` -Hydrofracture node :ref:`XML_Hydrofracture` -LaplaceFEM node :ref:`XML_LaplaceFEM` -MultiphasePoromechanics node :ref:`XML_MultiphasePoromechanics` -MultiphasePoromechanicsReservoir node :ref:`XML_MultiphasePoromechanicsReservoir` -PhaseFieldDamageFEM node :ref:`XML_PhaseFieldDamageFEM` -PhaseFieldFracture node :ref:`XML_PhaseFieldFracture` -ProppantTransport node :ref:`XML_ProppantTransport` -ReactiveCompositionalMultiphaseOBL node :ref:`XML_ReactiveCompositionalMultiphaseOBL` -SeismicityRate node :ref:`XML_SeismicityRate` -SinglePhaseFVM node :ref:`XML_SinglePhaseFVM` -SinglePhaseHybridFVM node :ref:`XML_SinglePhaseHybridFVM` -SinglePhasePoromechanics node :ref:`XML_SinglePhasePoromechanics` -SinglePhasePoromechanicsConformingFractures node :ref:`XML_SinglePhasePoromechanicsConformingFractures` -SinglePhasePoromechanicsEmbeddedFractures node :ref:`XML_SinglePhasePoromechanicsEmbeddedFractures` -SinglePhasePoromechanicsReservoir node :ref:`XML_SinglePhasePoromechanicsReservoir` -SinglePhaseProppantFVM node :ref:`XML_SinglePhaseProppantFVM` -SinglePhaseReservoir node :ref:`XML_SinglePhaseReservoir` -SinglePhaseReservoirPoromechanics node :ref:`XML_SinglePhaseReservoirPoromechanics` -SinglePhaseWell node :ref:`XML_SinglePhaseWell` -SolidMechanicsEmbeddedFractures node :ref:`XML_SolidMechanicsEmbeddedFractures` -SolidMechanicsLagrangeContact node :ref:`XML_SolidMechanicsLagrangeContact` -SolidMechanicsLagrangianSSLE node :ref:`XML_SolidMechanicsLagrangianSSLE` -SolidMechanics_LagrangianFEM node :ref:`XML_SolidMechanics_LagrangianFEM` -SolidMechanics_MPM node :ref:`XML_SolidMechanics_MPM` -SurfaceGenerator node :ref:`XML_SurfaceGenerator` -============================================= ======== =========== ======================================================== +==================================================== ======== =========== =============================================================== +Name Type Default Description +==================================================== ======== =========== =============================================================== +gravityVector R1Tensor {0,0,-9.81} Gravity vector used in the physics solvers +AcousticElasticSEM node :ref:`XML_AcousticElasticSEM` +AcousticFirstOrderSEM node :ref:`XML_AcousticFirstOrderSEM` +AcousticSEM node :ref:`XML_AcousticSEM` +AcousticVTISEM node :ref:`XML_AcousticVTISEM` +CompositionalMultiphaseFVM node :ref:`XML_CompositionalMultiphaseFVM` +CompositionalMultiphaseHybridFVM node :ref:`XML_CompositionalMultiphaseHybridFVM` +CompositionalMultiphaseReservoir node :ref:`XML_CompositionalMultiphaseReservoir` +CompositionalMultiphaseReservoirPoromechanics node :ref:`XML_CompositionalMultiphaseReservoirPoromechanics` +CompositionalMultiphaseWell node :ref:`XML_CompositionalMultiphaseWell` +ElasticFirstOrderSEM node :ref:`XML_ElasticFirstOrderSEM` +ElasticSEM node :ref:`XML_ElasticSEM` +EmbeddedSurfaceGenerator node :ref:`XML_EmbeddedSurfaceGenerator` +FlowProppantTransport node :ref:`XML_FlowProppantTransport` +Hydrofracture node :ref:`XML_Hydrofracture` +LaplaceFEM node :ref:`XML_LaplaceFEM` +MultiphasePoromechanics node :ref:`XML_MultiphasePoromechanics` +MultiphasePoromechanicsReservoir node :ref:`XML_MultiphasePoromechanicsReservoir` +PhaseFieldDamageFEM node :ref:`XML_PhaseFieldDamageFEM` +PhaseFieldFracture node :ref:`XML_PhaseFieldFracture` +ProppantTransport node :ref:`XML_ProppantTransport` +ReactiveCompositionalMultiphaseOBL node :ref:`XML_ReactiveCompositionalMultiphaseOBL` +SeismicityRate node :ref:`XML_SeismicityRate` +SinglePhaseFVM node :ref:`XML_SinglePhaseFVM` +SinglePhaseHybridFVM node :ref:`XML_SinglePhaseHybridFVM` +SinglePhasePoromechanics node :ref:`XML_SinglePhasePoromechanics` +SinglePhasePoromechanicsConformingFractures node :ref:`XML_SinglePhasePoromechanicsConformingFractures` +SinglePhasePoromechanicsConformingFracturesReservoir node :ref:`XML_SinglePhasePoromechanicsConformingFracturesReservoir` +SinglePhasePoromechanicsEmbeddedFractures node :ref:`XML_SinglePhasePoromechanicsEmbeddedFractures` +SinglePhasePoromechanicsReservoir node :ref:`XML_SinglePhasePoromechanicsReservoir` +SinglePhaseProppantFVM node :ref:`XML_SinglePhaseProppantFVM` +SinglePhaseReservoir node :ref:`XML_SinglePhaseReservoir` +SinglePhaseReservoirPoromechanics node :ref:`XML_SinglePhaseReservoirPoromechanics` +SinglePhaseWell node :ref:`XML_SinglePhaseWell` +SolidMechanicsAugmentedLagrangianContact node :ref:`XML_SolidMechanicsAugmentedLagrangianContact` +SolidMechanicsEmbeddedFractures node :ref:`XML_SolidMechanicsEmbeddedFractures` +SolidMechanicsLagrangeContact node :ref:`XML_SolidMechanicsLagrangeContact` +SolidMechanicsLagrangianSSLE node :ref:`XML_SolidMechanicsLagrangianSSLE` +SolidMechanics_LagrangianFEM node :ref:`XML_SolidMechanics_LagrangianFEM` +SolidMechanics_MPM node :ref:`XML_SolidMechanics_MPM` +SurfaceGenerator node :ref:`XML_SurfaceGenerator` +==================================================== ======== =========== =============================================================== diff --git a/src/coreComponents/schema/docs/Solvers_other.rst b/src/coreComponents/schema/docs/Solvers_other.rst index 3eca415d7e0..6a42cd06a7c 100644 --- a/src/coreComponents/schema/docs/Solvers_other.rst +++ b/src/coreComponents/schema/docs/Solvers_other.rst @@ -1,46 +1,48 @@ -============================================= ==== ================================================================== -Name Type Description -============================================= ==== ================================================================== -AcousticElasticSEM node :ref:`DATASTRUCTURE_AcousticElasticSEM` -AcousticFirstOrderSEM node :ref:`DATASTRUCTURE_AcousticFirstOrderSEM` -AcousticSEM node :ref:`DATASTRUCTURE_AcousticSEM` -AcousticVTISEM node :ref:`DATASTRUCTURE_AcousticVTISEM` -CompositionalMultiphaseFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseFVM` -CompositionalMultiphaseHybridFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM` -CompositionalMultiphaseReservoir node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoir` -CompositionalMultiphaseReservoirPoromechanics node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoirPoromechanics` -CompositionalMultiphaseWell node :ref:`DATASTRUCTURE_CompositionalMultiphaseWell` -ElasticFirstOrderSEM node :ref:`DATASTRUCTURE_ElasticFirstOrderSEM` -ElasticSEM node :ref:`DATASTRUCTURE_ElasticSEM` -EmbeddedSurfaceGenerator node :ref:`DATASTRUCTURE_EmbeddedSurfaceGenerator` -FlowProppantTransport node :ref:`DATASTRUCTURE_FlowProppantTransport` -Hydrofracture node :ref:`DATASTRUCTURE_Hydrofracture` -LaplaceFEM node :ref:`DATASTRUCTURE_LaplaceFEM` -MultiphasePoromechanics node :ref:`DATASTRUCTURE_MultiphasePoromechanics` -MultiphasePoromechanicsReservoir node :ref:`DATASTRUCTURE_MultiphasePoromechanicsReservoir` -PhaseFieldDamageFEM node :ref:`DATASTRUCTURE_PhaseFieldDamageFEM` -PhaseFieldFracture node :ref:`DATASTRUCTURE_PhaseFieldFracture` -ProppantTransport node :ref:`DATASTRUCTURE_ProppantTransport` -ReactiveCompositionalMultiphaseOBL node :ref:`DATASTRUCTURE_ReactiveCompositionalMultiphaseOBL` -SeismicityRate node :ref:`DATASTRUCTURE_SeismicityRate` -SinglePhaseFVM node :ref:`DATASTRUCTURE_SinglePhaseFVM` -SinglePhaseHybridFVM node :ref:`DATASTRUCTURE_SinglePhaseHybridFVM` -SinglePhasePoromechanics node :ref:`DATASTRUCTURE_SinglePhasePoromechanics` -SinglePhasePoromechanicsConformingFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFractures` -SinglePhasePoromechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFractures` -SinglePhasePoromechanicsReservoir node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsReservoir` -SinglePhaseProppantFVM node :ref:`DATASTRUCTURE_SinglePhaseProppantFVM` -SinglePhaseReservoir node :ref:`DATASTRUCTURE_SinglePhaseReservoir` -SinglePhaseReservoirPoromechanics node :ref:`DATASTRUCTURE_SinglePhaseReservoirPoromechanics` -SinglePhaseWell node :ref:`DATASTRUCTURE_SinglePhaseWell` -SolidMechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SolidMechanicsEmbeddedFractures` -SolidMechanicsLagrangeContact node :ref:`DATASTRUCTURE_SolidMechanicsLagrangeContact` -SolidMechanicsLagrangianSSLE node :ref:`DATASTRUCTURE_SolidMechanicsLagrangianSSLE` -SolidMechanics_LagrangianFEM node :ref:`DATASTRUCTURE_SolidMechanics_LagrangianFEM` -SolidMechanics_MPM node :ref:`DATASTRUCTURE_SolidMechanics_MPM` -SurfaceGenerator node :ref:`DATASTRUCTURE_SurfaceGenerator` -============================================= ==== ================================================================== +==================================================== ==== ========================================================================= +Name Type Description +==================================================== ==== ========================================================================= +AcousticElasticSEM node :ref:`DATASTRUCTURE_AcousticElasticSEM` +AcousticFirstOrderSEM node :ref:`DATASTRUCTURE_AcousticFirstOrderSEM` +AcousticSEM node :ref:`DATASTRUCTURE_AcousticSEM` +AcousticVTISEM node :ref:`DATASTRUCTURE_AcousticVTISEM` +CompositionalMultiphaseFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseFVM` +CompositionalMultiphaseHybridFVM node :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM` +CompositionalMultiphaseReservoir node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoir` +CompositionalMultiphaseReservoirPoromechanics node :ref:`DATASTRUCTURE_CompositionalMultiphaseReservoirPoromechanics` +CompositionalMultiphaseWell node :ref:`DATASTRUCTURE_CompositionalMultiphaseWell` +ElasticFirstOrderSEM node :ref:`DATASTRUCTURE_ElasticFirstOrderSEM` +ElasticSEM node :ref:`DATASTRUCTURE_ElasticSEM` +EmbeddedSurfaceGenerator node :ref:`DATASTRUCTURE_EmbeddedSurfaceGenerator` +FlowProppantTransport node :ref:`DATASTRUCTURE_FlowProppantTransport` +Hydrofracture node :ref:`DATASTRUCTURE_Hydrofracture` +LaplaceFEM node :ref:`DATASTRUCTURE_LaplaceFEM` +MultiphasePoromechanics node :ref:`DATASTRUCTURE_MultiphasePoromechanics` +MultiphasePoromechanicsReservoir node :ref:`DATASTRUCTURE_MultiphasePoromechanicsReservoir` +PhaseFieldDamageFEM node :ref:`DATASTRUCTURE_PhaseFieldDamageFEM` +PhaseFieldFracture node :ref:`DATASTRUCTURE_PhaseFieldFracture` +ProppantTransport node :ref:`DATASTRUCTURE_ProppantTransport` +ReactiveCompositionalMultiphaseOBL node :ref:`DATASTRUCTURE_ReactiveCompositionalMultiphaseOBL` +SeismicityRate node :ref:`DATASTRUCTURE_SeismicityRate` +SinglePhaseFVM node :ref:`DATASTRUCTURE_SinglePhaseFVM` +SinglePhaseHybridFVM node :ref:`DATASTRUCTURE_SinglePhaseHybridFVM` +SinglePhasePoromechanics node :ref:`DATASTRUCTURE_SinglePhasePoromechanics` +SinglePhasePoromechanicsConformingFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFractures` +SinglePhasePoromechanicsConformingFracturesReservoir node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesReservoir` +SinglePhasePoromechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFractures` +SinglePhasePoromechanicsReservoir node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsReservoir` +SinglePhaseProppantFVM node :ref:`DATASTRUCTURE_SinglePhaseProppantFVM` +SinglePhaseReservoir node :ref:`DATASTRUCTURE_SinglePhaseReservoir` +SinglePhaseReservoirPoromechanics node :ref:`DATASTRUCTURE_SinglePhaseReservoirPoromechanics` +SinglePhaseWell node :ref:`DATASTRUCTURE_SinglePhaseWell` +SolidMechanicsAugmentedLagrangianContact node :ref:`DATASTRUCTURE_SolidMechanicsAugmentedLagrangianContact` +SolidMechanicsEmbeddedFractures node :ref:`DATASTRUCTURE_SolidMechanicsEmbeddedFractures` +SolidMechanicsLagrangeContact node :ref:`DATASTRUCTURE_SolidMechanicsLagrangeContact` +SolidMechanicsLagrangianSSLE node :ref:`DATASTRUCTURE_SolidMechanicsLagrangianSSLE` +SolidMechanics_LagrangianFEM node :ref:`DATASTRUCTURE_SolidMechanics_LagrangianFEM` +SolidMechanics_MPM node :ref:`DATASTRUCTURE_SolidMechanics_MPM` +SurfaceGenerator node :ref:`DATASTRUCTURE_SurfaceGenerator` +==================================================== ==== ========================================================================= diff --git a/src/coreComponents/schema/docs/SourceFlux.rst b/src/coreComponents/schema/docs/SourceFlux.rst index 79e40b56f97..9322448e819 100644 --- a/src/coreComponents/schema/docs/SourceFlux.rst +++ b/src/coreComponents/schema/docs/SourceFlux.rst @@ -1,6 +1,5 @@ -<<<<<<< HEAD ====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== Name Type Default Description ====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== @@ -30,23 +29,5 @@ objectPath groupNameRef Path to the target field scale real64 0 Scale factor for value of the boundary condition. setNames groupNameRef_array required Name of sets that boundary condition is applied to. ====================== ================== ======== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== -======= -====================== ================== ======== ======================================================================================================================================================================================================================================================================================== -Name Type Default Description -====================== ================== ======== ======================================================================================================================================================================================================================================================================================== -bcApplicationTableName groupNameRef Name of table that specifies the on/off application of the boundary condition. -beginTime real64 -1e+99 Time at which the boundary condition will start being applied. -component integer -1 Component of field (if tensor) to apply boundary condition to. -direction R1Tensor {0,0,0} Direction to apply boundary condition to. -endTime real64 1e+99 Time at which the boundary condition will stop being applied. -functionName groupNameRef Name of a function that specifies the variation of the production rate variations of this SourceFlux.Multiplied by scale. If no function is provided, a constant value of 1 is used.The producted fluid rate unit is in kg by default, or in mole if the flow solver has a useMass of 0. -initialCondition integer 0 Boundary condition is applied as an initial condition. -logLevel integer 0 Log level -name groupName required A name is required for any non-unique nodes -objectPath groupNameRef Path to the target field -scale real64 0 Multiplier of the functionName value. If no functionName is provided, this value is used directly. -setNames groupNameRef_array required Name of sets that boundary condition is applied to. -====================== ================== ======== ======================================================================================================================================================================================================================================================================================== ->>>>>>> origin/develop diff --git a/src/coreComponents/schema/docs/SourceFluxStatistics.rst b/src/coreComponents/schema/docs/SourceFluxStatistics.rst index a5ef4f42a89..4fc2c18b85f 100644 --- a/src/coreComponents/schema/docs/SourceFluxStatistics.rst +++ b/src/coreComponents/schema/docs/SourceFluxStatistics.rst @@ -1,16 +1,16 @@ -============== ================== ======== ===================================================================================================================================================================================== -Name Type Default Description -============== ================== ======== ===================================================================================================================================================================================== -flowSolverName groupNameRef required Name of the flow solver -fluxNames groupNameRef_array {*} Name(s) array of the SourceFlux(s) for which we want the statistics. Use "*" to target all SourceFlux. -logLevel integer 0 | Log level - | - Log Level 1 outputs the sum of all SourceFlux(s) produced rate & mass, - | - Log Level 2 details values for each SourceFlux, - | - Log Level 3 details values for each region. -name groupName required A name is required for any non-unique nodes -writeCSV integer 0 Write statistics into a CSV file -============== ================== ======== ===================================================================================================================================================================================== +============== ================== ======== ============================================================================================================================================================================ +Name Type Default Description +============== ================== ======== ============================================================================================================================================================================ +flowSolverName groupNameRef required Name of the flow solver +fluxNames groupNameRef_array {*} Name(s) array of the SourceFlux(s) for which we want the statistics. Use "*" to target all SourceFlux. +logLevel integer 0 | + | - Log Level 1 outputs the sum of all SourceFlux(s) produced rate & mass, + | - Log Level 2 details values for each SourceFlux, + | - Log Level 3 details values for each region. +name groupName required A name is required for any non-unique nodes +writeCSV integer 0 Write statistics into a CSV file +============== ================== ======== ============================================================================================================================================================================ diff --git a/src/coreComponents/schema/docs/Tasks.rst b/src/coreComponents/schema/docs/Tasks.rst index 4b2e9649e5a..7531175fa44 100644 --- a/src/coreComponents/schema/docs/Tasks.rst +++ b/src/coreComponents/schema/docs/Tasks.rst @@ -11,6 +11,8 @@ PVTDriver node :ref:`X PackCollection node :ref:`XML_PackCollection` ReactiveFluidDriver node :ref:`XML_ReactiveFluidDriver` RelpermDriver node :ref:`XML_RelpermDriver` +SinglePhasePoromechanicsConformingFracturesInitialization node :ref:`XML_SinglePhasePoromechanicsConformingFracturesInitialization` +SinglePhasePoromechanicsEmbeddedFracturesInitialization node :ref:`XML_SinglePhasePoromechanicsEmbeddedFracturesInitialization` SinglePhasePoromechanicsInitialization node :ref:`XML_SinglePhasePoromechanicsInitialization` SinglePhaseReservoirPoromechanicsInitialization node :ref:`XML_SinglePhaseReservoirPoromechanicsInitialization` SinglePhaseStatistics node :ref:`XML_SinglePhaseStatistics` diff --git a/src/coreComponents/schema/docs/Tasks_other.rst b/src/coreComponents/schema/docs/Tasks_other.rst index 991b7d3f475..7abafe4b3b2 100644 --- a/src/coreComponents/schema/docs/Tasks_other.rst +++ b/src/coreComponents/schema/docs/Tasks_other.rst @@ -11,6 +11,8 @@ PVTDriver node :ref:`DATASTRUC PackCollection node :ref:`DATASTRUCTURE_PackCollection` ReactiveFluidDriver node :ref:`DATASTRUCTURE_ReactiveFluidDriver` RelpermDriver node :ref:`DATASTRUCTURE_RelpermDriver` +SinglePhasePoromechanicsConformingFracturesInitialization node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesInitialization` +SinglePhasePoromechanicsEmbeddedFracturesInitialization node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFracturesInitialization` SinglePhasePoromechanicsInitialization node :ref:`DATASTRUCTURE_SinglePhasePoromechanicsInitialization` SinglePhaseReservoirPoromechanicsInitialization node :ref:`DATASTRUCTURE_SinglePhaseReservoirPoromechanicsInitialization` SinglePhaseStatistics node :ref:`DATASTRUCTURE_SinglePhaseStatistics` diff --git a/src/coreComponents/schema/docs/VTK.rst b/src/coreComponents/schema/docs/VTK.rst index 002ceb9367b..842a9c48625 100644 --- a/src/coreComponents/schema/docs/VTK.rst +++ b/src/coreComponents/schema/docs/VTK.rst @@ -14,7 +14,8 @@ parallelThreads integer 1 Number of plot file plotFileRoot string VTK Name of the root file for this output. plotLevel integer 1 Level detail plot. Only fields with lower of equal plot level will be output. writeFEMFaces integer 0 (no description available) -writeGhostCells integer 0 Should the face elements be written as 3d volumes or not. +writeFaceElementsAs3D integer 0 Should the face elements be written as 3d volumes or not. +writeGhostCells integer 0 Should the vtk files contain the ghost cells or not. =========================== ======================= ======== ======================================================================================================================================================================================== diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index 9528c8931f6..e65a8a1fcdd 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -50,12 +50,12 @@ - + - + @@ -413,6 +413,10 @@ + + + + @@ -437,6 +441,10 @@ + + + + @@ -495,6 +503,14 @@ + + + + + + + + @@ -1302,7 +1318,7 @@ logLevel >= 1 first nonlinear iteration - + @@ -1323,7 +1339,7 @@ logLevel >= 1 first nonlinear iteration - + @@ -2259,7 +2275,9 @@ logLevel == 1 - + + + @@ -2307,6 +2325,7 @@ logLevel == 1 + @@ -2318,6 +2337,7 @@ logLevel == 1 + @@ -2375,6 +2395,8 @@ logLevel >= 3 + + @@ -2430,6 +2452,10 @@ logLevel >= 3 + + + + @@ -2438,11 +2464,16 @@ logLevel >= 3 - + + + + + + @@ -2453,6 +2484,8 @@ logLevel >= 3 + + @@ -2509,6 +2542,10 @@ logLevel >= 3 + + + + @@ -2517,7 +2554,7 @@ logLevel >= 3 - + @@ -2527,6 +2564,8 @@ logLevel >= 3 + + @@ -2582,6 +2621,10 @@ logLevel >= 3 + + + + @@ -2590,7 +2633,7 @@ logLevel >= 3 - + @@ -2665,6 +2708,8 @@ logLevel >= 3 + + @@ -2695,6 +2740,8 @@ logLevel >= 3 + + @@ -2774,6 +2821,8 @@ logLevel >= 3 + + @@ -2796,6 +2845,8 @@ logLevel >= 3 + + @@ -2899,14 +2950,14 @@ logLevel >= 3 - + - + @@ -2962,12 +3013,16 @@ logLevel >= 3 + + - + + + @@ -3050,6 +3105,8 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> + + @@ -3105,6 +3162,10 @@ logLevel >= 3 + + + + @@ -3113,7 +3174,7 @@ logLevel >= 3 - + @@ -3123,6 +3184,8 @@ logLevel >= 3 + + @@ -3178,6 +3241,10 @@ logLevel >= 3 + + + + @@ -3190,7 +3257,7 @@ logLevel >= 3 - + @@ -3340,6 +3407,15 @@ logLevel >= 3 + + + + + + @@ -3445,14 +3521,14 @@ logLevel >= 3 - + - + @@ -3802,7 +3878,7 @@ logLevel >= 3 - - + + + + + + @@ -3993,8 +4078,61 @@ logLevel >= 3 + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4039,6 +4177,15 @@ logLevel >= 3 + + + + + + @@ -4101,7 +4248,7 @@ logLevel >= 3 - + + + + + + @@ -4281,7 +4437,7 @@ logLevel >= 3 - + @@ -4300,7 +4456,6 @@ logLevel >= 1 - Information on the timestep - Print residual norm - Information on number of elements for each fracture states - - Infos on residual norm for each fractures logLevel >= 1 and configuration didn't converge - Information about testing new configuration and print the time step logLevel >= 1 and incorrect solution @@ -4340,8 +4495,6 @@ logLevel >= 3 * ImplicitDynamic * ExplicitDynamic--> - - @@ -4350,6 +4503,70 @@ logLevel >= 3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4694,6 +4911,8 @@ logLevel >= 3 + + @@ -4743,7 +4962,10 @@ logLevel >= 1 and pore volume equal 0 - + @@ -4851,6 +5073,32 @@ logLevel >= 1 + + + + + + + + + + + + + + + + + + + + - diff --git a/src/coreComponents/schema/schema.xsd.other b/src/coreComponents/schema/schema.xsd.other index a0fbfc4a731..89d10b3ae4e 100644 --- a/src/coreComponents/schema/schema.xsd.other +++ b/src/coreComponents/schema/schema.xsd.other @@ -50,12 +50,12 @@ - + - + @@ -528,12 +528,14 @@ + + @@ -1074,6 +1076,19 @@ + + + + + + + + + + + + + @@ -1155,6 +1170,23 @@ + + + + + + + + + + + + + + + + + @@ -1301,6 +1333,8 @@ + + @@ -1318,6 +1352,8 @@ + + diff --git a/src/docs/sphinx/CompleteXMLSchema.rst b/src/docs/sphinx/CompleteXMLSchema.rst index d15f17166bd..4fa19cfebea 100644 --- a/src/docs/sphinx/CompleteXMLSchema.rst +++ b/src/docs/sphinx/CompleteXMLSchema.rst @@ -1095,6 +1095,20 @@ Element: SinglePhasePoromechanicsConformingFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures.rst +.. _XML_SinglePhasePoromechanicsConformingFracturesInitialization: + +Element: SinglePhasePoromechanicsConformingFracturesInitialization +================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization.rst + + +.. _XML_SinglePhasePoromechanicsConformingFracturesReservoir: + +Element: SinglePhasePoromechanicsConformingFracturesReservoir +============================================================= +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir.rst + + .. _XML_SinglePhasePoromechanicsEmbeddedFractures: Element: SinglePhasePoromechanicsEmbeddedFractures @@ -1102,6 +1116,13 @@ Element: SinglePhasePoromechanicsEmbeddedFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures.rst +.. _XML_SinglePhasePoromechanicsEmbeddedFracturesInitialization: + +Element: SinglePhasePoromechanicsEmbeddedFracturesInitialization +================================================================ +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization.rst + + .. _XML_SinglePhasePoromechanicsInitialization: Element: SinglePhasePoromechanicsInitialization @@ -1172,6 +1193,13 @@ Element: SolidInternalEnergy .. include:: ../../coreComponents/schema/docs/SolidInternalEnergy.rst +.. _XML_SolidMechanicsAugmentedLagrangianContact: + +Element: SolidMechanicsAugmentedLagrangianContact +================================================= +.. include:: ../../coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact.rst + + .. _XML_SolidMechanicsEmbeddedFractures: Element: SolidMechanicsEmbeddedFractures @@ -2562,6 +2590,20 @@ Datastructure: SinglePhasePoromechanicsConformingFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures_other.rst +.. _DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesInitialization: + +Datastructure: SinglePhasePoromechanicsConformingFracturesInitialization +======================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesInitialization_other.rst + + +.. _DATASTRUCTURE_SinglePhasePoromechanicsConformingFracturesReservoir: + +Datastructure: SinglePhasePoromechanicsConformingFracturesReservoir +=================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsConformingFracturesReservoir_other.rst + + .. _DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFractures: Datastructure: SinglePhasePoromechanicsEmbeddedFractures @@ -2569,6 +2611,13 @@ Datastructure: SinglePhasePoromechanicsEmbeddedFractures .. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures_other.rst +.. _DATASTRUCTURE_SinglePhasePoromechanicsEmbeddedFracturesInitialization: + +Datastructure: SinglePhasePoromechanicsEmbeddedFracturesInitialization +====================================================================== +.. include:: ../../coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFracturesInitialization_other.rst + + .. _DATASTRUCTURE_SinglePhasePoromechanicsInitialization: Datastructure: SinglePhasePoromechanicsInitialization @@ -2639,6 +2688,13 @@ Datastructure: SolidInternalEnergy .. include:: ../../coreComponents/schema/docs/SolidInternalEnergy_other.rst +.. _DATASTRUCTURE_SolidMechanicsAugmentedLagrangianContact: + +Datastructure: SolidMechanicsAugmentedLagrangianContact +======================================================= +.. include:: ../../coreComponents/schema/docs/SolidMechanicsAugmentedLagrangianContact_other.rst + + .. _DATASTRUCTURE_SolidMechanicsEmbeddedFractures: Datastructure: SolidMechanicsEmbeddedFractures