GEOS
SinglePhaseReservoirFVM.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 Total, S.A
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
20 #ifndef GEOS_LINEARALGEBRA_INTERFACES_HYPREMGRSINGLEPHASERESERVOIRFVM_HPP_
21 #define GEOS_LINEARALGEBRA_INTERFACES_HYPREMGRSINGLEPHASERESERVOIRFVM_HPP_
22 
24 
25 namespace geos
26 {
27 
28 namespace hypre
29 {
30 
31 namespace mgr
32 {
33 
49 {
50 public:
55  : MGRStrategyBase( LvArray::integerConversion< HYPRE_Int >( 3 ) )
56  {
57  // Level 0: eliminate the well variables, and just keep the cell-centered pressures
58  m_labels[0].push_back( 0 );
59 
60  setupLabels();
61 
62  // Level 0
64  m_levelFRelaxIters[0] = 1;
69  }
70 
77  void setup( LinearSolverParameters::MGR const & mgrParams,
78  HyprePrecWrapper & precond,
79  HypreMGRData & mgrData )
80  {
81  // if the wells are shut, using Gaussian elimination as F-relaxation for the well block is an overkill
82  // in that case, we just use Jacobi
83  if( mgrParams.areWellsShut )
84  {
86  }
87 
88  setReduction( precond, mgrData );
89 
90  // Configure the BoomerAMG solver used as mgr coarse solver for the pressure reduced system
91  setPressureAMG( mgrData.coarseSolver );
92  }
93 };
94 
95 } // namespace mgr
96 
97 } // namespace hypre
98 
99 } // namespace geos
100 
101 #endif /*GEOS_LINEARALGEBRA_INTERFACES_HYPREMGRSINGLEPHASERESERVOIRFVM_HPP_*/
Helper struct for strategies that provides some basic parameter arrays needed by MGR.
Definition: HypreMGR.hpp:74
MGRCoarseGridMethod m_levelCoarseGridMethod[numLevels]
Coarse grid method for each level.
Definition: HypreMGR.hpp:91
MGRInterpolationType m_levelInterpType[numLevels]
Interpolation type for each level.
Definition: HypreMGR.hpp:89
std::vector< HYPRE_Int > m_labels[numLevels]
Dof labels kept at each level.
Definition: HypreMGR.hpp:83
void setupLabels()
Call this after populating lv_cindexes.
Definition: HypreMGR.hpp:121
HYPRE_Int m_levelFRelaxIters[numLevels]
Number of F-relaxation iterations for each level.
Definition: HypreMGR.hpp:88
void setPressureAMG(HyprePrecWrapper &solver)
Set up BoomerAMG to perform the solve for the pressure system.
Definition: HypreMGR.hpp:204
void setReduction(HyprePrecWrapper &precond, HypreMGRData &mgrData)
Helper function that sets the reduction features common to all mgr strategies.
Definition: HypreMGR.hpp:135
MGRFRelaxationType m_levelFRelaxType[numLevels]
F-relaxation type for each level.
Definition: HypreMGR.hpp:87
MGRGlobalSmootherType m_levelGlobalSmootherType[numLevels]
Global smoother type for each level.
Definition: HypreMGR.hpp:92
MGRRestrictionType m_levelRestrictType[numLevels]
Restriction type for each level.
Definition: HypreMGR.hpp:90
SinglePhaseReservoirFVM(arrayView1d< int const > const &)
Constructor.
void setup(LinearSolverParameters::MGR const &mgrParams, HyprePrecWrapper &precond, HypreMGRData &mgrData)
Setup the MGR strategy.
@ galerkin
Galerkin coarse grid computation using RAP.
@ gsElimWInverse
Direct Inversion with Gaussian Elimination (OK for larger systems)
@ none
no global smoothing is performed (default)
ArrayView< T, 1 > arrayView1d
Alias for 1D array view.
Definition: DataTypes.hpp:180
Container for hypre preconditioner auxiliary data for MGR.
Definition: HypreMGR.hpp:38
HyprePrecWrapper coarseSolver
MGR coarse solver pointer and functions.
Definition: HypreMGR.hpp:40
Container for hypre preconditioner function pointers.
Definition: HypreUtils.hpp:54
Multigrid reduction parameters.