GEOS
Classes | Namespaces | Functions | Variables
HypreMGR.hpp File Reference
#include "linearAlgebra/common/common.hpp"
#include "linearAlgebra/DofManager.hpp"
#include "linearAlgebra/interfaces/hypre/HypreUtils.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"
#include <_hypre_utilities.h>

Go to the source code of this file.

Classes

struct  geos::HypreMGRData
 Container for hypre preconditioner auxiliary data for MGR. More...
 
struct  geos::hypre::mgr::MGRParameters
 MGR settings shared by the legacy HYPRE setup and generated YAML. More...
 
struct  geos::hypre::mgr::BoomerAMGParameters
 The BoomerAMG options used by the MGR strategies. More...
 
class  geos::hypre::mgr::MGRStrategyBase< NLEVEL >
 Helper struct for strategies that provides some basic parameter arrays needed by MGR. More...
 

Namespaces

 geos
 
 geos::hypre
 Contains some hypre-specific functions.
 

Functions

MGRParameters geos::hypre::mgr::defaultMGRParameters ()
 
void geos::hypre::mgr::setMGRCycleSettings (HYPRE_Solver const solver, MGRParameters const &params=defaultMGRParameters())
 
BoomerAMGParameters geos::hypre::mgr::displacementAMGParameters (integer const separateComponents, bool const filterFunctions, bool const useALMSmoother=false)
 
BoomerAMGParameters geos::hypre::mgr::almBubbleAMGParameters ()
 
BoomerAMGParameters geos::hypre::mgr::almReservoirDisplacementAMGParameters (integer const separateComponents)
 
BoomerAMGParameters geos::hypre::mgr::pressureAMGParameters (HYPRE_Int const minCoarseSize=-1)
 
BoomerAMGParameters geos::hypre::mgr::pressureTemperatureAMGParameters ()
 
void geos::hypre::mgr::configureBoomerAMG (HyprePrecWrapper &solver, BoomerAMGParameters const &params)
 
template<typename STRATEGY >
void geos::hypre::mgr::setStrategy (LinearSolverParameters::MGR const &params, arrayView1d< int const > const &numComponentsPerField, HyprePrecWrapper &precond, HypreMGRData &mgrData)
 Helper to simplify MGR setup. More...
 
void geos::hypre::mgr::createMGR (LinearSolverParameters const &params, DofManager const *const dofManager, HyprePrecWrapper &precond, HypreMGRData &mgrData)
 Create the MGR preconditioner object. More...
 

Variables

constexpr HYPRE_Int geos::hypre::mgr::hydrofractureMinCoarseSize = 1000
 

Function Documentation

◆ createMGR()

void geos::hypre::mgr::createMGR ( LinearSolverParameters const &  params,
DofManager const *const  dofManager,
HyprePrecWrapper precond,
HypreMGRData mgrData 
)

Create the MGR preconditioner object.

Parameters
paramspreconditioner parameters
dofManagerpointer to DofManager for the linear system
precondthe preconditioner
mgrDataauxiliary data for MGR

◆ setStrategy()

template<typename STRATEGY >
void geos::hypre::mgr::setStrategy ( LinearSolverParameters::MGR const &  params,
arrayView1d< int const > const &  numComponentsPerField,
HyprePrecWrapper precond,
HypreMGRData mgrData 
)

Helper to simplify MGR setup.

Template Parameters
STRATEGYstrategy class (one of structs defined below)
Parameters
paramsMGR parameters
numComponentsPerFieldarray containing number of components in each field
precondthe preconditioner wrapper
mgrDataadditional MGR data struct with marker array populated

Definition at line 329 of file HypreMGR.hpp.