escript  Revision_
Preconditioner.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2020 by The University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Apache License, version 2.0
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014-2017 by Centre for Geoscience Computing (GeoComp)
14 * Development from 2019 by School of Earth and Environmental Sciences
15 **
16 *****************************************************************************/
17 
18 #ifndef __PASO_PRECONDITIONER_H__
19 #define __PASO_PRECONDITIONER_H__
20 
21 #include "Paso.h"
22 #include "SystemMatrix.h"
23 
24 namespace paso {
25 
26 struct MergedSolver;
27 struct Preconditioner;
28 typedef boost::shared_ptr<Preconditioner> Preconditioner_ptr;
29 typedef boost::shared_ptr<const Preconditioner> const_Preconditioner_ptr;
30 
31 struct Preconditioner_Smoother;
32 struct Solver_ILU;
33 struct Solver_RILU;
34 
35 // general preconditioner interface
36 struct Preconditioner
37 {
38  dim_t type;
45  Solver_ILU* ilu;
48 };
49 
52 void Preconditioner_solve(Preconditioner* prec, SystemMatrix_ptr A, double*, double*);
53 
54 
55 // GAUSS SEIDEL & Jacobi
57 {
58  bool Jacobi;
59  double* diag;
60  double* buffer;
61  index_t* pivot;
62 };
63 
65 {
67  bool is_local;
68 };
69 
72 
74  SystemMatrix_ptr A, bool jacobi, bool is_local, bool verbose);
75 
77  SparseMatrix_ptr A, bool jacobi, bool verbose);
78 
80  Preconditioner_Smoother* gs, double* x, const double* b,
81  dim_t sweeps, bool x_is_initial);
82 
84  Preconditioner_LocalSmoother* gs, double* x, const double* b,
85  dim_t sweeps, bool x_is_initial);
86 
88  Preconditioner_Smoother* gs, double* x, const double* b,
89  double atol, dim_t* sweeps, bool x_is_initial);
90 
92  Preconditioner_LocalSmoother* gs, double* x);
93 
96  double* x);
97 
99  Preconditioner_LocalSmoother* gs, double* x);
100 
102  Preconditioner_LocalSmoother* gs, double* x);
103 
105 struct Solver_ILU
106 {
107  double* factors;
108 };
109 
111 struct Solver_RILU
112 {
113  dim_t n;
114  dim_t n_block;
115  dim_t n_F;
116  dim_t n_C;
117  double* inv_A_FF;
124  index_t* mask_C;
125  double* x_F;
126  double* b_F;
127  double* x_C;
128  double* b_C;
130 };
131 
134 void Solver_solveILU(SparseMatrix_ptr A, Solver_ILU* ilu, double* x, const double* b);
135 
138 void Solver_solveRILU(Solver_RILU* rilu, double* x, double* b);
139 
141  SparseMatrix_ptr A_CF, double* invA_FF, index_t* A_FF_pivot,
142  SparseMatrix_ptr A_FC);
143 
144 } // namespace paso
145 
146 #endif // __PASO_PRECONDITIONER_H__
147 
paso::Solver_RILU::mask_C
index_t * mask_C
Definition: Preconditioner.h:136
paso::Solver_RILU::n_block
dim_t n_block
Definition: Preconditioner.h:126
paso::Solver_RILU::n
dim_t n
Definition: Preconditioner.h:125
paso::Solver_RILU::n_C
dim_t n_C
Definition: Preconditioner.h:128
paso::Solver_getILU
Solver_ILU * Solver_getILU(SparseMatrix_ptr A, bool verbose)
constructs the incomplete block factorization
Definition: ILU.cpp:57
paso::Preconditioner_LocalSmoother_alloc
Preconditioner_LocalSmoother * Preconditioner_LocalSmoother_alloc(SparseMatrix_ptr A, bool jacobi, bool verbose)
Definition: Smoother.cpp:77
paso::Preconditioner_Smoother_free
void Preconditioner_Smoother_free(Preconditioner_Smoother *in)
Definition: Smoother.cpp:47
paso::Preconditioner_LocalSmoother::Jacobi
bool Jacobi
Definition: Preconditioner.h:70
paso::Preconditioner::type
dim_t type
Definition: Preconditioner.h:50
paso::Preconditioner_LocalSmoother_Sweep_tiled
void Preconditioner_LocalSmoother_Sweep_tiled(SparseMatrix_ptr A, Preconditioner_LocalSmoother *gs, double *x)
PASO_RILU
#define PASO_RILU
Definition: Options.h:63
paso::Solver_RILU::b_F
double * b_F
Definition: Preconditioner.h:138
paso::const_Preconditioner_ptr
boost::shared_ptr< const Preconditioner > const_Preconditioner_ptr
Definition: Preconditioner.h:41
PASO_ILU0
#define PASO_ILU0
Definition: Options.h:44
paso::Solver_RILU::b_C
double * b_C
Definition: Preconditioner.h:140
paso::SystemMatrix_ptr
boost::shared_ptr< SystemMatrix > SystemMatrix_ptr
Definition: SystemMatrix.h:53
paso::Solver_ILU
ILU preconditioner.
Definition: Preconditioner.h:117
paso::Preconditioner::rilu
Solver_RILU * rilu
RILU preconditioner.
Definition: Preconditioner.h:59
paso::Preconditioner::jacobi
Preconditioner_Smoother * jacobi
Jacobi preconditioner.
Definition: Preconditioner.h:53
paso::Preconditioner::gs
Preconditioner_Smoother * gs
Gauss-Seidel preconditioner.
Definition: Preconditioner.h:55
PASO_NO_PRECONDITIONER
#define PASO_NO_PRECONDITIONER
Definition: Options.h:65
paso::Solver_RILU_free
void Solver_RILU_free(Solver_RILU *in)
Definition: RILU.cpp:49
Options.h
paso::Preconditioner_LocalSmoother::diag
double * diag
Definition: Preconditioner.h:71
paso::Preconditioner_Smoother::localSmoother
Preconditioner_LocalSmoother * localSmoother
Definition: Preconditioner.h:78
paso::Solver_RILU::n_F
dim_t n_F
Definition: Preconditioner.h:127
paso::Solver_updateIncompleteSchurComplement
void Solver_updateIncompleteSchurComplement(SparseMatrix_ptr A_CC, SparseMatrix_ptr A_CF, double *invA_FF, index_t *A_FF_pivot, SparseMatrix_ptr A_FC)
Definition: SchurComplement.cpp:41
paso::Preconditioner_LocalSmoother_Sweep_colored
void Preconditioner_LocalSmoother_Sweep_colored(SparseMatrix_ptr A, Preconditioner_LocalSmoother *gs, double *x)
Definition: Smoother.cpp:351
paso::util::copy
void copy(dim_t N, double *out, const double *in)
out = in
Definition: PasoUtil.h:113
Paso.h
paso::Preconditioner_LocalSmoother_free
void Preconditioner_LocalSmoother_free(Preconditioner_LocalSmoother *in)
Definition: Smoother.cpp:55
paso::Preconditioner_Smoother_solve
void Preconditioner_Smoother_solve(SystemMatrix_ptr A, Preconditioner_Smoother *gs, double *x, const double *b, dim_t sweeps, bool x_is_initial)
Definition: Smoother.cpp:113
paso::Solver_RILU::A_FC
SparseMatrix_ptr A_FC
Definition: Preconditioner.h:131
paso::Solver_RILU::A_CF
SparseMatrix_ptr A_CF
Definition: Preconditioner.h:132
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:90
paso::Solver_RILU::RILU_of_Schur
Solver_RILU * RILU_of_Schur
Definition: Preconditioner.h:141
paso::Solver_RILU
RILU preconditioner.
Definition: Preconditioner.h:123
paso::Solver_RILU::rows_in_C
index_t * rows_in_C
Definition: Preconditioner.h:134
paso::Preconditioner_Smoother
Definition: Preconditioner.h:76
paso::SolverResult
SolverResult
Definition: Paso.h:55
SystemMatrix.h
paso::Solver_RILU::mask_F
index_t * mask_F
Definition: Preconditioner.h:135
PASO_GS
#define PASO_GS
Definition: Options.h:62
paso::Preconditioner_Smoother::is_local
bool is_local
Definition: Preconditioner.h:79
paso::Solver_solveRILU
void Solver_solveRILU(Solver_RILU *rilu, double *x, double *b)
Definition: RILU.cpp:303
paso::SparseMatrix_ptr
boost::shared_ptr< SparseMatrix > SparseMatrix_ptr
Definition: SparseMatrix.h:48
paso::Solver_ILU_free
void Solver_ILU_free(Solver_ILU *in)
Definition: ILU.cpp:48
paso::Solver_RILU::inv_A_FF
double * inv_A_FF
Definition: Preconditioner.h:129
paso::Preconditioner
Definition: Preconditioner.h:48
paso::Preconditioner::sweeps
dim_t sweeps
Definition: Preconditioner.h:51
PASO_JACOBI
#define PASO_JACOBI
Definition: Options.h:46
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:85
paso::Solver_RILU::x_C
double * x_C
Definition: Preconditioner.h:139
paso::Preconditioner_Smoother_alloc
Preconditioner_Smoother * Preconditioner_Smoother_alloc(SystemMatrix_ptr A, bool jacobi, bool is_local, bool verbose)
constructs the symmetric Gauss-Seidel preconditioner
Definition: Smoother.cpp:67
paso::Preconditioner_LocalSmoother::buffer
double * buffer
Definition: Preconditioner.h:72
paso::Preconditioner_Smoother_solve_byTolerance
SolverResult Preconditioner_Smoother_solve_byTolerance(SystemMatrix_ptr A, Preconditioner_Smoother *gs, double *x, const double *b, double atol, dim_t *sweeps, bool x_is_initial)
Definition: Smoother.cpp:140
paso::Preconditioner_LocalSmoother_Sweep_sequential
void Preconditioner_LocalSmoother_Sweep_sequential(SparseMatrix_ptr A, Preconditioner_LocalSmoother *gs, double *x)
inplace Gauss-Seidel sweep in sequential mode
Definition: Smoother.cpp:234
paso::Preconditioner_LocalSmoother::pivot
index_t * pivot
Definition: Preconditioner.h:73
paso::Solver_RILU::x_F
double * x_F
Definition: Preconditioner.h:137
paso::Preconditioner_alloc
Preconditioner * Preconditioner_alloc(SystemMatrix_ptr A, Options *options)
Definition: Preconditioner.cpp:61
Preconditioner.h
paso::Solver_RILU::A_FF_pivot
index_t * A_FF_pivot
Definition: Preconditioner.h:130
PasoUtil.h
paso::Preconditioner_LocalSmoother_solve
void Preconditioner_LocalSmoother_solve(SparseMatrix_ptr A, Preconditioner_LocalSmoother *gs, double *x, const double *b, dim_t sweeps, bool x_is_initial)
Definition: Smoother.cpp:174
paso::Solver_ILU::factors
double * factors
Definition: Preconditioner.h:119
paso::Solver_getRILU
Solver_RILU * Solver_getRILU(SparseMatrix_ptr A, bool verbose)
Definition: RILU.cpp:85
paso::Preconditioner::ilu
Solver_ILU * ilu
ILU preconditioner.
Definition: Preconditioner.h:57
paso
Definition: BiCGStab.cpp:26
paso::Preconditioner_free
void Preconditioner_free(Preconditioner *in)
Definition: Preconditioner.cpp:50
paso::Preconditioner_solve
void Preconditioner_solve(Preconditioner *prec, SystemMatrix_ptr A, double *x, double *b)
Definition: Preconditioner.cpp:126
paso::Solver_solveILU
void Solver_solveILU(SparseMatrix_ptr A, Solver_ILU *ilu, double *x, const double *b)
Definition: ILU.cpp:329
paso::Options
Definition: Options.h:77
paso::Solver_RILU::rows_in_F
index_t * rows_in_F
Definition: Preconditioner.h:133
paso::Preconditioner_LocalSmoother
Definition: Preconditioner.h:68
paso::Preconditioner_LocalSmoother_Sweep
void Preconditioner_LocalSmoother_Sweep(SparseMatrix_ptr A, Preconditioner_LocalSmoother *gs, double *x)
Definition: Smoother.cpp:214
paso::Preconditioner_ptr
boost::shared_ptr< Preconditioner > Preconditioner_ptr
Definition: Preconditioner.h:39