PetscSolver.h 4.45 KB
Newer Older
1
2
3
4
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
5
// ==  http://www.amdis-fem.org                                              ==
6
7
// ==                                                                        ==
// ============================================================================
8
9
10
11
12
13
14
15
16
17
18
19
//
// Software License for AMDiS
//
// Copyright (c) 2010 Dresden University of Technology 
// All rights reserved.
// Authors: Simon Vey, Thomas Witkowski et al.
//
// This file is part of AMDiS
//
// See also license.opensource.txt in the distribution.


20

Thomas Witkowski's avatar
Thomas Witkowski committed
21
/** \file PetscSolver.h */
22

23
24
#ifndef AMDIS_PETSC_SOLVER_H
#define AMDIS_PETSC_SOLVER_H
25

26
27
28
29
#include <set>
#include <map>
#include <mpi.h>

30
31
#include "AMDiS_fwd.h"
#include "Global.h"
32
#include "Initfile.h"
33
34
35
#include "DOFMatrix.h"
#include "parallel/MeshDistributor.h"

36
37
38
#include <petsc.h>
#include <petscsys.h>
#include <petscao.h>
39
#include <petscksp.h>
40
41
42

namespace AMDiS {

43
44
  using namespace std;

45

46
47
  class PetscSolver
  {
48
  public:
49
    PetscSolver();
50

51
    virtual ~PetscSolver() {}
52

53
54
55
    void setMeshDistributor(MeshDistributor *m)
    {
      meshDistributor = m;
56
      mpiRank = meshDistributor->getMpiRank();
57
58
      mpiComm = meshDistributor->getMpiComm();
      mpiSelfComm = PETSC_COMM_SELF;
59
60
    }

61
    /** \brief
62
63
     * Create a PETSc matrix. The given DOF matrices are used to create the nnz 
     * structure of the PETSc matrix and the values are transfered to it.
64
65
     *
     * \param[in] mat
66
67
68
69
70
71
     */
    virtual void fillPetscMatrix(Matrix<DOFMatrix*> *mat) = 0;

    /** \brief
     * Create a PETSc vector and fills it with the rhs values of the system.
     *
72
73
     * \param[in] vec
     */
74
    virtual void fillPetscRhs(SystemVector *vec) = 0;
75

76
77
    /// Use PETSc to solve the linear system of equations
    virtual void solvePetscMatrix(SystemVector &vec, AdaptInfo *adaptInfo) = 0;
78

79
80
81
    /// Destroys all matrix data structures.
    virtual void destroyMatrixData() = 0;

Thomas Witkowski's avatar
Thomas Witkowski committed
82
83
84
85
86
    virtual Flag getBoundaryDofRequirement()
    {
      return 0;
    }

87
88
89
90
    KSP getSolver() 
    { 
      return solver; 
    }
91

92
93
94
95
    PC getPc() 
    { 
      return pc; 
    }
96

97
98
99
100
101
    void setKspPrefix(std::string s)
    {
      kspPrefix = s;
    }

102
103
104
105
106
    void setRemoveRhsNullSpace(bool b)
    {
      removeRhsNullSpace = b;
    }

107
108
109
110
111
  protected:
    void printSolutionInfo(AdaptInfo* adaptInfo,
			   bool iterationCounter = true,
			   bool residual = true);

112
113
114
115
116
117
118
119
120
121
122
123
124
125
    /** \brief
     * Copies between to PETSc vectors by using different index sets for the
     * origin and the destination vectors.
     *
     * \param[in]   originVec    The PETSc vector from which we copy from.
     * \param[out]  destVec      The PETSc vector we copy too.
     * \param[in]   originIndex  Set of global indices referring to the 
     *                           origin vector.
     * \param[in]   destIndex    Set of global indices referring to the
     *                           destination vector.
     */
    void copyVec(Vec& originVec, Vec& destVec, 
		 vector<int>& originIndex, vector<int>& destIndex);

126
127
128
129
130
131
132
133
134
135
    /// Checks if all given FE spaces are handled by the mesh distributor.
    void checkFeSpaces(vector<const FiniteElemSpace*>& feSpaces);

    /// Returns a vector with the FE spaces of each row in the matrix. Thus, the
    /// resulting vector may contain the same FE space multiple times.
    vector<const FiniteElemSpace*> getFeSpaces(Matrix<DOFMatrix*> *mat);

    /// Returns a vector with the FE spaces of all components of a system vector.
    vector<const FiniteElemSpace*> getFeSpaces(SystemVector *vec);

136
  protected:
137
    MeshDistributor *meshDistributor;
138
139
    
    int mpiRank;
140

141
142
143
    MPI::Intracomm mpiComm;

    MPI::Intracomm mpiSelfComm;
144

145
146
147
    /// Petsc's matrix structure.
    Mat petscMatrix;

148
149
    /// PETSc's vector structures for the rhs vector, the solution vector and a
    /// temporary vector for calculating the final residuum.
150
151
    Vec petscRhsVec, petscSolVec, petscTmpVec;

152
    /// PETSc solver object
153
154
    KSP solver;

155
    /// PETSc preconditioner object
156
    PC pc;
157
158
159

    /// KSP database prefix
    string kspPrefix;
160
161
162
163

    /// If true, the constant null space is projected out of the RHS vector. It
    /// depends on the specific PETSc solver if it considers this value.
    bool removeRhsNullSpace;
164
165
  };

166

167
} // namespace AMDiS
168
169

#endif