GEOS
PetscInterface.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_PETSCINTERFACE_HPP_
21 #define GEOS_LINEARALGEBRA_INTERFACES_PETSCINTERFACE_HPP_
22 
23 #include "linearAlgebra/interfaces/petsc/PetscVector.hpp"
24 #include "linearAlgebra/interfaces/petsc/PetscMatrix.hpp"
25 #include "linearAlgebra/common/PreconditionerBase.hpp"
26 #include "linearAlgebra/common/LinearSolverBase.hpp"
27 
28 #include <memory>
29 
30 namespace geos
31 {
32 
37 struct PetscInterface
38 {
42  static void initialize();
43 
47  static void finalize();
48 
54  static std::unique_ptr< LinearSolverBase< PetscInterface > >
55  createSolver( LinearSolverParameters params );
56 
62  static std::unique_ptr< PreconditionerBase< PetscInterface > >
63  createPreconditioner( LinearSolverParameters params );
64 
71  static std::unique_ptr< PreconditionerBase< PetscInterface > >
72  createPreconditioner( LinearSolverParameters params,
73  array1d< PetscVector > const & nearNullKernel );
74 
76  using ParallelMatrix = PetscMatrix;
78  using ParallelVector = PetscVector;
79 };
80 
81 } /* namespace geos */
82 
83 #endif /*GEOS_LINEARALGEBRA_INTERFACES_PETSCINTERFACE_HPP_*/
geos::PetscMatrix
This class creates and provides basic support for the Mat matrix object type used in PETSc.
Definition: PetscMatrix.hpp:51
geos::PetscVector
This class creates and provides basic support for Vec vector object type used in PETSc.
Definition: PetscVector.hpp:46
geos::array1d
Array< T, 1 > array1d
Alias for 1D array.
Definition: DataTypes.hpp:176
geos::LinearSolverParameters
Set of parameters for a linear solver or preconditioner.
Definition: LinearSolverParameters.hpp:35
geos::PetscInterface
This class holds aliases based on the Petsc library.
Definition: PetscInterface.hpp:38
geos::PetscInterface::finalize
static void finalize()
Finalizes the Petsc library.
geos::PetscInterface::initialize
static void initialize()
Initializes the Petsc library.
geos::PetscInterface::createSolver
static std::unique_ptr< LinearSolverBase< PetscInterface > > createSolver(LinearSolverParameters params)
Create a petsc-based solver object.
geos::PetscInterface::createPreconditioner
static std::unique_ptr< PreconditionerBase< PetscInterface > > createPreconditioner(LinearSolverParameters params)
Create a PETSc-based preconditioner object.
geos::PetscInterface::createPreconditioner
static std::unique_ptr< PreconditionerBase< PetscInterface > > createPreconditioner(LinearSolverParameters params, array1d< PetscVector > const &nearNullKernel)
Create a PETSc-based preconditioner object.
Generated by doxygen 1.9.1