From ce219dc5e64ecb7d6dacd09accf0a0816f0f24f4 Mon Sep 17 00:00:00 2001 From: frankfeifan Date: Tue, 19 Mar 2024 21:29:55 -0700 Subject: [PATCH] Initialization of fields in new fracture cells in HydroFracture solver (#2960) --- integratedTests | 2 +- .../finiteVolume/FluxApproximationBase.hpp | 4 +- .../finiteVolume/SurfaceElementStencil.hpp | 19 -- .../TwoPointFluxApproximation.cpp | 244 +----------------- .../TwoPointFluxApproximation.hpp | 3 +- .../fluidFlow/SinglePhaseBaseKernels.hpp | 12 +- .../ThermalSinglePhaseBaseKernels.hpp | 17 +- .../multiphysics/HydrofractureSolver.cpp | 185 ++++++++++++- .../multiphysics/HydrofractureSolver.hpp | 22 ++ .../surfaceGeneration/SurfaceGenerator.cpp | 6 +- .../schema/docs/AcousticElasticSEM_other.rst | 18 +- .../docs/AcousticFirstOrderSEM_other.rst | 58 ++--- .../schema/docs/AcousticSEM_other.rst | 48 ++-- .../schema/docs/AcousticVTISEM_other.rst | 48 ++-- .../schema/docs/BlackOilFluid_other.rst | 64 ++--- .../docs/CO2BrineEzrokhiFluid_other.rst | 52 ++-- .../CO2BrineEzrokhiThermalFluid_other.rst | 52 ++-- .../docs/CO2BrinePhillipsFluid_other.rst | 52 ++-- .../CO2BrinePhillipsThermalFluid_other.rst | 52 ++-- .../schema/docs/CellElementRegion_other.rst | 24 +- .../docs/CompositionalMultiphaseFVM_other.rst | 18 +- .../CompositionalMultiphaseFluid_other.rst | 52 ++-- ...CompositionalMultiphaseHybridFVM_other.rst | 22 +- ...MultiphaseReservoirPoromechanics_other.rst | 22 +- ...CompositionalMultiphaseReservoir_other.rst | 20 +- .../CompositionalMultiphaseWell_other.rst | 22 +- ...sitonalTwoPhaseFluidPengRobinson_other.rst | 52 ++-- ...alTwoPhaseFluidSoaveRedlichKwong_other.rst | 52 ++-- .../schema/docs/DeadOilFluid_other.rst | 62 ++--- .../docs/ElasticFirstOrderSEM_other.rst | 68 ++--- .../schema/docs/ElasticSEM_other.rst | 54 ++-- .../schema/docs/ElementRegions_other.rst | 30 +-- .../docs/EmbeddedSurfaceGenerator_other.rst | 20 +- .../docs/FlowProppantTransport_other.rst | 20 +- .../schema/docs/Hydrofracture.rst | 39 +-- .../schema/docs/Hydrofracture_other.rst | 22 +- .../docs/JFunctionCapillaryPressure_other.rst | 20 +- .../schema/docs/LaplaceFEM_other.rst | 18 +- ...MultiphasePoromechanicsReservoir_other.rst | 20 +- .../docs/MultiphasePoromechanics_other.rst | 22 +- .../schema/docs/ParticleRegion_other.rst | 24 +- .../schema/docs/ParticleRegions_other.rst | 26 +- .../schema/docs/PhaseFieldDamageFEM_other.rst | 18 +- .../schema/docs/PhaseFieldFracture_other.rst | 20 +- .../schema/docs/ProppantTransport_other.rst | 18 +- .../docs/ReactiveBrineThermal_other.rst | 60 ++--- .../schema/docs/ReactiveBrine_other.rst | 60 ++--- ...activeCompositionalMultiphaseOBL_other.rst | 18 +- .../schema/docs/SinglePhaseFVM_other.rst | 18 +- .../docs/SinglePhaseHybridFVM_other.rst | 20 +- ...PoromechanicsConformingFractures_other.rst | 22 +- ...sePoromechanicsEmbeddedFractures_other.rst | 22 +- ...inglePhasePoromechanicsReservoir_other.rst | 20 +- .../docs/SinglePhasePoromechanics_other.rst | 22 +- .../docs/SinglePhaseProppantFVM_other.rst | 18 +- ...inglePhaseReservoirPoromechanics_other.rst | 22 +- .../docs/SinglePhaseReservoir_other.rst | 20 +- .../schema/docs/SinglePhaseWell_other.rst | 22 +- .../SolidMechanicsEmbeddedFractures_other.rst | 24 +- .../SolidMechanicsLagrangeContact_other.rst | 24 +- .../SolidMechanicsLagrangianSSLE_other.rst | 20 +- .../SolidMechanics_LagrangianFEM_other.rst | 20 +- .../schema/docs/SolidMechanics_MPM_other.rst | 60 ++--- .../docs/SurfaceElementRegion_other.rst | 24 +- .../schema/docs/SurfaceGenerator_other.rst | 30 +-- .../docs/TableCapillaryPressure_other.rst | 18 +- ...leRelativePermeabilityHysteresis_other.rst | 46 ++-- .../docs/TableRelativePermeability_other.rst | 26 +- .../docs/TwoPointFluxApproximation_other.rst | 22 +- ...WellElementRegionUniqueSubRegion_other.rst | 50 ++-- .../schema/docs/WellElementRegion_other.rst | 28 +- .../schema/docs/domain_other.rst | 16 +- .../schema/docs/edgeManager_other.rst | 26 +- .../embeddedSurfacesEdgeManager_other.rst | 26 +- .../embeddedSurfacesNodeManager_other.rst | 36 +-- .../schema/docs/faceManager_other.rst | 42 +-- .../schema/docs/nodeManager_other.rst | 36 +-- src/coreComponents/schema/docs/sets_other.rst | 10 +- .../docs/wellElementSubRegion_other.rst | 38 +-- src/coreComponents/schema/schema.xsd | 7 + src/coreComponents/schema/schema.xsd.other | 186 ++++++------- src/coreComponents/schema/schemaUtilities.cpp | 12 +- 82 files changed, 1423 insertions(+), 1491 deletions(-) diff --git a/integratedTests b/integratedTests index b50e624e7d9..9821b209d73 160000 --- a/integratedTests +++ b/integratedTests @@ -1 +1 @@ -Subproject commit b50e624e7d905faa2e4078e53162e159b75ebe6a +Subproject commit 9821b209d730ef24e5231e66e33c9cdc57459dad diff --git a/src/coreComponents/finiteVolume/FluxApproximationBase.hpp b/src/coreComponents/finiteVolume/FluxApproximationBase.hpp index 0f509669063..3830cf52cc1 100644 --- a/src/coreComponents/finiteVolume/FluxApproximationBase.hpp +++ b/src/coreComponents/finiteVolume/FluxApproximationBase.hpp @@ -132,11 +132,9 @@ class FluxApproximationBase : public dataRepository::Group * @brief Add a new fracture stencil. * @param[in,out] mesh the mesh on which to add the fracture stencil * @param[in] faceElementRegionName the face element region name - * @param[in] initFields if true initialize physical fields, like pressure */ virtual void addToFractureStencil( MeshLevel & mesh, - string const & faceElementRegionName, - bool const initFields ) const = 0; + string const & faceElementRegionName ) const = 0; /** * @brief Add a new embedded fracture stencil. diff --git a/src/coreComponents/finiteVolume/SurfaceElementStencil.hpp b/src/coreComponents/finiteVolume/SurfaceElementStencil.hpp index 62f07d7dc51..714ac59115d 100644 --- a/src/coreComponents/finiteVolume/SurfaceElementStencil.hpp +++ b/src/coreComponents/finiteVolume/SurfaceElementStencil.hpp @@ -24,25 +24,6 @@ namespace geos { -/// @cond DO_NOT_DOCUMENT -// TODO remove! This option allows for the creation of new mass inside a newly -// created FaceElement. The new mass will be equal to: -// creationMass = defaultDensity * defaultAperture * faceArea. -// If 0, then the beginning of step density is artificially set to zero...which -// may cause some newton convergence problems. -#define ALLOW_CREATION_MASS 1 - - -// TODO remove! This option sets the pressure in a newly created FaceElement to -// be the lowest value of all attached non-new FaceElements. -#define SET_CREATION_PRESSURE 1 - -// TODO remove! This option sets the nodal displacements attached a newly -// created FaceElement to some scalar fraction of the aperture of the -// lowest attached non-new FaceElements. -#define SET_CREATION_DISPLACEMENT 0 -/// @endcond - /** * @brief Describes properties of SurfaceElementStencil. * diff --git a/src/coreComponents/finiteVolume/TwoPointFluxApproximation.cpp b/src/coreComponents/finiteVolume/TwoPointFluxApproximation.cpp index 8e96749683a..d4d2ce4c3cf 100644 --- a/src/coreComponents/finiteVolume/TwoPointFluxApproximation.cpp +++ b/src/coreComponents/finiteVolume/TwoPointFluxApproximation.cpp @@ -282,11 +282,6 @@ void TwoPointFluxApproximation::addFractureFractureConnectionsDFM( MeshLevel & m hydraulicAperture, fractureRegionIndex, elemGhostRank, -#if SET_CREATION_DISPLACEMENT==1 - faceToNodesMap, - totalDisplacement, - aperture, -#endif &fractureStencil] ( localIndex const k ) { @@ -365,237 +360,6 @@ void TwoPointFluxApproximation::addFractureFractureConnectionsDFM( MeshLevel & m } ); } -void TwoPointFluxApproximation::initNewFractureFieldsDFM( MeshLevel & mesh, - string const & faceElementRegionName ) const -{ - // TODO Note that all of this initialization should be performed elsewhere. - // This is just here because it was convenient, but it is not appropriate - // to have physics based initialization in the flux approximator. - -#if !defined(SET_CREATION_DISPLACEMENT) - static_assert( true, "must have SET_CREATION_DISPLACEMENT defined" ); -#endif - -#if !defined(ALLOW_CREATION_MASS) - static_assert( true, "must have ALLOW_CREATION_MASS defined" ); -#endif - -#if !defined(SET_CREATION_PRESSURE) - static_assert( true, "must have SET_CREATION_PRESSURE defined" ); -#endif - - ElementRegionManager & elemManager = mesh.getElemManager(); - ElementRegionManager::ElementViewAccessor< arrayView1d< integer const > > const elemGhostRank = - elemManager.constructArrayViewAccessor< integer, 1 >( ObjectManagerBase::viewKeyStruct::ghostRankString() ); - - SurfaceElementRegion & fractureRegion = elemManager.getRegion< SurfaceElementRegion >( faceElementRegionName ); - localIndex const fractureRegionIndex = fractureRegion.getIndexInParent(); - FaceElementSubRegion & fractureSubRegion = fractureRegion.getUniqueSubRegion< FaceElementSubRegion >(); - ArrayOfArraysView< localIndex const > const & fractureConnectorsToFaceElements = fractureSubRegion.m_2dFaceTo2dElems.toViewConst(); -#if SET_CREATION_DISPLACEMENT==1 - NodeManager & nodeManager = mesh.getNodeManager(); - FaceManager const & faceManager = mesh.getFaceManager(); - ArrayOfArraysView< localIndex const > const & faceToNodesMap = faceManager.nodeList(); - FaceElementSubRegion::FaceMapType const & faceMap = fractureSubRegion.faceList(); - array2dLayoutIncrDisplacementConst const incrementalDisplacement = - nodeManager.getField< fields::solidMechanics::incrementalDisplacement >(); - array2dLayoutTotalDisplacementConst const totalDisplacement = - nodeManager.getField< fields::solidMechanics::totalDisplacement >(); - arrayView1d< real64 > const aperture = fractureSubRegion.getReference< array1d< real64 > >( "elementAperture" ); -#endif - -#ifdef GEOSX_USE_SEPARATION_COEFFICIENT - arrayView1d< real64 > const apertureF = fractureSubRegion.getReference< array1d< real64 > >( "apertureAtFailure" ); -#endif - -#if ALLOW_CREATION_MASS==0 - arrayView1d< real64 > const dens = fractureSubRegion.getReference< array1d< real64 > >( "density_n" ); -#endif - -#if SET_CREATION_PRESSURE==1 - arrayView1d< real64 > const fluidPressure_n = fractureSubRegion.getField< fields::flow::pressure_n >(); - arrayView1d< real64 > const fluidPressure = fractureSubRegion.getField< fields::flow::pressure >(); - // Set the new face elements to some unphysical numbers to make sure they get set by the following routines. - SortedArrayView< localIndex const > const newFaceElements = fractureSubRegion.m_newFaceElements.toViewConst(); - - forAll< serialPolicy >( fractureSubRegion.m_newFaceElements.size(), [=]( localIndex const k ) - { - localIndex const kfe = newFaceElements[k]; - fluidPressure[kfe] = 1.0e99; -#ifdef GEOSX_USE_SEPARATION_COEFFICIENT - apertureF[kfe] = aperture[kfe]; -#endif -#if SET_CREATION_DISPLACEMENT==1 - aperture[kfe] = 1.0e99; -#endif - } ); - -#endif // SET_CREATION_PRESSURE - - SortedArray< localIndex > allNewElems; - allNewElems.insert( fractureSubRegion.m_newFaceElements.begin(), - fractureSubRegion.m_newFaceElements.end() ); - SortedArrayView< localIndex const > const recalculateFractureConnectorEdges = fractureSubRegion.m_recalculateConnectionsFor2dFaces.toViewConst(); - - // add new connectors/connections between face elements to the fracture stencil - forAll< serialPolicy >( recalculateFractureConnectorEdges.size(), - [ &allNewElems, - recalculateFractureConnectorEdges, - fractureConnectorsToFaceElements, - fractureRegionIndex, - elemGhostRank, - fluidPressure, - fluidPressure_n, -#if SET_CREATION_DISPLACEMENT==1 - faceToNodesMap, - totalDisplacement, - aperture, -#endif - &fractureSubRegion - ] - ( localIndex const k ) - { - localIndex const fci = recalculateFractureConnectorEdges[k]; - localIndex const numElems = fractureConnectorsToFaceElements.sizeOfArray( fci ); -#if SET_CREATION_PRESSURE==1 - real64 initialPressure = 1.0e99; -#endif -#if SET_CREATION_DISPLACEMENT==1 - real64 initialAperture = 1.0e99; -#endif - SortedArray< localIndex > newElems; - bool containsLocalElement = false; - - // loop over all face elements attached to the connector and add them to the stencil - for( localIndex kfe=0; kfe( totalDisplacement[node0] ) ) > 1.0e-99 && - LvArray::math::abs( LvArray::tensorOps::l2Norm< 3 >( totalDisplacement[node1] ) ) > 1.0e-99 ) - { - zeroDisp = false; - } - } - if( zeroDisp ) - { - aperture[newElemIndex] = 0; - } -#endif - } - } ); - - SortedArray< localIndex > touchedNodes; - forAll< serialPolicy >( allNewElems.size(), - [ &allNewElems - , fluidPressure - , fluidPressure_n -#if SET_CREATION_DISPLACEMENT==1 - , aperture - , faceMap - , faceNormal - , faceToNodesMap - , &touchedNodes - , incrementalDisplacement - , totalDisplacement - , this -#endif - ]( localIndex const k ) - { - localIndex const newElemIndex = allNewElems[k]; - // if the value of pressure was not set, then set it to zero and punt. - if( fluidPressure[newElemIndex] > 1.0e98 ) - { - fluidPressure[newElemIndex] = 0.0; - } - fluidPressure_n[newElemIndex] = fluidPressure[newElemIndex]; -#if ALLOW_CREATION_MASS==0 - // set the initial density of the face element to 0 to enforce mass conservation ( i.e. no creation of mass) - dens[newElemIndex] = 0.0; -#endif -#if SET_CREATION_DISPLACEMENT==1 - // If the aperture has been set, then we can set the estimate of displacements. - if( aperture[newElemIndex] < 1e98 ) - { - localIndex const faceIndex0 = faceMap( newElemIndex, 0 ); - localIndex const faceIndex1 = faceMap( newElemIndex, 1 ); - - real64 newDisp[3] = LVARRAY_TENSOROPS_INIT_LOCAL_3( faceNormal[ faceIndex0 ] ); - LvArray::tensorOps::scale< 3 >( newDisp, -aperture[newElemIndex] ); - localIndex const numNodesPerFace = faceToNodesMap.sizeOfArray( faceIndex0 ); - for( localIndex a=0; a( incrementalDisplacement[node0], newDisp ); - LvArray::tensorOps::add< 3 >( totalDisplacement[node0], newDisp ); - LvArray::tensorOps::subtract< 3 >( incrementalDisplacement[node1], newDisp ); - LvArray::tensorOps::subtract< 3 >( totalDisplacement[node1], newDisp ); - } - } - } - if( this->getLogLevel() > 1 ) - { - printf( "New elem index, init aper, init press = %4ld, %4.2e, %4.2e \n", - newElemIndex, - aperture[newElemIndex], - fluidPressure[newElemIndex] ); - } -#endif - } ); -} - void TwoPointFluxApproximation::cleanMatrixMatrixConnectionsDFM( MeshLevel & mesh, string const & faceElementRegionName ) const { @@ -761,17 +525,11 @@ void TwoPointFluxApproximation::addFractureMatrixConnectionsDFM( MeshLevel & mes } void TwoPointFluxApproximation::addToFractureStencil( MeshLevel & mesh, - string const & faceElementRegionName, - bool const initFields ) const + string const & faceElementRegionName ) const { this->addFractureFractureConnectionsDFM( mesh, faceElementRegionName ); this->cleanMatrixMatrixConnectionsDFM( mesh, faceElementRegionName ); this->addFractureMatrixConnectionsDFM( mesh, faceElementRegionName ); - - if( initFields ) - { - this->initNewFractureFieldsDFM( mesh, faceElementRegionName ); - } } void TwoPointFluxApproximation::addFractureMatrixConnectionsEDFM( MeshLevel & mesh, diff --git a/src/coreComponents/finiteVolume/TwoPointFluxApproximation.hpp b/src/coreComponents/finiteVolume/TwoPointFluxApproximation.hpp index 8820dd4a388..1cbd8453763 100644 --- a/src/coreComponents/finiteVolume/TwoPointFluxApproximation.hpp +++ b/src/coreComponents/finiteVolume/TwoPointFluxApproximation.hpp @@ -73,8 +73,7 @@ class TwoPointFluxApproximation : public FluxApproximationBase virtual void registerFractureStencil( Group & stencilGroup ) const override; virtual void addToFractureStencil( MeshLevel & mesh, - string const & faceElementRegionName, - bool const initFields ) const override; + string const & faceElementRegionName ) const override; virtual void registerBoundaryStencil( Group & stencilGroup, string const & setName ) const override; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBaseKernels.hpp b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBaseKernels.hpp index 1a53a221166..8a101bea087 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBaseKernels.hpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseBaseKernels.hpp @@ -359,14 +359,8 @@ class SurfaceElementBasedAssemblyKernel : public ElementBasedAssemblyKernel< Sur CRSMatrixView< real64, globalIndex const > const & localMatrix, arrayView1d< real64 > const & localRhs ) : Base( rankOffset, dofKey, subRegion, fluid, solid, localMatrix, localRhs ) -#if ALLOW_CREATION_MASS , m_creationMass( subRegion.getReference< array1d< real64 > >( SurfaceElementSubRegion::viewKeyStruct::creationMassString() ) ) -#endif - { -#if !defined(ALLOW_CREATION_MASS) - static_assert( true, "must have ALLOW_CREATION_MASS defined" ); -#endif - } + {} /** * @brief Compute the local accumulation contributions to the residual and Jacobian @@ -380,20 +374,16 @@ class SurfaceElementBasedAssemblyKernel : public ElementBasedAssemblyKernel< Sur { Base::computeAccumulation( ei, stack, [&] () { -#if ALLOW_CREATION_MASS if( Base::m_volume[ei] * Base::m_density_n[ei][0] > 1.1 * m_creationMass[ei] ) { stack.localResidual[0] += m_creationMass[ei] * 0.25; } -#endif } ); } protected: -#if ALLOW_CREATION_MASS arrayView1d< real64 const > const m_creationMass; -#endif }; diff --git a/src/coreComponents/physicsSolvers/fluidFlow/ThermalSinglePhaseBaseKernels.hpp b/src/coreComponents/physicsSolvers/fluidFlow/ThermalSinglePhaseBaseKernels.hpp index 8db24520903..12047977050 100644 --- a/src/coreComponents/physicsSolvers/fluidFlow/ThermalSinglePhaseBaseKernels.hpp +++ b/src/coreComponents/physicsSolvers/fluidFlow/ThermalSinglePhaseBaseKernels.hpp @@ -337,15 +337,9 @@ class SurfaceElementBasedAssemblyKernel : public ElementBasedAssemblyKernel< Sur constitutive::CoupledSolidBase const & solid, CRSMatrixView< real64, globalIndex const > const & localMatrix, arrayView1d< real64 > const & localRhs ) - : Base( rankOffset, dofKey, subRegion, fluid, solid, localMatrix, localRhs ) -#if ALLOW_CREATION_MASS - , m_creationMass( subRegion.getReference< array1d< real64 > >( SurfaceElementSubRegion::viewKeyStruct::creationMassString() ) ) -#endif - { -#if !defined(ALLOW_CREATION_MASS) - static_assert( true, "must have ALLOW_CREATION_MASS defined" ); -#endif - } + : Base( rankOffset, dofKey, subRegion, fluid, solid, localMatrix, localRhs ), + m_creationMass( subRegion.getReference< array1d< real64 > >( SurfaceElementSubRegion::viewKeyStruct::creationMassString() ) ) + {} /** * @brief Compute the local accumulation contributions to the residual and Jacobian @@ -358,20 +352,15 @@ class SurfaceElementBasedAssemblyKernel : public ElementBasedAssemblyKernel< Sur Base::StackVariables & stack ) const { Base::computeAccumulation( ei, stack ); - -#if ALLOW_CREATION_MASS if( Base::m_volume[ei] * Base::m_density_n[ei][0] > 1.1 * m_creationMass[ei] ) { stack.localResidual[0] += m_creationMass[ei] * 0.25; } -#endif } protected: -#if ALLOW_CREATION_MASS arrayView1d< real64 const > const m_creationMass; -#endif }; diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp index 46d83cd528c..858d9c55585 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.cpp @@ -75,7 +75,8 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & m_surfaceGeneratorName(), m_surfaceGenerator( nullptr ), m_maxNumResolves( 10 ), - m_isMatrixPoroelastic() + m_isMatrixPoroelastic(), + m_newFractureInitializationType() { registerWrapper( viewKeyStruct::surfaceGeneratorNameString(), &m_surfaceGeneratorName ). setRTTypeName( rtTypes::CustomTypes::groupNameRef ). @@ -96,6 +97,12 @@ HydrofractureSolver< POROMECHANICS_SOLVER >::HydrofractureSolver( const string & setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); + /// GEOS mainly initializes pressure in the new fracture elements. + registerWrapper( viewKeyStruct::newFractureInitializationTypeString(), &m_newFractureInitializationType ). + setInputFlag( InputFlags::OPTIONAL ). + setApplyDefaultValue( InitializationType::Pressure ). + setDescription( "Type of new fracture element initialization. Can be Pressure or Displacement. " ); + registerWrapper( viewKeyStruct::useQuasiNewtonString(), &m_useQuasiNewton ). setApplyDefaultValue( 0 ). setInputFlag( InputFlags::OPTIONAL ); @@ -176,6 +183,9 @@ void HydrofractureSolver< POROMECHANICS_SOLVER >::postProcessInput() static const std::set< integer > binaryOptions = { 0, 1 }; GEOS_ERROR_IF( binaryOptions.count( m_isMatrixPoroelastic ) == 0, viewKeyStruct::isMatrixPoroelasticString() << " option can be either 0 (false) or 1 (true)" ); + GEOS_ERROR_IF( m_newFractureInitializationType != InitializationType::Pressure && m_newFractureInitializationType != InitializationType::Displacement, + viewKeyStruct::newFractureInitializationTypeString() << " option can be either Pressure or Displacement" ); + m_surfaceGenerator = &this->getParent().template getGroup< SurfaceGenerator >( m_surfaceGeneratorName ); flowSolver()->allowNegativePressure(); @@ -189,6 +199,11 @@ real64 HydrofractureSolver< POROMECHANICS_SOLVER >::fullyCoupledSolverStep( real int const cycleNumber, DomainPartition & domain ) { + if( cycleNumber == 0 && time_n <= 0 ) + { + initializeNewFractureFields( domain ); + } + real64 dtReturn = dt; implicitStepSetup( time_n, dt, domain ); @@ -236,6 +251,9 @@ real64 HydrofractureSolver< POROMECHANICS_SOLVER >::fullyCoupledSolverStep( real } else { + // We initialize the fields for new fracture cells + initializeNewFractureFields( domain ); + FieldIdentifiers fieldsToBeSync; fieldsToBeSync.addElementFields( { flow::pressure::key(), @@ -971,6 +989,171 @@ void HydrofractureSolver< POROMECHANICS_SOLVER >::setUpDflux_dApertureMatrix( Do } ); } +template< typename POROMECHANICS_SOLVER > +void HydrofractureSolver< POROMECHANICS_SOLVER >::initializeNewFractureFields( DomainPartition & domain ) +{ + forDiscretizationOnMeshTargets( domain.getMeshBodies(), [&] ( string const &, + MeshLevel & meshLevel, + arrayView1d< string const > const & regionNames ) + { + ElementRegionManager & elemManager = meshLevel.getElemManager(); + NodeManager & nodeManager = meshLevel.getNodeManager(); + FaceManager const & faceManager = meshLevel.getFaceManager(); + ArrayOfArraysView< localIndex const > const faceToNodesMap = faceManager.nodeList().toViewConst(); + arrayView2d< real64 const > faceNormal = faceManager.faceNormal(); + + solidMechanics::arrayView2dLayoutIncrDisplacement const incrementalDisplacement = + nodeManager.getField< fields::solidMechanics::incrementalDisplacement >(); + solidMechanics::arrayView2dLayoutTotalDisplacement const totalDisplacement = + nodeManager.getField< fields::solidMechanics::totalDisplacement >(); + + elemManager.forElementSubRegions< FaceElementSubRegion >( regionNames, + [=]( localIndex const, + FaceElementSubRegion & subRegion ) + { + ArrayOfArraysView< localIndex const > const facesToEdges = subRegion.edgeList().toViewConst(); + ArrayOfArraysView< localIndex const > const & fractureConnectorsToFaceElements = subRegion.m_2dFaceTo2dElems.toViewConst(); + map< localIndex, localIndex > const & edgesToConnectorEdges = subRegion.m_edgesTo2dFaces; + + ArrayOfArraysView< localIndex const > const faceMap = subRegion.faceList().toViewConst(); + + arrayView1d< real64 > const fluidPressure_n = subRegion.getField< fields::flow::pressure_n >(); + arrayView1d< real64 > const fluidPressure = subRegion.getField< fields::flow::pressure >(); + + arrayView1d< real64 > const aperture = subRegion.getReference< array1d< real64 > >( "elementAperture" ); + + // Get the list of newFractureElements + SortedArrayView< localIndex const > const newFractureElements = subRegion.m_newFaceElements.toViewConst(); + + #ifdef GEOSX_USE_SEPARATION_COEFFICIENT + arrayView1d< real64 > const apertureF = subRegion.getReference< array1d< real64 > >( "apertureAtFailure" ); + #endif + + // arrayView1d< real64 > const dens = subRegion.getReference< array1d< real64 > >( "density_n" ); // change it to make aperture + // zero + + forAll< serialPolicy >( newFractureElements.size(), [&] ( localIndex const k ) + { + localIndex const newElemIndex = newFractureElements[k]; + real64 initialPressure = 1.0e99; + real64 initialAperture = 1.0e99; + #ifdef GEOSX_USE_SEPARATION_COEFFICIENT + apertureF[newElemIndex] = aperture[newElemIndex]; + #endif + if( m_newFractureInitializationType == InitializationType::Displacement ) + { + aperture[newElemIndex] = 1.0e99; + } + arraySlice1d< localIndex const > const faceToEdges = facesToEdges[newElemIndex]; + + for( localIndex ke=0; ke 1.0e98? 0.0:initialPressure; + fluidPressure_n[newElemIndex] = fluidPressure[newElemIndex]; + } + else if( m_newFractureInitializationType == InitializationType::Displacement ) + { + // Set the aperture/fluid pressure for the new face element to be the minimum + // of the existing value, smallest aperture/pressure from a connected face element. + // aperture[newElemIndex] = std::min(aperture[newElemIndex], initialAperture); + + localIndex const faceIndex0 = faceMap[newElemIndex][0]; + localIndex const faceIndex1 = faceMap[newElemIndex][1]; + + localIndex const numNodesPerFace = faceToNodesMap.sizeOfArray( faceIndex0 ); + + bool zeroDisp = true; + + for( localIndex a=0; a( totalDisplacement[node0] ) ) > 1.0e-99 && + LvArray::math::abs( LvArray::tensorOps::l2Norm< 3 >( totalDisplacement[node1] ) ) > 1.0e-99 ) + { + zeroDisp = false; + } + } + if( zeroDisp ) + { + aperture[newElemIndex] = 0; + } + } + GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( "New elem index = {:4d} , init aper = {:4.2e}, init press = {:4.2e} ", + newElemIndex, aperture[newElemIndex], fluidPressure[newElemIndex] ) ); + } ); + + if( m_newFractureInitializationType == InitializationType::Displacement ) + { + SortedArray< localIndex > touchedNodes; + forAll< serialPolicy >( newFractureElements.size(), [ newFractureElements + , aperture + , faceMap + , faceNormal + , faceToNodesMap + , &touchedNodes + , incrementalDisplacement + , totalDisplacement ]( localIndex const k ) + { + localIndex const newElemIndex = newFractureElements[k]; + + if( aperture[newElemIndex] < 1e98 ) + { + localIndex const faceIndex0 = faceMap( newElemIndex, 0 ); + localIndex const faceIndex1 = faceMap( newElemIndex, 1 ); + localIndex const numNodesPerFace = faceToNodesMap.sizeOfArray( faceIndex0 ); + + real64 newDisp[3] = LVARRAY_TENSOROPS_INIT_LOCAL_3( faceNormal[ faceIndex0 ] ); + LvArray::tensorOps::scale< 3 >( newDisp, -aperture[newElemIndex] ); + for( localIndex a=0; a( incrementalDisplacement[node0], newDisp ); + LvArray::tensorOps::add< 3 >( totalDisplacement[node0], newDisp ); + LvArray::tensorOps::subtract< 3 >( incrementalDisplacement[node1], newDisp ); + LvArray::tensorOps::subtract< 3 >( totalDisplacement[node1], newDisp ); + } + } + } + } ); + } + + subRegion.m_recalculateConnectionsFor2dFaces.clear(); + subRegion.m_newFaceElements.clear(); + } ); + } ); +} + namespace { typedef HydrofractureSolver< SinglePhasePoromechanics< SinglePhaseBase > > SinglePhaseHydrofracture; diff --git a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.hpp b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.hpp index 9ee4adcdd04..152169f57c9 100644 --- a/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.hpp +++ b/src/coreComponents/physicsSolvers/multiphysics/HydrofractureSolver.hpp @@ -138,6 +138,12 @@ class HydrofractureSolver : public POROMECHANICS_SOLVER return m_derivativeFluxResidual_dAperture->toViewConst(); } + enum class InitializationType : integer + { + Pressure, + Displacement, + }; + struct viewKeyStruct : Base::viewKeyStruct { constexpr static char const * contactRelationNameString() { return "contactRelationName"; } @@ -148,6 +154,8 @@ class HydrofractureSolver : public POROMECHANICS_SOLVER constexpr static char const * isMatrixPoroelasticString() { return "isMatrixPoroelastic"; } + constexpr static char const * newFractureInitializationTypeString() { return "newFractureInitializationType"; } + constexpr static char const * useQuasiNewtonString() { return "useQuasiNewton"; } #ifdef GEOSX_USE_SEPARATION_COEFFICIENT @@ -194,6 +202,13 @@ class HydrofractureSolver : public POROMECHANICS_SOLVER int const cycleNumber, DomainPartition & domain ) override final; + + /** + * @brief Initialize fields on the newly created elements of the fracture. + * @param domain the physical domain object + */ + void initializeNewFractureFields( DomainPartition & domain ); + // name of the contact relation string m_contactRelationName; @@ -211,10 +226,17 @@ class HydrofractureSolver : public POROMECHANICS_SOLVER integer m_isMatrixPoroelastic; + // flag to determine which initialization type to use for the new fracture cell + InitializationType m_newFractureInitializationType; + integer m_useQuasiNewton; // use Quasi-Newton (see https://arxiv.org/abs/2111.00264) }; +ENUM_STRINGS( HydrofractureSolver< SinglePhasePoromechanics< SinglePhaseBase > >::InitializationType, + "Pressure", + "Displacement" ); + } /* namespace geos */ diff --git a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp index 42e8639eab7..cae283b4241 100644 --- a/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp +++ b/src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp @@ -453,7 +453,7 @@ void SurfaceGenerator::postRestartInitialization() FluxApproximationBase * const fluxApprox = fvManager.getGroupPointer< FluxApproximationBase >( a ); if( fluxApprox!=nullptr ) { - fluxApprox->addToFractureStencil( meshLevel, this->m_fractureRegionName, false ); + fluxApprox->addToFractureStencil( meshLevel, this->m_fractureRegionName ); } } @@ -508,13 +508,11 @@ real64 SurfaceGenerator::solverStep( real64 const & time_n, FluxApproximationBase * const fluxApprox = fvManager.getGroupPointer< FluxApproximationBase >( a ); if( fluxApprox!=nullptr ) { - fluxApprox->addToFractureStencil( meshLevel, this->m_fractureRegionName, true ); + fluxApprox->addToFractureStencil( meshLevel, this->m_fractureRegionName ); } } FaceElementSubRegion & fractureSubRegion = fractureRegion.getUniqueSubRegion< FaceElementSubRegion >(); - fractureSubRegion.m_recalculateConnectionsFor2dFaces.clear(); - fractureSubRegion.m_newFaceElements.clear(); // Recreate geometric sets meshLevel.getNodeManager().buildGeometricSets( GeometricObjectManager::getInstance() ); diff --git a/src/coreComponents/schema/docs/AcousticElasticSEM_other.rst b/src/coreComponents/schema/docs/AcousticElasticSEM_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/AcousticElasticSEM_other.rst +++ b/src/coreComponents/schema/docs/AcousticElasticSEM_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/AcousticFirstOrderSEM_other.rst b/src/coreComponents/schema/docs/AcousticFirstOrderSEM_other.rst index 955f1c1ca6d..44522b87d49 100644 --- a/src/coreComponents/schema/docs/AcousticFirstOrderSEM_other.rst +++ b/src/coreComponents/schema/docs/AcousticFirstOrderSEM_other.rst @@ -1,33 +1,33 @@ -========================= ============================================================================================================================================================== ======================================================================= -Name Type Description -========================= ============================================================================================================================================================== ======================================================================= -indexSeismoTrace integer Count for output pressure at receivers -linearDASVectorX real32_array X component of the linear DAS direction vector -linearDASVectorY real32_array Y component of the linear DAS direction vector -linearDASVectorZ real32_array Z component of the linear DAS direction vector -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -pressureNp1AtReceivers real32_array2d Pressure value at each receiver for each timestep -rcvElem integer_array Element containing the receivers -receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds -receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank -receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point -receiverRegion integer_array Region containing the receivers -sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds -sourceElem integer_array Element containing the sources -sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank -sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point -sourceRegion integer_array Region containing the sources -sourceValue real32_array2d Source Value of the sources -usePML integer Flag to apply PML -uxNp1AtReceivers real32_array2d Ux value at each receiver for each timestep -uyNp1AtReceivers real32_array2d Uy value at each receiver for each timestep -uzNp1AtReceivers real32_array2d Uz value at each receiver for each timestep -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ======================================================================= +========================= ====================================================================================================================================================== ======================================================================= +Name Type Description +========================= ====================================================================================================================================================== ======================================================================= +indexSeismoTrace integer Count for output pressure at receivers +linearDASVectorX real32_array X component of the linear DAS direction vector +linearDASVectorY real32_array Y component of the linear DAS direction vector +linearDASVectorZ real32_array Z component of the linear DAS direction vector +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. +pressureNp1AtReceivers real32_array2d Pressure value at each receiver for each timestep +rcvElem integer_array Element containing the receivers +receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds +receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank +receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point +receiverRegion integer_array Region containing the receivers +sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds +sourceElem integer_array Element containing the sources +sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank +sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point +sourceRegion integer_array Region containing the sources +sourceValue real32_array2d Source Value of the sources +usePML integer Flag to apply PML +uxNp1AtReceivers real32_array2d Ux value at each receiver for each timestep +uyNp1AtReceivers real32_array2d Uy value at each receiver for each timestep +uzNp1AtReceivers real32_array2d Uz value at each receiver for each timestep +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ======================================================================= diff --git a/src/coreComponents/schema/docs/AcousticSEM_other.rst b/src/coreComponents/schema/docs/AcousticSEM_other.rst index 280974da35a..80dd4136b81 100644 --- a/src/coreComponents/schema/docs/AcousticSEM_other.rst +++ b/src/coreComponents/schema/docs/AcousticSEM_other.rst @@ -1,28 +1,28 @@ -========================= ============================================================================================================================================================== ======================================================================= -Name Type Description -========================= ============================================================================================================================================================== ======================================================================= -indexSeismoTrace integer Count for output pressure at receivers -linearDASVectorX real32_array X component of the linear DAS direction vector -linearDASVectorY real32_array Y component of the linear DAS direction vector -linearDASVectorZ real32_array Z component of the linear DAS direction vector -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -pressureNp1AtReceivers real32_array2d Pressure value at each receiver for each timestep -rcvElem integer_array Element containing the receivers -receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds -receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank -receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point -receiverRegion integer_array Region containing the receivers -sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds -sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank -sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point -sourceValue real32_array2d Source Value of the sources -usePML integer Flag to apply PML -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ======================================================================= +========================= ====================================================================================================================================================== ======================================================================= +Name Type Description +========================= ====================================================================================================================================================== ======================================================================= +indexSeismoTrace integer Count for output pressure at receivers +linearDASVectorX real32_array X component of the linear DAS direction vector +linearDASVectorY real32_array Y component of the linear DAS direction vector +linearDASVectorZ real32_array Z component of the linear DAS direction vector +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. +pressureNp1AtReceivers real32_array2d Pressure value at each receiver for each timestep +rcvElem integer_array Element containing the receivers +receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds +receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank +receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point +receiverRegion integer_array Region containing the receivers +sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds +sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank +sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point +sourceValue real32_array2d Source Value of the sources +usePML integer Flag to apply PML +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ======================================================================= diff --git a/src/coreComponents/schema/docs/AcousticVTISEM_other.rst b/src/coreComponents/schema/docs/AcousticVTISEM_other.rst index 280974da35a..80dd4136b81 100644 --- a/src/coreComponents/schema/docs/AcousticVTISEM_other.rst +++ b/src/coreComponents/schema/docs/AcousticVTISEM_other.rst @@ -1,28 +1,28 @@ -========================= ============================================================================================================================================================== ======================================================================= -Name Type Description -========================= ============================================================================================================================================================== ======================================================================= -indexSeismoTrace integer Count for output pressure at receivers -linearDASVectorX real32_array X component of the linear DAS direction vector -linearDASVectorY real32_array Y component of the linear DAS direction vector -linearDASVectorZ real32_array Z component of the linear DAS direction vector -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -pressureNp1AtReceivers real32_array2d Pressure value at each receiver for each timestep -rcvElem integer_array Element containing the receivers -receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds -receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank -receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point -receiverRegion integer_array Region containing the receivers -sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds -sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank -sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point -sourceValue real32_array2d Source Value of the sources -usePML integer Flag to apply PML -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ======================================================================= +========================= ====================================================================================================================================================== ======================================================================= +Name Type Description +========================= ====================================================================================================================================================== ======================================================================= +indexSeismoTrace integer Count for output pressure at receivers +linearDASVectorX real32_array X component of the linear DAS direction vector +linearDASVectorY real32_array Y component of the linear DAS direction vector +linearDASVectorZ real32_array Z component of the linear DAS direction vector +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. +pressureNp1AtReceivers real32_array2d Pressure value at each receiver for each timestep +rcvElem integer_array Element containing the receivers +receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds +receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank +receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point +receiverRegion integer_array Region containing the receivers +sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds +sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank +sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point +sourceValue real32_array2d Source Value of the sources +usePML integer Flag to apply PML +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ======================================================================= diff --git a/src/coreComponents/schema/docs/BlackOilFluid_other.rst b/src/coreComponents/schema/docs/BlackOilFluid_other.rst index 60b6325d615..0ceddaa556f 100644 --- a/src/coreComponents/schema/docs/BlackOilFluid_other.rst +++ b/src/coreComponents/schema/docs/BlackOilFluid_other.rst @@ -1,36 +1,36 @@ -=============================== ======================================================================================================= ============================================================================================================ -Name Type Description -=============================== ======================================================================================================= ============================================================================================================ -PVTO geos_constitutive_PVTOData (no description available) -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -formationVolFactorTableWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -hydrocarbonPhaseOrder integer_array (no description available) -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseOrder integer_array (no description available) -phaseTypes integer_array (no description available) -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -viscosityTableWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -=============================== ======================================================================================================= ============================================================================================================ +=============================== =================================================================================================== ============================================================================================================ +Name Type Description +=============================== =================================================================================================== ============================================================================================================ +PVTO geos_constitutive_PVTOData (no description available) +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +formationVolFactorTableWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +hydrocarbonPhaseOrder integer_array (no description available) +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseOrder integer_array (no description available) +phaseTypes integer_array (no description available) +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +viscosityTableWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +=============================== =================================================================================================== ============================================================================================================ diff --git a/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid_other.rst b/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid_other.rst index 476b50195e5..28636011f61 100644 --- a/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid_other.rst +++ b/src/coreComponents/schema/docs/CO2BrineEzrokhiFluid_other.rst @@ -1,30 +1,30 @@ -===================== ============================================================================================= ============================================================================================================ -Name Type Description -===================== ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -===================== ============================================================================================= ============================================================================================================ +===================== ========================================================================================= ============================================================================================================ +Name Type Description +===================== ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +===================== ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid_other.rst b/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid_other.rst index 476b50195e5..28636011f61 100644 --- a/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid_other.rst +++ b/src/coreComponents/schema/docs/CO2BrineEzrokhiThermalFluid_other.rst @@ -1,30 +1,30 @@ -===================== ============================================================================================= ============================================================================================================ -Name Type Description -===================== ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -===================== ============================================================================================= ============================================================================================================ +===================== ========================================================================================= ============================================================================================================ +Name Type Description +===================== ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +===================== ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/CO2BrinePhillipsFluid_other.rst b/src/coreComponents/schema/docs/CO2BrinePhillipsFluid_other.rst index 476b50195e5..28636011f61 100644 --- a/src/coreComponents/schema/docs/CO2BrinePhillipsFluid_other.rst +++ b/src/coreComponents/schema/docs/CO2BrinePhillipsFluid_other.rst @@ -1,30 +1,30 @@ -===================== ============================================================================================= ============================================================================================================ -Name Type Description -===================== ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -===================== ============================================================================================= ============================================================================================================ +===================== ========================================================================================= ============================================================================================================ +Name Type Description +===================== ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +===================== ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid_other.rst b/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid_other.rst index 476b50195e5..28636011f61 100644 --- a/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid_other.rst +++ b/src/coreComponents/schema/docs/CO2BrinePhillipsThermalFluid_other.rst @@ -1,30 +1,30 @@ -===================== ============================================================================================= ============================================================================================================ -Name Type Description -===================== ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -===================== ============================================================================================= ============================================================================================================ +===================== ========================================================================================= ============================================================================================================ +Name Type Description +===================== ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +===================== ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/CellElementRegion_other.rst b/src/coreComponents/schema/docs/CellElementRegion_other.rst index a65968b0105..bb012ac8ff4 100644 --- a/src/coreComponents/schema/docs/CellElementRegion_other.rst +++ b/src/coreComponents/schema/docs/CellElementRegion_other.rst @@ -1,16 +1,16 @@ -======================= ==================================================================== ========================================================= -Name Type Description -======================= ==================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -elementSubRegions node :ref:`DATASTRUCTURE_elementSubRegions` -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= ==================================================================== ========================================================= +======================= ================================================================= ========================================================= +Name Type Description +======================= ================================================================= ========================================================= +domainBoundaryIndicator integer_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +elementSubRegions node :ref:`DATASTRUCTURE_elementSubRegions` +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ================================================================= ========================================================= diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM_other.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseFVM_other.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseFVM_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/CompositionalMultiphaseFluid_other.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseFluid_other.rst index 476b50195e5..28636011f61 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseFluid_other.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseFluid_other.rst @@ -1,30 +1,30 @@ -===================== ============================================================================================= ============================================================================================================ -Name Type Description -===================== ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -===================== ============================================================================================= ============================================================================================================ +===================== ========================================================================================= ============================================================================================================ +Name Type Description +===================== ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +===================== ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM_other.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM_other.rst index c69ff8f4e38..2944d71993d 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM_other.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseHybridFVM_other.rst @@ -1,15 +1,15 @@ -========================= ============================================================================================================================================================== ================================ ================================================================ -Name Type Registered On Description -========================= ============================================================================================================================================================== ================================ ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -facePressure_n real64_array :ref:`DATASTRUCTURE_faceManager` Face pressure at the previous converged time step -mimGravityCoefficient real64_array :ref:`DATASTRUCTURE_faceManager` Mimetic gravity coefficient -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ================================ ================================================================ +========================= ====================================================================================================================================================== ================================ ================================================================ +Name Type Registered On Description +========================= ====================================================================================================================================================== ================================ ================================================================ +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. +facePressure_n real64_array :ref:`DATASTRUCTURE_faceManager` Face pressure at the previous converged time step +mimGravityCoefficient real64_array :ref:`DATASTRUCTURE_faceManager` Mimetic gravity coefficient +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ================================ ================================================================ diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics_other.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics_other.rst index 80b71ab722d..dc33be0a036 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics_other.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoirPoromechanics_other.rst @@ -1,15 +1,15 @@ -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir_other.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir_other.rst index 45d9a187f0a..cccf4603c70 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir_other.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseReservoir_other.rst @@ -1,14 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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/CompositionalMultiphaseWell_other.rst b/src/coreComponents/schema/docs/CompositionalMultiphaseWell_other.rst index 3f16a155d2b..f2c739b92d8 100644 --- a/src/coreComponents/schema/docs/CompositionalMultiphaseWell_other.rst +++ b/src/coreComponents/schema/docs/CompositionalMultiphaseWell_other.rst @@ -1,15 +1,15 @@ -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -WellControls node :ref:`DATASTRUCTURE_WellControls` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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` +WellControls node :ref:`DATASTRUCTURE_WellControls` +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidPengRobinson_other.rst b/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidPengRobinson_other.rst index 476b50195e5..28636011f61 100644 --- a/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidPengRobinson_other.rst +++ b/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidPengRobinson_other.rst @@ -1,30 +1,30 @@ -===================== ============================================================================================= ============================================================================================================ -Name Type Description -===================== ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -===================== ============================================================================================= ============================================================================================================ +===================== ========================================================================================= ============================================================================================================ +Name Type Description +===================== ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +===================== ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidSoaveRedlichKwong_other.rst b/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidSoaveRedlichKwong_other.rst index 476b50195e5..28636011f61 100644 --- a/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidSoaveRedlichKwong_other.rst +++ b/src/coreComponents/schema/docs/CompositonalTwoPhaseFluidSoaveRedlichKwong_other.rst @@ -1,30 +1,30 @@ -===================== ============================================================================================= ============================================================================================================ -Name Type Description -===================== ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -===================== ============================================================================================= ============================================================================================================ +===================== ========================================================================================= ============================================================================================================ +Name Type Description +===================== ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +===================== ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/DeadOilFluid_other.rst b/src/coreComponents/schema/docs/DeadOilFluid_other.rst index 139d0708316..de90cbaf87f 100644 --- a/src/coreComponents/schema/docs/DeadOilFluid_other.rst +++ b/src/coreComponents/schema/docs/DeadOilFluid_other.rst @@ -1,35 +1,35 @@ -=============================== ======================================================================================================= ============================================================================================================ -Name Type Description -=============================== ======================================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -formationVolFactorTableWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -hydrocarbonPhaseOrder integer_array (no description available) -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseOrder integer_array (no description available) -phaseTypes integer_array (no description available) -phaseViscosity real64_array3d Phase viscosity -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -viscosityTableWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -=============================== ======================================================================================================= ============================================================================================================ +=============================== =================================================================================================== ============================================================================================================ +Name Type Description +=============================== =================================================================================================== ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +formationVolFactorTableWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +hydrocarbonPhaseOrder integer_array (no description available) +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseOrder integer_array (no description available) +phaseTypes integer_array (no description available) +phaseViscosity real64_array3d Phase viscosity +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +viscosityTableWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +=============================== =================================================================================================== ============================================================================================================ diff --git a/src/coreComponents/schema/docs/ElasticFirstOrderSEM_other.rst b/src/coreComponents/schema/docs/ElasticFirstOrderSEM_other.rst index a5e6f05623a..67c4b18bc7c 100644 --- a/src/coreComponents/schema/docs/ElasticFirstOrderSEM_other.rst +++ b/src/coreComponents/schema/docs/ElasticFirstOrderSEM_other.rst @@ -1,38 +1,38 @@ -=========================== ============================================================================================================================================================== ======================================================================= -Name Type Description -=========================== ============================================================================================================================================================== ======================================================================= -displacementxNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (x-components) -displacementyNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (y-components) -displacementzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) -indexSeismoTrace integer Count for output pressure at receivers -linearDASVectorX real32_array X component of the linear DAS direction vector -linearDASVectorY real32_array Y component of the linear DAS direction vector -linearDASVectorZ real32_array Z component of the linear DAS direction vector -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -rcvElem integer_array Element containing the receivers -receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds -receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank -receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point -receiverRegion integer_array Region containing the receivers -sigmaxxNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) -sigmaxyNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) -sigmaxzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) -sigmayyNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) -sigmayzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) -sigmazzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) -sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds -sourceElem integer_array Element containing the sources -sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank -sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point -sourceRegion integer_array Region containing the sources -sourceValue real32_array2d Source Value of the sources -usePML integer Flag to apply PML -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================= +=========================== ====================================================================================================================================================== ======================================================================= +Name Type Description +=========================== ====================================================================================================================================================== ======================================================================= +displacementxNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (x-components) +displacementyNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (y-components) +displacementzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) +indexSeismoTrace integer Count for output pressure at receivers +linearDASVectorX real32_array X component of the linear DAS direction vector +linearDASVectorY real32_array Y component of the linear DAS direction vector +linearDASVectorZ real32_array Z component of the linear DAS direction vector +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. +rcvElem integer_array Element containing the receivers +receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds +receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank +receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point +receiverRegion integer_array Region containing the receivers +sigmaxxNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) +sigmaxyNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) +sigmaxzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) +sigmayyNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) +sigmayzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) +sigmazzNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-components) +sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds +sourceElem integer_array Element containing the sources +sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank +sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point +sourceRegion integer_array Region containing the sources +sourceValue real32_array2d Source Value of the sources +usePML integer Flag to apply PML +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================= diff --git a/src/coreComponents/schema/docs/ElasticSEM_other.rst b/src/coreComponents/schema/docs/ElasticSEM_other.rst index 06969fee16a..dbe0ac40e7a 100644 --- a/src/coreComponents/schema/docs/ElasticSEM_other.rst +++ b/src/coreComponents/schema/docs/ElasticSEM_other.rst @@ -1,31 +1,31 @@ -=========================== ============================================================================================================================================================== ================================================================================== -Name Type Description -=========================== ============================================================================================================================================================== ================================================================================== -dasSignalNp1AtReceivers real32_array2d DAS signal value at each receiver for each timestep -displacementXNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (x-component) -displacementYNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (y-component) -displacementZNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-component) -indexSeismoTrace integer Count for output pressure at receivers -linearDASVectorX real32_array X component of the linear DAS direction vector -linearDASVectorY real32_array Y component of the linear DAS direction vector -linearDASVectorZ real32_array Z component of the linear DAS direction vector -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -rcvElem integer_array Element containing the receivers -receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds -receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank -receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point -receiverRegion integer_array Region containing the receivers -sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds in z-direction -sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank -sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point -sourceValue real32_array2d Source Value of the sources -usePML integer Flag to apply PML -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ================================================================================== +=========================== ====================================================================================================================================================== ================================================================================== +Name Type Description +=========================== ====================================================================================================================================================== ================================================================================== +dasSignalNp1AtReceivers real32_array2d DAS signal value at each receiver for each timestep +displacementXNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (x-component) +displacementYNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (y-component) +displacementZNp1AtReceivers real32_array2d Displacement value at each receiver for each timestep (z-component) +indexSeismoTrace integer Count for output pressure at receivers +linearDASVectorX real32_array X component of the linear DAS direction vector +linearDASVectorY real32_array Y component of the linear DAS direction vector +linearDASVectorZ real32_array Z component of the linear DAS direction vector +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. +rcvElem integer_array Element containing the receivers +receiverConstants real64_array2d Constant part of the receiver for the nodes listed in m_receiverNodeIds +receiverIsLocal integer_array Flag that indicates whether the receiver is local to this MPI rank +receiverNodeIds integer_array2d Indices of the nodes (in the right order) for each receiver point +receiverRegion integer_array Region containing the receivers +sourceConstants real64_array2d Constant part of the source for the nodes listed in m_sourceNodeIds in z-direction +sourceIsAccessible integer_array Flag that indicates whether the source is local to this MPI rank +sourceNodeIds integer_array2d Indices of the nodes (in the right order) for each source point +sourceValue real32_array2d Source Value of the sources +usePML integer Flag to apply PML +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ================================================================================== diff --git a/src/coreComponents/schema/docs/ElementRegions_other.rst b/src/coreComponents/schema/docs/ElementRegions_other.rst index 17af822cdb0..f62357429ae 100644 --- a/src/coreComponents/schema/docs/ElementRegions_other.rst +++ b/src/coreComponents/schema/docs/ElementRegions_other.rst @@ -1,19 +1,19 @@ -======================= ==================================================================== ========================================================= -Name Type Description -======================= ==================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -CellElementRegion node :ref:`DATASTRUCTURE_CellElementRegion` -SurfaceElementRegion node :ref:`DATASTRUCTURE_SurfaceElementRegion` -WellElementRegion node :ref:`DATASTRUCTURE_WellElementRegion` -elementRegionsGroup node :ref:`DATASTRUCTURE_elementRegionsGroup` -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= ==================================================================== ========================================================= +======================= ================================================================= ========================================================= +Name Type Description +======================= ================================================================= ========================================================= +domainBoundaryIndicator integer_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +CellElementRegion node :ref:`DATASTRUCTURE_CellElementRegion` +SurfaceElementRegion node :ref:`DATASTRUCTURE_SurfaceElementRegion` +WellElementRegion node :ref:`DATASTRUCTURE_WellElementRegion` +elementRegionsGroup node :ref:`DATASTRUCTURE_elementRegionsGroup` +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ================================================================= ========================================================= diff --git a/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator_other.rst b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator_other.rst index 46c029f2c1a..f2590daca7c 100644 --- a/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator_other.rst +++ b/src/coreComponents/schema/docs/EmbeddedSurfaceGenerator_other.rst @@ -1,14 +1,14 @@ -========================= ============================================================================================================================================================== ================================================ ================================================================ -Name Type Registered On Description -========================= ============================================================================================================================================================== ================================================ ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -parentEdgeIndex integer_array :ref:`DATASTRUCTURE_embeddedSurfacesNodeManager` Index of parent edge within the mesh object it is registered on. -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ================================================ ================================================================ +========================= ====================================================================================================================================================== ================================================ ================================================================ +Name Type Registered On Description +========================= ====================================================================================================================================================== ================================================ ================================================================ +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. +parentEdgeIndex integer_array :ref:`DATASTRUCTURE_embeddedSurfacesNodeManager` Index of parent edge within the mesh object it is registered on. +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ================================================ ================================================================ diff --git a/src/coreComponents/schema/docs/FlowProppantTransport_other.rst b/src/coreComponents/schema/docs/FlowProppantTransport_other.rst index 45d9a187f0a..cccf4603c70 100644 --- a/src/coreComponents/schema/docs/FlowProppantTransport_other.rst +++ b/src/coreComponents/schema/docs/FlowProppantTransport_other.rst @@ -1,14 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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/Hydrofracture.rst b/src/coreComponents/schema/docs/Hydrofracture.rst index c65d103f356..2c63529e0c0 100644 --- a/src/coreComponents/schema/docs/Hydrofracture.rst +++ b/src/coreComponents/schema/docs/Hydrofracture.rst @@ -1,23 +1,24 @@ -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -Name Type Default Description -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== -cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] -contactRelationName groupNameRef required Name of contact relation to enforce constraints on fracture boundary. -flowSolverName groupNameRef required Name of the flow solver used by the coupled solver -initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. -isMatrixPoroelastic integer 0 (no description available) -isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling -logLevel integer 0 Log level -maxNumResolves integer 10 Value to indicate how many resolves may be executed to perform surface generation after the execution of flow and mechanics solver. -name groupName required A name is required for any non-unique nodes -solidSolverName groupNameRef required Name of the solid solver used by the coupled solver -surfaceGeneratorName groupNameRef required Name of the surface generator to use in the hydrofracture solver -targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. -useQuasiNewton integer 0 (no description available) -LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` -NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` -========================= ================== ======== ====================================================================================================================================================================================================================================================================================================================== +============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================== +Name Type Default Description +============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================== +cflFactor real64 0.5 Factor to apply to the `CFL condition `_ when calculating the maximum allowable time step. Values should be in the interval (0,1] +contactRelationName groupNameRef required Name of contact relation to enforce constraints on fracture boundary. +flowSolverName groupNameRef required Name of the flow solver used by the coupled solver +initialDt real64 1e+99 Initial time-step value required by the solver to the event manager. +isMatrixPoroelastic integer 0 (no description available) +isThermal integer 0 Flag indicating whether the problem is thermal or not. Set isThermal="1" to enable the thermal coupling +logLevel integer 0 Log level +maxNumResolves integer 10 Value to indicate how many resolves may be executed to perform surface generation after the execution of flow and mechanics solver. +name groupName required A name is required for any non-unique nodes +newFractureInitializationType geos_HydrofractureSolver >_InitializationType Pressure Type of new fracture element initialization. Can be Pressure or Displacement. +solidSolverName groupNameRef required Name of the solid solver used by the coupled solver +surfaceGeneratorName groupNameRef required Name of the surface generator to use in the hydrofracture solver +targetRegions groupNameRef_array required Allowable regions that the solver may be applied to. Note that this does not indicate that the solver will be applied to these regions, only that allocation will occur such that the solver may be applied to these regions. The decision about what regions this solver will beapplied to rests in the EventManager. +useQuasiNewton integer 0 (no description available) +LinearSolverParameters node unique :ref:`XML_LinearSolverParameters` +NonlinearSolverParameters node unique :ref:`XML_NonlinearSolverParameters` +============================= =================================================================================================================================== ======== ====================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/Hydrofracture_other.rst b/src/coreComponents/schema/docs/Hydrofracture_other.rst index 80b71ab722d..dc33be0a036 100644 --- a/src/coreComponents/schema/docs/Hydrofracture_other.rst +++ b/src/coreComponents/schema/docs/Hydrofracture_other.rst @@ -1,15 +1,15 @@ -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/JFunctionCapillaryPressure_other.rst b/src/coreComponents/schema/docs/JFunctionCapillaryPressure_other.rst index 68708936927..a9cd8c30fda 100644 --- a/src/coreComponents/schema/docs/JFunctionCapillaryPressure_other.rst +++ b/src/coreComponents/schema/docs/JFunctionCapillaryPressure_other.rst @@ -1,14 +1,14 @@ -=================================== ======================================================================================================= ============================================================================ -Name Type Description -=================================== ======================================================================================================= ============================================================================ -dPhaseCapPressure_dPhaseVolFraction real64_array4d Derivative of phase capillary pressure with respect to phase volume fraction -jFuncMultiplier real64_array2d Multiplier for the Leverett J-function -jFunctionWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -phaseCapPressure real64_array3d Phase capillary pressure -phaseOrder integer_array (no description available) -phaseTypes integer_array (no description available) -=================================== ======================================================================================================= ============================================================================ +=================================== =================================================================================================== ============================================================================ +Name Type Description +=================================== =================================================================================================== ============================================================================ +dPhaseCapPressure_dPhaseVolFraction real64_array4d Derivative of phase capillary pressure with respect to phase volume fraction +jFuncMultiplier real64_array2d Multiplier for the Leverett J-function +jFunctionWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +phaseCapPressure real64_array3d Phase capillary pressure +phaseOrder integer_array (no description available) +phaseTypes integer_array (no description available) +=================================== =================================================================================================== ============================================================================ diff --git a/src/coreComponents/schema/docs/LaplaceFEM_other.rst b/src/coreComponents/schema/docs/LaplaceFEM_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/LaplaceFEM_other.rst +++ b/src/coreComponents/schema/docs/LaplaceFEM_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/MultiphasePoromechanicsReservoir_other.rst b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir_other.rst index 45d9a187f0a..cccf4603c70 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir_other.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanicsReservoir_other.rst @@ -1,14 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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/MultiphasePoromechanics_other.rst b/src/coreComponents/schema/docs/MultiphasePoromechanics_other.rst index 80b71ab722d..dc33be0a036 100644 --- a/src/coreComponents/schema/docs/MultiphasePoromechanics_other.rst +++ b/src/coreComponents/schema/docs/MultiphasePoromechanics_other.rst @@ -1,15 +1,15 @@ -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/ParticleRegion_other.rst b/src/coreComponents/schema/docs/ParticleRegion_other.rst index fbfc33ebf7f..f57cca08d6b 100644 --- a/src/coreComponents/schema/docs/ParticleRegion_other.rst +++ b/src/coreComponents/schema/docs/ParticleRegion_other.rst @@ -1,16 +1,16 @@ -======================= ==================================================================== ========================================================= -Name Type Description -======================= ==================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -neighborData node :ref:`DATASTRUCTURE_neighborData` -particleSubRegions node :ref:`DATASTRUCTURE_particleSubRegions` -sets node :ref:`DATASTRUCTURE_sets` -======================= ==================================================================== ========================================================= +======================= ================================================================= ========================================================= +Name Type Description +======================= ================================================================= ========================================================= +domainBoundaryIndicator integer_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +neighborData node :ref:`DATASTRUCTURE_neighborData` +particleSubRegions node :ref:`DATASTRUCTURE_particleSubRegions` +sets node :ref:`DATASTRUCTURE_sets` +======================= ================================================================= ========================================================= diff --git a/src/coreComponents/schema/docs/ParticleRegions_other.rst b/src/coreComponents/schema/docs/ParticleRegions_other.rst index 48075ebfe05..94022d14540 100644 --- a/src/coreComponents/schema/docs/ParticleRegions_other.rst +++ b/src/coreComponents/schema/docs/ParticleRegions_other.rst @@ -1,17 +1,17 @@ -======================= ==================================================================== ========================================================= -Name Type Description -======================= ==================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -ParticleRegion node :ref:`DATASTRUCTURE_ParticleRegion` -neighborData node :ref:`DATASTRUCTURE_neighborData` -particleRegionsGroup node :ref:`DATASTRUCTURE_particleRegionsGroup` -sets node :ref:`DATASTRUCTURE_sets` -======================= ==================================================================== ========================================================= +======================= ================================================================= ========================================================= +Name Type Description +======================= ================================================================= ========================================================= +domainBoundaryIndicator integer_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +ParticleRegion node :ref:`DATASTRUCTURE_ParticleRegion` +neighborData node :ref:`DATASTRUCTURE_neighborData` +particleRegionsGroup node :ref:`DATASTRUCTURE_particleRegionsGroup` +sets node :ref:`DATASTRUCTURE_sets` +======================= ================================================================= ========================================================= diff --git a/src/coreComponents/schema/docs/PhaseFieldDamageFEM_other.rst b/src/coreComponents/schema/docs/PhaseFieldDamageFEM_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/PhaseFieldDamageFEM_other.rst +++ b/src/coreComponents/schema/docs/PhaseFieldDamageFEM_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/PhaseFieldFracture_other.rst b/src/coreComponents/schema/docs/PhaseFieldFracture_other.rst index 45d9a187f0a..cccf4603c70 100644 --- a/src/coreComponents/schema/docs/PhaseFieldFracture_other.rst +++ b/src/coreComponents/schema/docs/PhaseFieldFracture_other.rst @@ -1,14 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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/ProppantTransport_other.rst b/src/coreComponents/schema/docs/ProppantTransport_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/ProppantTransport_other.rst +++ b/src/coreComponents/schema/docs/ProppantTransport_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/ReactiveBrineThermal_other.rst b/src/coreComponents/schema/docs/ReactiveBrineThermal_other.rst index 74f30d53b77..05bd31c0020 100644 --- a/src/coreComponents/schema/docs/ReactiveBrineThermal_other.rst +++ b/src/coreComponents/schema/docs/ReactiveBrineThermal_other.rst @@ -1,34 +1,34 @@ -================================ ============================================================================================= ============================================================================================================ -Name Type Description -================================ ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -kineticReactionRates real64_array2d kineticReactionRates -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -primarySpeciesConcentration real64_array2d primarySpeciesConcentration -primarySpeciesTotalConcentration real64_array2d primarySpeciesTotalConcentration -secondarySpeciesConcentration real64_array2d secondarySpeciesConcentration -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -================================ ============================================================================================= ============================================================================================================ +================================ ========================================================================================= ============================================================================================================ +Name Type Description +================================ ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +kineticReactionRates real64_array2d kineticReactionRates +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +primarySpeciesConcentration real64_array2d primarySpeciesConcentration +primarySpeciesTotalConcentration real64_array2d primarySpeciesTotalConcentration +secondarySpeciesConcentration real64_array2d secondarySpeciesConcentration +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +================================ ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/ReactiveBrine_other.rst b/src/coreComponents/schema/docs/ReactiveBrine_other.rst index 74f30d53b77..05bd31c0020 100644 --- a/src/coreComponents/schema/docs/ReactiveBrine_other.rst +++ b/src/coreComponents/schema/docs/ReactiveBrine_other.rst @@ -1,34 +1,34 @@ -================================ ============================================================================================= ============================================================================================================ -Name Type Description -================================ ============================================================================================= ============================================================================================================ -dPhaseCompFraction LvArray_Array< double, 5, camp_int_seq< long, 0l, 1l, 2l, 3l, 4l >, int, LvArray_ChaiBuffer > Derivative of phase component fraction with respect to pressure, temperature, and global component fractions -dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions -dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions -dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions -dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions -dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions -dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions -dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions -kineticReactionRates real64_array2d kineticReactionRates -phaseCompFraction real64_array4d Phase component fraction -phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step -phaseDensity real64_array3d Phase density -phaseDensity_n real64_array3d Phase density at the previous converged time step -phaseEnthalpy real64_array3d Phase enthalpy -phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step -phaseFraction real64_array3d Phase fraction -phaseInternalEnergy real64_array3d Phase internal energy -phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step -phaseMassDensity real64_array3d Phase mass density -phaseViscosity real64_array3d Phase viscosity -primarySpeciesConcentration real64_array2d primarySpeciesConcentration -primarySpeciesTotalConcentration real64_array2d primarySpeciesTotalConcentration -secondarySpeciesConcentration real64_array2d secondarySpeciesConcentration -totalDensity real64_array2d Total density -totalDensity_n real64_array2d Total density at the previous converged time step -useMass integer (no description available) -================================ ============================================================================================= ============================================================================================================ +================================ ========================================================================================= ============================================================================================================ +Name Type Description +================================ ========================================================================================= ============================================================================================================ +dPhaseCompFraction LvArray_Array, int, LvArray_ChaiBuffer> Derivative of phase component fraction with respect to pressure, temperature, and global component fractions +dPhaseDensity real64_array4d Derivative of phase density with respect to pressure, temperature, and global component fractions +dPhaseEnthalpy real64_array4d Derivative of phase enthalpy with respect to pressure, temperature, and global component fractions +dPhaseFraction real64_array4d Derivative of phase fraction with respect to pressure, temperature, and global component fractions +dPhaseInternalEnergy real64_array4d Derivative of phase internal energy with respect to pressure, temperature, and global component fractions +dPhaseMassDensity real64_array4d Derivative of phase mass density with respect to pressure, temperature, and global component fractions +dPhaseViscosity real64_array4d Derivative of phase viscosity with respect to pressure, temperature, and global component fractions +dTotalDensity real64_array3d Derivative of total density with respect to pressure, temperature, and global component fractions +kineticReactionRates real64_array2d kineticReactionRates +phaseCompFraction real64_array4d Phase component fraction +phaseCompFraction_n real64_array4d Phase component fraction at the previous converged time step +phaseDensity real64_array3d Phase density +phaseDensity_n real64_array3d Phase density at the previous converged time step +phaseEnthalpy real64_array3d Phase enthalpy +phaseEnthalpy_n real64_array3d Phase enthalpy at the previous converged time step +phaseFraction real64_array3d Phase fraction +phaseInternalEnergy real64_array3d Phase internal energy +phaseInternalEnergy_n real64_array3d Phase internal energy at the previous converged time step +phaseMassDensity real64_array3d Phase mass density +phaseViscosity real64_array3d Phase viscosity +primarySpeciesConcentration real64_array2d primarySpeciesConcentration +primarySpeciesTotalConcentration real64_array2d primarySpeciesTotalConcentration +secondarySpeciesConcentration real64_array2d secondarySpeciesConcentration +totalDensity real64_array2d Total density +totalDensity_n real64_array2d Total density at the previous converged time step +useMass integer (no description available) +================================ ========================================================================================= ============================================================================================================ diff --git a/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL_other.rst b/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL_other.rst +++ b/src/coreComponents/schema/docs/ReactiveCompositionalMultiphaseOBL_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/SinglePhaseFVM_other.rst b/src/coreComponents/schema/docs/SinglePhaseFVM_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/SinglePhaseFVM_other.rst +++ b/src/coreComponents/schema/docs/SinglePhaseFVM_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/SinglePhaseHybridFVM_other.rst b/src/coreComponents/schema/docs/SinglePhaseHybridFVM_other.rst index d1627f7fba7..f0cca96f3a1 100644 --- a/src/coreComponents/schema/docs/SinglePhaseHybridFVM_other.rst +++ b/src/coreComponents/schema/docs/SinglePhaseHybridFVM_other.rst @@ -1,14 +1,14 @@ -========================= ============================================================================================================================================================== ================================ ================================================================ -Name Type Registered On Description -========================= ============================================================================================================================================================== ================================ ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -facePressure_n real64_array :ref:`DATASTRUCTURE_faceManager` Face pressure at the previous converged time step -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ================================ ================================================================ +========================= ====================================================================================================================================================== ================================ ================================================================ +Name Type Registered On Description +========================= ====================================================================================================================================================== ================================ ================================================================ +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. +facePressure_n real64_array :ref:`DATASTRUCTURE_faceManager` Face pressure at the previous converged time step +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ================================ ================================================================ diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures_other.rst index 80b71ab722d..dc33be0a036 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures_other.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsConformingFractures_other.rst @@ -1,15 +1,15 @@ -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures_other.rst index 80b71ab722d..dc33be0a036 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures_other.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsEmbeddedFractures_other.rst @@ -1,15 +1,15 @@ -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir_other.rst index 45d9a187f0a..cccf4603c70 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir_other.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanicsReservoir_other.rst @@ -1,14 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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/SinglePhasePoromechanics_other.rst b/src/coreComponents/schema/docs/SinglePhasePoromechanics_other.rst index 80b71ab722d..dc33be0a036 100644 --- a/src/coreComponents/schema/docs/SinglePhasePoromechanics_other.rst +++ b/src/coreComponents/schema/docs/SinglePhasePoromechanics_other.rst @@ -1,15 +1,15 @@ -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseProppantFVM_other.rst b/src/coreComponents/schema/docs/SinglePhaseProppantFVM_other.rst index 3f1b37c3d6c..f296d4de732 100644 --- a/src/coreComponents/schema/docs/SinglePhaseProppantFVM_other.rst +++ b/src/coreComponents/schema/docs/SinglePhaseProppantFVM_other.rst @@ -1,13 +1,13 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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/SinglePhaseReservoirPoromechanics_other.rst b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics_other.rst index 80b71ab722d..dc33be0a036 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics_other.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoirPoromechanics_other.rst @@ -1,15 +1,15 @@ -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -=========================== ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +performStressInitialization integer Flag to indicate that the solver is going to perform stress initialization +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +=========================== ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SinglePhaseReservoir_other.rst b/src/coreComponents/schema/docs/SinglePhaseReservoir_other.rst index 45d9a187f0a..cccf4603c70 100644 --- a/src/coreComponents/schema/docs/SinglePhaseReservoir_other.rst +++ b/src/coreComponents/schema/docs/SinglePhaseReservoir_other.rst @@ -1,14 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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/SinglePhaseWell_other.rst b/src/coreComponents/schema/docs/SinglePhaseWell_other.rst index 3f16a155d2b..f2c739b92d8 100644 --- a/src/coreComponents/schema/docs/SinglePhaseWell_other.rst +++ b/src/coreComponents/schema/docs/SinglePhaseWell_other.rst @@ -1,15 +1,15 @@ -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -WellControls node :ref:`DATASTRUCTURE_WellControls` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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` +WellControls node :ref:`DATASTRUCTURE_WellControls` +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures_other.rst b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures_other.rst index 17da1cb5b33..1a9ad823675 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures_other.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsEmbeddedFractures_other.rst @@ -1,16 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ===================================================================== +========================= ====================================================================================================================================================== ===================================================================== +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/SolidMechanicsLagrangeContact_other.rst b/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact_other.rst index 17da1cb5b33..1a9ad823675 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact_other.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangeContact_other.rst @@ -1,16 +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< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ===================================================================== +========================= ====================================================================================================================================================== ===================================================================== +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/SolidMechanicsLagrangianSSLE_other.rst b/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE_other.rst index a4018f48d74..e458a0e69b3 100644 --- a/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE_other.rst +++ b/src/coreComponents/schema/docs/SolidMechanicsLagrangianSSLE_other.rst @@ -1,14 +1,14 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxForce real64 The maximum force contribution in the problem domain. -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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. +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ================================================================ diff --git a/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM_other.rst b/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM_other.rst index a4018f48d74..e458a0e69b3 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM_other.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_LagrangianFEM_other.rst @@ -1,14 +1,14 @@ -========================= ============================================================================================================================================================== ================================================================ -Name Type Description -========================= ============================================================================================================================================================== ================================================================ -maxForce real64 The maximum force contribution in the problem domain. -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > 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` -========================= ============================================================================================================================================================== ================================================================ +========================= ====================================================================================================================================================== ================================================================ +Name Type Description +========================= ====================================================================================================================================================== ================================================================ +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. +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ================================================================ diff --git a/src/coreComponents/schema/docs/SolidMechanics_MPM_other.rst b/src/coreComponents/schema/docs/SolidMechanics_MPM_other.rst index 4cd129ff504..e0b8502fb7f 100644 --- a/src/coreComponents/schema/docs/SolidMechanics_MPM_other.rst +++ b/src/coreComponents/schema/docs/SolidMechanics_MPM_other.rst @@ -1,34 +1,34 @@ -========================= ============================================================================================================================================================== ================================================================================================== -Name Type Description -========================= ============================================================================================================================================================== ================================================================================================== -bcTable real64_array2d Array that stores time-dependent bc types on x-, x+, y-, y+, z- and z+ faces. -binSizeMultiplier integer Multiplier for setting bin size, used to speed up particle neighbor sorting -domainExtent real64_array domain extent -domainF real64_array domain deformation gradient -domainL real64_array domain L -elementSize real64_array Minimum element size in x, y and z -fTable real64_array2d Array that stores time-dependent grid-aligned stretches interpreted as a global background grid F. -globalMaximum real64_array global maximum -globalMinimum real64_array global minimum -localMaximum real64_array local maximum -localMaximumNoGhost real64_array local maximum without ghost cells -localMinimum real64_array local minimum -localMinimumNoGhost real64_array local minimum without ghost cells -m_ijkMap integer_array3d Map from indices in each spatial dimension to local node ID -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -numContactFlags integer Number of contact flags that can appear due to damage -numContactGroups integer Number of prescribed contact groups -numDims integer The number of active spatial dimensions, 2 for plane strain, 3 otherwise -numElements integer_array number of elements along partition directions -numVelocityFields integer Number of velocity fields -partitionExtent real64_array parititon extent -smallMass real64 The small mass threshold for ignoring extremely low-mass nodes. -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ================================================================================================== +========================= ====================================================================================================================================================== ================================================================================================== +Name Type Description +========================= ====================================================================================================================================================== ================================================================================================== +bcTable real64_array2d Array that stores time-dependent bc types on x-, x+, y-, y+, z- and z+ faces. +binSizeMultiplier integer Multiplier for setting bin size, used to speed up particle neighbor sorting +domainExtent real64_array domain extent +domainF real64_array domain deformation gradient +domainL real64_array domain L +elementSize real64_array Minimum element size in x, y and z +fTable real64_array2d Array that stores time-dependent grid-aligned stretches interpreted as a global background grid F. +globalMaximum real64_array global maximum +globalMinimum real64_array global minimum +localMaximum real64_array local maximum +localMaximumNoGhost real64_array local maximum without ghost cells +localMinimum real64_array local minimum +localMinimumNoGhost real64_array local minimum without ghost cells +m_ijkMap integer_array3d Map from indices in each spatial dimension to local node ID +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. +numContactFlags integer Number of contact flags that can appear due to damage +numContactGroups integer Number of prescribed contact groups +numDims integer The number of active spatial dimensions, 2 for plane strain, 3 otherwise +numElements integer_array number of elements along partition directions +numVelocityFields integer Number of velocity fields +partitionExtent real64_array parititon extent +smallMass real64 The small mass threshold for ignoring extremely low-mass nodes. +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ================================================================================================== diff --git a/src/coreComponents/schema/docs/SurfaceElementRegion_other.rst b/src/coreComponents/schema/docs/SurfaceElementRegion_other.rst index a65968b0105..bb012ac8ff4 100644 --- a/src/coreComponents/schema/docs/SurfaceElementRegion_other.rst +++ b/src/coreComponents/schema/docs/SurfaceElementRegion_other.rst @@ -1,16 +1,16 @@ -======================= ==================================================================== ========================================================= -Name Type Description -======================= ==================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -elementSubRegions node :ref:`DATASTRUCTURE_elementSubRegions` -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= ==================================================================== ========================================================= +======================= ================================================================= ========================================================= +Name Type Description +======================= ================================================================= ========================================================= +domainBoundaryIndicator integer_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +elementSubRegions node :ref:`DATASTRUCTURE_elementSubRegions` +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ================================================================= ========================================================= diff --git a/src/coreComponents/schema/docs/SurfaceGenerator_other.rst b/src/coreComponents/schema/docs/SurfaceGenerator_other.rst index d9e8cac2e2d..644325ed6a9 100644 --- a/src/coreComponents/schema/docs/SurfaceGenerator_other.rst +++ b/src/coreComponents/schema/docs/SurfaceGenerator_other.rst @@ -1,19 +1,19 @@ -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== -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. -failCriterion integer (no description available) -maxStableDt real64 Value of the Maximum Stable Timestep for this solver. -meshTargets geos_mapBase< std_pair< string, string >, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > MeshBody/Region combinations that the solver will be applied to. -tipEdges LvArray_SortedArray< int, int, LvArray_ChaiBuffer > Set containing all the tip edges -tipFaces LvArray_SortedArray< int, int, LvArray_ChaiBuffer > Set containing all the tip faces -tipNodes LvArray_SortedArray< int, int, LvArray_ChaiBuffer > Set containing all the nodes at the fracture tip -trailingFaces LvArray_SortedArray< int, int, LvArray_ChaiBuffer > Set containing all the trailing faces -LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` -NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` -SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` -========================= ============================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== +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. +failCriterion integer (no description available) +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. +tipEdges LvArray_SortedArray Set containing all the tip edges +tipFaces LvArray_SortedArray Set containing all the tip faces +tipNodes LvArray_SortedArray Set containing all the nodes at the fracture tip +trailingFaces LvArray_SortedArray Set containing all the trailing faces +LinearSolverParameters node :ref:`DATASTRUCTURE_LinearSolverParameters` +NonlinearSolverParameters node :ref:`DATASTRUCTURE_NonlinearSolverParameters` +SolverStatistics node :ref:`DATASTRUCTURE_SolverStatistics` +========================= ====================================================================================================================================================== ======================================================================================================================================================================================================================================================================================================================== diff --git a/src/coreComponents/schema/docs/TableCapillaryPressure_other.rst b/src/coreComponents/schema/docs/TableCapillaryPressure_other.rst index d8e9f22248c..d4c775cae61 100644 --- a/src/coreComponents/schema/docs/TableCapillaryPressure_other.rst +++ b/src/coreComponents/schema/docs/TableCapillaryPressure_other.rst @@ -1,13 +1,13 @@ -=================================== ======================================================================================================= ============================================================================ -Name Type Description -=================================== ======================================================================================================= ============================================================================ -capPresWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -dPhaseCapPressure_dPhaseVolFraction real64_array4d Derivative of phase capillary pressure with respect to phase volume fraction -phaseCapPressure real64_array3d Phase capillary pressure -phaseOrder integer_array (no description available) -phaseTypes integer_array (no description available) -=================================== ======================================================================================================= ============================================================================ +=================================== =================================================================================================== ============================================================================ +Name Type Description +=================================== =================================================================================================== ============================================================================ +capPresWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +dPhaseCapPressure_dPhaseVolFraction real64_array4d Derivative of phase capillary pressure with respect to phase volume fraction +phaseCapPressure real64_array3d Phase capillary pressure +phaseOrder integer_array (no description available) +phaseTypes integer_array (no description available) +=================================== =================================================================================================== ============================================================================ diff --git a/src/coreComponents/schema/docs/TableRelativePermeabilityHysteresis_other.rst b/src/coreComponents/schema/docs/TableRelativePermeabilityHysteresis_other.rst index 1952771c2e9..f8e13266217 100644 --- a/src/coreComponents/schema/docs/TableRelativePermeabilityHysteresis_other.rst +++ b/src/coreComponents/schema/docs/TableRelativePermeabilityHysteresis_other.rst @@ -1,27 +1,27 @@ -================================ ======================================================================================================= =============================================================================== -Name Type Description -================================ ======================================================================================================= =============================================================================== -dPhaseRelPerm_dPhaseVolFraction real64_array4d Derivative of phase relative permeability with respect to phase volume fraction -drainagePhaseMaxVolumeFraction real64_array (no description available) -drainagePhaseMinVolumeFraction real64_array (no description available) -drainagePhaseRelPermEndPoint real64_array (no description available) -drainageRelPermWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -imbibitionPhaseMaxVolumeFraction real64_array (no description available) -imbibitionPhaseMinVolumeFraction real64_array (no description available) -imbibitionPhaseRelPermEndPoint real64_array (no description available) -imbibitionRelPermWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -landParameter real64_array (no description available) -phaseHasHysteresis integer_array (no description available) -phaseMaxHistoricalVolFraction real64_array2d Phase max historical phase volume fraction -phaseMinHistoricalVolFraction real64_array2d Phase min historical phase volume fraction -phaseOrder integer_array (no description available) -phaseRelPerm real64_array3d Phase relative permeability -phaseRelPerm_n real64_array3d Phase relative permeability at previous time -phaseTrappedVolFraction real64_array3d Phase trapped volume fraction -phaseTypes integer_array (no description available) -waterOilMaxRelPerm real64 (no description available) -================================ ======================================================================================================= =============================================================================== +================================ =================================================================================================== =============================================================================== +Name Type Description +================================ =================================================================================================== =============================================================================== +dPhaseRelPerm_dPhaseVolFraction real64_array4d Derivative of phase relative permeability with respect to phase volume fraction +drainagePhaseMaxVolumeFraction real64_array (no description available) +drainagePhaseMinVolumeFraction real64_array (no description available) +drainagePhaseRelPermEndPoint real64_array (no description available) +drainageRelPermWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +imbibitionPhaseMaxVolumeFraction real64_array (no description available) +imbibitionPhaseMinVolumeFraction real64_array (no description available) +imbibitionPhaseRelPermEndPoint real64_array (no description available) +imbibitionRelPermWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +landParameter real64_array (no description available) +phaseHasHysteresis integer_array (no description available) +phaseMaxHistoricalVolFraction real64_array2d Phase max historical phase volume fraction +phaseMinHistoricalVolFraction real64_array2d Phase min historical phase volume fraction +phaseOrder integer_array (no description available) +phaseRelPerm real64_array3d Phase relative permeability +phaseRelPerm_n real64_array3d Phase relative permeability at previous time +phaseTrappedVolFraction real64_array3d Phase trapped volume fraction +phaseTypes integer_array (no description available) +waterOilMaxRelPerm real64 (no description available) +================================ =================================================================================================== =============================================================================== diff --git a/src/coreComponents/schema/docs/TableRelativePermeability_other.rst b/src/coreComponents/schema/docs/TableRelativePermeability_other.rst index d71522f8a7a..4d6a2f00651 100644 --- a/src/coreComponents/schema/docs/TableRelativePermeability_other.rst +++ b/src/coreComponents/schema/docs/TableRelativePermeability_other.rst @@ -1,17 +1,17 @@ -=============================== ======================================================================================================= =============================================================================== -Name Type Description -=============================== ======================================================================================================= =============================================================================== -dPhaseRelPerm_dPhaseVolFraction real64_array4d Derivative of phase relative permeability with respect to phase volume fraction -phaseMinVolumeFraction real64_array (no description available) -phaseOrder integer_array (no description available) -phaseRelPerm real64_array3d Phase relative permeability -phaseRelPerm_n real64_array3d Phase relative permeability at previous time -phaseTrappedVolFraction real64_array3d Phase trapped volume fraction -phaseTypes integer_array (no description available) -relPermWrappers LvArray_Array< geos_TableFunction_KernelWrapper, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer > (no description available) -waterOilMaxRelPerm real64 (no description available) -=============================== ======================================================================================================= =============================================================================== +=============================== =================================================================================================== =============================================================================== +Name Type Description +=============================== =================================================================================================== =============================================================================== +dPhaseRelPerm_dPhaseVolFraction real64_array4d Derivative of phase relative permeability with respect to phase volume fraction +phaseMinVolumeFraction real64_array (no description available) +phaseOrder integer_array (no description available) +phaseRelPerm real64_array3d Phase relative permeability +phaseRelPerm_n real64_array3d Phase relative permeability at previous time +phaseTrappedVolFraction real64_array3d Phase trapped volume fraction +phaseTypes integer_array (no description available) +relPermWrappers LvArray_Array, int, LvArray_ChaiBuffer> (no description available) +waterOilMaxRelPerm real64 (no description available) +=============================== =================================================================================================== =============================================================================== diff --git a/src/coreComponents/schema/docs/TwoPointFluxApproximation_other.rst b/src/coreComponents/schema/docs/TwoPointFluxApproximation_other.rst index 9194c2431f9..a21d5757d0f 100644 --- a/src/coreComponents/schema/docs/TwoPointFluxApproximation_other.rst +++ b/src/coreComponents/schema/docs/TwoPointFluxApproximation_other.rst @@ -1,15 +1,15 @@ -======================== ========================================================================================================================================== ======================================== -Name Type Description -======================== ========================================================================================================================================== ======================================== -cellStencil geos_CellElementStencilTPFA (no description available) -coefficientName groupNameRef Name of coefficient field -edfmStencil geos_EmbeddedSurfaceToCellStencil (no description available) -faceElementToCellStencil geos_FaceElementToCellStencil (no description available) -fieldName groupNameRef_array Name of primary solution field -fractureStencil geos_SurfaceElementStencil (no description available) -targetRegions geos_mapBase< string, LvArray_Array< string, 1, camp_int_seq< long, 0l >, int, LvArray_ChaiBuffer >, std_integral_constant< bool, true > > List of regions to build the stencil for -======================== ========================================================================================================================================== ======================================== +======================== =================================================================================================================================== ======================================== +Name Type Description +======================== =================================================================================================================================== ======================================== +cellStencil geos_CellElementStencilTPFA (no description available) +coefficientName groupNameRef Name of coefficient field +edfmStencil geos_EmbeddedSurfaceToCellStencil (no description available) +faceElementToCellStencil geos_FaceElementToCellStencil (no description available) +fieldName groupNameRef_array Name of primary solution field +fractureStencil geos_SurfaceElementStencil (no description available) +targetRegions geos_mapBase, int, LvArray_ChaiBuffer>, std_integral_constant > List of regions to build the stencil for +======================== =================================================================================================================================== ======================================== diff --git a/src/coreComponents/schema/docs/WellElementRegionUniqueSubRegion_other.rst b/src/coreComponents/schema/docs/WellElementRegionUniqueSubRegion_other.rst index 3a4675201c0..eca5644ac14 100644 --- a/src/coreComponents/schema/docs/WellElementRegionUniqueSubRegion_other.rst +++ b/src/coreComponents/schema/docs/WellElementRegionUniqueSubRegion_other.rst @@ -1,29 +1,29 @@ -========================== ========================================================================================================== ========================================================= -Name Type Description -========================== ========================================================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -elementCenter real64_array2d (no description available) -elementVolume real64_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -nextWellElementIndex integer_array (no description available) -nextWellElementIndexGlobal integer_array (no description available) -nodeList geos_InterObjectRelation< LvArray_Array< int, 2, camp_int_seq< long, 0l, 1l >, int, LvArray_ChaiBuffer > > (no description available) -numEdgesPerElement integer (no description available) -numFacesPerElement integer (no description available) -numNodesPerElement integer (no description available) -radius real64_array (no description available) -topRank integer (no description available) -topWellElementIndex integer (no description available) -wellControlsName groupNameRef (no description available) -ConstitutiveModels node :ref:`DATASTRUCTURE_ConstitutiveModels` -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -wellElementSubRegion node :ref:`DATASTRUCTURE_wellElementSubRegion` -========================== ========================================================================================================== ========================================================= +========================== ===================================================================================================== ========================================================= +Name Type Description +========================== ===================================================================================================== ========================================================= +domainBoundaryIndicator integer_array (no description available) +elementCenter real64_array2d (no description available) +elementVolume real64_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +nextWellElementIndex integer_array (no description available) +nextWellElementIndexGlobal integer_array (no description available) +nodeList geos_InterObjectRelation, int, LvArray_ChaiBuffer> > (no description available) +numEdgesPerElement integer (no description available) +numFacesPerElement integer (no description available) +numNodesPerElement integer (no description available) +radius real64_array (no description available) +topRank integer (no description available) +topWellElementIndex integer (no description available) +wellControlsName groupNameRef (no description available) +ConstitutiveModels node :ref:`DATASTRUCTURE_ConstitutiveModels` +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +wellElementSubRegion node :ref:`DATASTRUCTURE_wellElementSubRegion` +========================== ===================================================================================================== ========================================================= diff --git a/src/coreComponents/schema/docs/WellElementRegion_other.rst b/src/coreComponents/schema/docs/WellElementRegion_other.rst index 7235a663f6d..bb655ec67d1 100644 --- a/src/coreComponents/schema/docs/WellElementRegion_other.rst +++ b/src/coreComponents/schema/docs/WellElementRegion_other.rst @@ -1,18 +1,18 @@ -======================= ==================================================================== ========================================================= -Name Type Description -======================= ==================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -wellControlsName groupNameRef (no description available) -wellGeneratorName groupNameRef (no description available) -elementSubRegions node :ref:`DATASTRUCTURE_elementSubRegions` -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= ==================================================================== ========================================================= +======================= ================================================================= ========================================================= +Name Type Description +======================= ================================================================= ========================================================= +domainBoundaryIndicator integer_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +wellControlsName groupNameRef (no description available) +wellGeneratorName groupNameRef (no description available) +elementSubRegions node :ref:`DATASTRUCTURE_elementSubRegions` +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ================================================================= ========================================================= diff --git a/src/coreComponents/schema/docs/domain_other.rst b/src/coreComponents/schema/docs/domain_other.rst index 18e678dae42..4cbdf6ffbda 100644 --- a/src/coreComponents/schema/docs/domain_other.rst +++ b/src/coreComponents/schema/docs/domain_other.rst @@ -1,12 +1,12 @@ -================ =================================================================================== ================================= -Name Type Description -================ =================================================================================== ================================= -Neighbors std_vector< geos_NeighborCommunicator, std_allocator< geos_NeighborCommunicator > > (no description available) -partitionManager geos_PartitionBase (no description available) -Constitutive node :ref:`DATASTRUCTURE_Constitutive` -MeshBodies node :ref:`DATASTRUCTURE_MeshBodies` -================ =================================================================================== ================================= +================ ================================================================================ ================================= +Name Type Description +================ ================================================================================ ================================= +Neighbors std_vector > (no description available) +partitionManager geos_PartitionBase (no description available) +Constitutive node :ref:`DATASTRUCTURE_Constitutive` +MeshBodies node :ref:`DATASTRUCTURE_MeshBodies` +================ ================================================================================ ================================= diff --git a/src/coreComponents/schema/docs/edgeManager_other.rst b/src/coreComponents/schema/docs/edgeManager_other.rst index 597da5bf9b8..0d02ec6d8c8 100644 --- a/src/coreComponents/schema/docs/edgeManager_other.rst +++ b/src/coreComponents/schema/docs/edgeManager_other.rst @@ -1,17 +1,17 @@ -======================= ========================================================================================================== ========================================================= -Name Type Description -======================= ========================================================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -faceList geos_InterObjectRelation< LvArray_ArrayOfSets< int, int, LvArray_ChaiBuffer > > (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -nodeList geos_InterObjectRelation< LvArray_Array< int, 2, camp_int_seq< long, 0l, 1l >, int, LvArray_ChaiBuffer > > (no description available) -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= ========================================================================================================== ========================================================= +======================= ===================================================================================================== ========================================================= +Name Type Description +======================= ===================================================================================================== ========================================================= +domainBoundaryIndicator integer_array (no description available) +faceList geos_InterObjectRelation > (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +nodeList geos_InterObjectRelation, int, LvArray_ChaiBuffer> > (no description available) +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ===================================================================================================== ========================================================= diff --git a/src/coreComponents/schema/docs/embeddedSurfacesEdgeManager_other.rst b/src/coreComponents/schema/docs/embeddedSurfacesEdgeManager_other.rst index 597da5bf9b8..0d02ec6d8c8 100644 --- a/src/coreComponents/schema/docs/embeddedSurfacesEdgeManager_other.rst +++ b/src/coreComponents/schema/docs/embeddedSurfacesEdgeManager_other.rst @@ -1,17 +1,17 @@ -======================= ========================================================================================================== ========================================================= -Name Type Description -======================= ========================================================================================================== ========================================================= -domainBoundaryIndicator integer_array (no description available) -faceList geos_InterObjectRelation< LvArray_ArrayOfSets< int, int, LvArray_ChaiBuffer > > (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -nodeList geos_InterObjectRelation< LvArray_Array< int, 2, camp_int_seq< long, 0l, 1l >, int, LvArray_ChaiBuffer > > (no description available) -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= ========================================================================================================== ========================================================= +======================= ===================================================================================================== ========================================================= +Name Type Description +======================= ===================================================================================================== ========================================================= +domainBoundaryIndicator integer_array (no description available) +faceList geos_InterObjectRelation > (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +nodeList geos_InterObjectRelation, int, LvArray_ChaiBuffer> > (no description available) +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ===================================================================================================== ========================================================= diff --git a/src/coreComponents/schema/docs/embeddedSurfacesNodeManager_other.rst b/src/coreComponents/schema/docs/embeddedSurfacesNodeManager_other.rst index 7c14a19c09a..3a3c4f725f8 100644 --- a/src/coreComponents/schema/docs/embeddedSurfacesNodeManager_other.rst +++ b/src/coreComponents/schema/docs/embeddedSurfacesNodeManager_other.rst @@ -1,22 +1,22 @@ -======================= =============================================================================== ============================================= ================================================================ -Name Type Registered By Description -======================= =============================================================================== ============================================= ================================================================ -domainBoundaryIndicator integer_array (no description available) -edgeList geos_InterObjectRelation< LvArray_ArrayOfSets< int, int, LvArray_ChaiBuffer > > (no description available) -elemList LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > (no description available) -elemRegionList LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > (no description available) -elemSubRegionList LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -parentEdgeGlobalIndex globalIndex_array (no description available) -referencePosition real64_array2d (no description available) -parentEdgeIndex integer_array :ref:`DATASTRUCTURE_EmbeddedSurfaceGenerator` Index of parent edge within the mesh object it is registered on. -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= =============================================================================== ============================================= ================================================================ +======================= ============================================================================ ============================================= ================================================================ +Name Type Registered By Description +======================= ============================================================================ ============================================= ================================================================ +domainBoundaryIndicator integer_array (no description available) +edgeList geos_InterObjectRelation > (no description available) +elemList LvArray_ArrayOfArrays (no description available) +elemRegionList LvArray_ArrayOfArrays (no description available) +elemSubRegionList LvArray_ArrayOfArrays (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +parentEdgeGlobalIndex globalIndex_array (no description available) +referencePosition real64_array2d (no description available) +parentEdgeIndex integer_array :ref:`DATASTRUCTURE_EmbeddedSurfaceGenerator` Index of parent edge within the mesh object it is registered on. +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ============================================================================ ============================================= ================================================================ diff --git a/src/coreComponents/schema/docs/faceManager_other.rst b/src/coreComponents/schema/docs/faceManager_other.rst index f821f295cfd..7f1730f0304 100644 --- a/src/coreComponents/schema/docs/faceManager_other.rst +++ b/src/coreComponents/schema/docs/faceManager_other.rst @@ -1,25 +1,25 @@ -======================= ================================================================================= ================================================================================================ ========================================================= -Name Type Registered By Description -======================= ================================================================================= ================================================================================================ ========================================================= -domainBoundaryIndicator integer_array (no description available) -edgeList geos_InterObjectRelation< LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > > (no description available) -elemList integer_array2d (no description available) -elemRegionList integer_array2d (no description available) -elemSubRegionList integer_array2d (no description available) -faceArea real64_array (no description available) -faceCenter real64_array2d (no description available) -faceNormal real64_array2d (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -nodeList geos_InterObjectRelation< LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > > (no description available) -facePressure_n real64_array :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM`, :ref:`DATASTRUCTURE_SinglePhaseHybridFVM` Face pressure at the previous converged time step -mimGravityCoefficient real64_array :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM` Mimetic gravity coefficient -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= ================================================================================= ================================================================================================ ========================================================= +======================= ============================================================================== ================================================================================================ ========================================================= +Name Type Registered By Description +======================= ============================================================================== ================================================================================================ ========================================================= +domainBoundaryIndicator integer_array (no description available) +edgeList geos_InterObjectRelation > (no description available) +elemList integer_array2d (no description available) +elemRegionList integer_array2d (no description available) +elemSubRegionList integer_array2d (no description available) +faceArea real64_array (no description available) +faceCenter real64_array2d (no description available) +faceNormal real64_array2d (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +nodeList geos_InterObjectRelation > (no description available) +facePressure_n real64_array :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM`, :ref:`DATASTRUCTURE_SinglePhaseHybridFVM` Face pressure at the previous converged time step +mimGravityCoefficient real64_array :ref:`DATASTRUCTURE_CompositionalMultiphaseHybridFVM` Mimetic gravity coefficient +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ============================================================================== ================================================================================================ ========================================================= diff --git a/src/coreComponents/schema/docs/nodeManager_other.rst b/src/coreComponents/schema/docs/nodeManager_other.rst index e4fa1245fee..cde3077884e 100644 --- a/src/coreComponents/schema/docs/nodeManager_other.rst +++ b/src/coreComponents/schema/docs/nodeManager_other.rst @@ -1,22 +1,22 @@ -======================= =============================================================================== ========================================================= -Name Type Description -======================= =============================================================================== ========================================================= -ReferencePosition real64_array2d (no description available) -domainBoundaryIndicator integer_array (no description available) -edgeList geos_InterObjectRelation< LvArray_ArrayOfSets< int, int, LvArray_ChaiBuffer > > (no description available) -elemList LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > (no description available) -elemRegionList LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > (no description available) -elemSubRegionList LvArray_ArrayOfArrays< int, int, LvArray_ChaiBuffer > (no description available) -faceList geos_InterObjectRelation< LvArray_ArrayOfSets< int, int, LvArray_ChaiBuffer > > (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -primaryField real64_array Primary field variable -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -======================= =============================================================================== ========================================================= +======================= ============================================================================ ========================================================= +Name Type Description +======================= ============================================================================ ========================================================= +ReferencePosition real64_array2d (no description available) +domainBoundaryIndicator integer_array (no description available) +edgeList geos_InterObjectRelation > (no description available) +elemList LvArray_ArrayOfArrays (no description available) +elemRegionList LvArray_ArrayOfArrays (no description available) +elemSubRegionList LvArray_ArrayOfArrays (no description available) +faceList geos_InterObjectRelation > (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +primaryField real64_array Primary field variable +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +======================= ============================================================================ ========================================================= diff --git a/src/coreComponents/schema/docs/sets_other.rst b/src/coreComponents/schema/docs/sets_other.rst index 07baf6428bc..59e718c41f8 100644 --- a/src/coreComponents/schema/docs/sets_other.rst +++ b/src/coreComponents/schema/docs/sets_other.rst @@ -1,9 +1,9 @@ -=========== =================================================== ========================== -Name Type Description -=========== =================================================== ========================== -externalSet LvArray_SortedArray< int, int, LvArray_ChaiBuffer > (no description available) -=========== =================================================== ========================== +=========== ================================================= ========================== +Name Type Description +=========== ================================================= ========================== +externalSet LvArray_SortedArray (no description available) +=========== ================================================= ========================== diff --git a/src/coreComponents/schema/docs/wellElementSubRegion_other.rst b/src/coreComponents/schema/docs/wellElementSubRegion_other.rst index 13799ea3e78..6ceeee5546c 100644 --- a/src/coreComponents/schema/docs/wellElementSubRegion_other.rst +++ b/src/coreComponents/schema/docs/wellElementSubRegion_other.rst @@ -1,23 +1,23 @@ -========================= ==================================================================== ====================================================================== -Name Type Description -========================= ==================================================================== ====================================================================== -domainBoundaryIndicator integer_array (no description available) -ghostRank integer_array (no description available) -globalToLocalMap geos_mapBase< long long, int, std_integral_constant< bool, false > > (no description available) -isExternal integer_array (no description available) -localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. -location real64_array2d For each perforation, physical location (x,y,z coordinates) -numPerforationsGlobal globalIndex (no description available) -reservoirElementIndex integer_array For each perforation, element index of the perforated element -reservoirElementRegion integer_array For each perforation, elementRegion index of the perforated element -reservoirElementSubregion integer_array For each perforation, elementSubRegion index of the perforated element -wellElementIndex integer_array For each perforation, index of the well element -wellSkinFactor real64_array For each perforation, well skin factor -wellTransmissibility real64_array For each perforation, well transmissibility -neighborData node :ref:`DATASTRUCTURE_neighborData` -sets node :ref:`DATASTRUCTURE_sets` -========================= ==================================================================== ====================================================================== +========================= ================================================================= ====================================================================== +Name Type Description +========================= ================================================================= ====================================================================== +domainBoundaryIndicator integer_array (no description available) +ghostRank integer_array (no description available) +globalToLocalMap geos_mapBase > (no description available) +isExternal integer_array (no description available) +localToGlobalMap globalIndex_array Array that contains a map from localIndex to globalIndex. +location real64_array2d For each perforation, physical location (x,y,z coordinates) +numPerforationsGlobal globalIndex (no description available) +reservoirElementIndex integer_array For each perforation, element index of the perforated element +reservoirElementRegion integer_array For each perforation, elementRegion index of the perforated element +reservoirElementSubregion integer_array For each perforation, elementSubRegion index of the perforated element +wellElementIndex integer_array For each perforation, index of the well element +wellSkinFactor real64_array For each perforation, well skin factor +wellTransmissibility real64_array For each perforation, well transmissibility +neighborData node :ref:`DATASTRUCTURE_neighborData` +sets node :ref:`DATASTRUCTURE_sets` +========================= ================================================================= ====================================================================== diff --git a/src/coreComponents/schema/schema.xsd b/src/coreComponents/schema/schema.xsd index 1f6363b218c..965cf0f3546 100644 --- a/src/coreComponents/schema/schema.xsd +++ b/src/coreComponents/schema/schema.xsd @@ -2802,6 +2802,8 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> + + @@ -2813,6 +2815,11 @@ Equal to 1 for surface conditions, and to 0 for reservoir conditions--> + + + + + diff --git a/src/coreComponents/schema/schema.xsd.other b/src/coreComponents/schema/schema.xsd.other index c4c0af4cf3e..a9095627224 100644 --- a/src/coreComponents/schema/schema.xsd.other +++ b/src/coreComponents/schema/schema.xsd.other @@ -471,7 +471,7 @@ - + @@ -550,7 +550,7 @@ - + @@ -587,7 +587,7 @@ - + @@ -638,7 +638,7 @@ - + @@ -679,7 +679,7 @@ - + @@ -712,7 +712,7 @@ - + @@ -723,7 +723,7 @@ - + @@ -736,7 +736,7 @@ - + @@ -749,7 +749,7 @@ - + @@ -765,7 +765,7 @@ - + @@ -799,7 +799,7 @@ - + @@ -862,7 +862,7 @@ - + @@ -893,7 +893,7 @@ - + @@ -906,7 +906,7 @@ - + @@ -919,7 +919,7 @@ - + @@ -932,7 +932,7 @@ - + @@ -945,7 +945,7 @@ - + @@ -960,7 +960,7 @@ - + @@ -971,7 +971,7 @@ - + @@ -984,7 +984,7 @@ - + @@ -995,7 +995,7 @@ - + @@ -1006,7 +1006,7 @@ - + @@ -1017,7 +1017,7 @@ - + @@ -1028,7 +1028,7 @@ - + @@ -1041,7 +1041,7 @@ - + @@ -1056,7 +1056,7 @@ - + @@ -1071,7 +1071,7 @@ - + @@ -1086,7 +1086,7 @@ - + @@ -1097,7 +1097,7 @@ - + @@ -1110,7 +1110,7 @@ - + @@ -1123,7 +1123,7 @@ - + @@ -1139,7 +1139,7 @@ - + @@ -1154,7 +1154,7 @@ - + @@ -1171,7 +1171,7 @@ - + @@ -1186,7 +1186,7 @@ - + @@ -1199,7 +1199,7 @@ - + @@ -1238,7 +1238,7 @@ - + @@ -1267,15 +1267,15 @@ - + - + - + - + - + @@ -1339,7 +1339,7 @@ - + @@ -1459,7 +1459,7 @@ - + @@ -1475,7 +1475,7 @@ - + @@ -1511,7 +1511,7 @@ - + @@ -1575,7 +1575,7 @@ - + @@ -1621,7 +1621,7 @@ - + @@ -1667,7 +1667,7 @@ - + @@ -1713,7 +1713,7 @@ - + @@ -1787,7 +1787,7 @@ - + @@ -1833,7 +1833,7 @@ - + @@ -1879,7 +1879,7 @@ - + @@ -2039,7 +2039,7 @@ - + @@ -2055,7 +2055,7 @@ - + @@ -2091,7 +2091,7 @@ - + @@ -2268,7 +2268,7 @@ - + @@ -2479,7 +2479,7 @@ - + @@ -2533,7 +2533,7 @@ - + @@ -2607,7 +2607,7 @@ - + @@ -2633,7 +2633,7 @@ - + @@ -2647,7 +2647,7 @@ - + @@ -2655,7 +2655,7 @@ - + @@ -2879,7 +2879,7 @@ - + @@ -2889,7 +2889,7 @@ - + @@ -2903,7 +2903,7 @@ - + @@ -2918,17 +2918,17 @@ - + - + - + @@ -2938,17 +2938,17 @@ - + - + - + @@ -2958,17 +2958,17 @@ - + - + - + - + - + @@ -2988,7 +2988,7 @@ - + @@ -3006,7 +3006,7 @@ - + @@ -3014,7 +3014,7 @@ - + @@ -3026,19 +3026,19 @@ - + - + - + - + - + - + @@ -3057,7 +3057,7 @@ - + @@ -3079,7 +3079,7 @@ - + @@ -3096,7 +3096,7 @@ - + @@ -3122,7 +3122,7 @@ - + @@ -3132,7 +3132,7 @@ - + @@ -3159,7 +3159,7 @@ - + @@ -3192,7 +3192,7 @@ - + diff --git a/src/coreComponents/schema/schemaUtilities.cpp b/src/coreComponents/schema/schemaUtilities.cpp index 93eb8ce0f7e..4bf19a4541d 100644 --- a/src/coreComponents/schema/schemaUtilities.cpp +++ b/src/coreComponents/schema/schemaUtilities.cpp @@ -76,9 +76,15 @@ string getSchemaTypeName( string_view rtTypeName ) // Note: Some type names involving strings can vary on compiler and be ugly. Convert these to "string" auto constexpr typeMergingRegex = "std_(__cxx11_basic_)?string(<\\s*char,\\s*std_char_traits,\\s*std_allocator\\s*>)?"; - string const xmlSafeName = std::regex_replace( sanitizedName, - std::regex( typeMergingRegex ), - "string" ); + string xmlSafeName = std::regex_replace( sanitizedName, + std::regex( typeMergingRegex ), + "string" ); + + // Replace '<', '>', spaces and ',' because the schema does not like them + xmlSafeName = std::regex_replace( xmlSafeName, std::regex( "<" ), "_lt_" ); + xmlSafeName = std::regex_replace( xmlSafeName, std::regex( ">" ), "_gt_" ); + xmlSafeName = std::regex_replace( xmlSafeName, std::regex( "," ), "_cm_" ); + xmlSafeName = std::regex_replace( xmlSafeName, std::regex( " " ), "-" ); return xmlSafeName; }