Go to the documentation of this file.
29 #ifndef __PASO_SYSTEMMATRIX_H__
30 #define __PASO_SYSTEMMATRIX_H__
35 #include <escript/AbstractSystemMatrix.h>
66 double main_diagonal_value);
68 virtual inline void saveMM(
const std::string& filename)
const
74 merged->saveMM(filename.c_str());
80 virtual inline void saveHB(
const std::string& filename)
const
83 throw PasoException(
"SystemMatrix::saveHB: Only single rank supported.");
85 throw PasoException(
"SystemMatrix::saveHB: Only CSC format supported.");
97 void nullifyRows(
double* mask_row,
double main_diagonal_value);
136 void applyBalance(
double* x_out,
const double* x,
bool RHS)
const;
217 return pattern->input_distribution->getGlobalNumComponents();
219 return pattern->output_distribution->getGlobalNumComponents();
225 return pattern->output_distribution->getGlobalNumComponents();
227 return pattern->input_distribution->getGlobalNumComponents();
248 return pattern->getNumOutput();
253 mainBlock->copyBlockFromMainDiagonal(out);
279 inline void rowSum(
double* row_sum)
const
283 "available for compressed sparse column or index offset 1.");
286 #pragma omp parallel for
287 for (
index_t irow=0; irow<nrow; ++irow) {
295 void MatrixVector(
double alpha,
const double* in,
double beta,
306 int package,
bool symmetry,
355 boost::python::object& options)
const;
368 #endif // __PASO_SYSTEMMATRIX_H__
#define MATRIX_FORMAT_BLK1
Definition: Paso.h:62
void copyFromMainDiagonal(double *out) const
Definition: SystemMatrix.h:272
bool isComplex() const
True if components of this data are stored as complex.
Definition: Data.cpp:1163
virtual void nullifyRowsAndCols(escript::Data &mask_row, escript::Data &mask_col, double main_diagonal_value)
Definition: SystemMatrix.cpp:255
double getGlobalSize() const
Definition: SystemMatrix.cpp:182
static SystemMatrix_ptr loadMM_toCSC(const char *filename)
Definition: SystemMatrix_loadMM.cpp:211
void nullifyRows(double *mask_row, double main_diagonal_value)
Definition: SystemMatrix.cpp:234
escript::JMPI mpi_info
Definition: SystemMatrix.h:332
void requireWrite()
Ensures data is ready for write access. This means that the data will be resolved if lazy and will be...
Definition: Data.cpp:1242
bool is_balanced
Definition: SystemMatrix.h:346
void freePreconditioner()
Definition: SystemMatrix.cpp:175
void copyBlockFromMainDiagonal(double *out) const
Definition: SystemMatrix.h:262
boost::shared_ptr< Distribution > Distribution_ptr
Definition: Distribution.h:35
void copyColCoupleBlock()
Definition: SystemMatrix.cpp:376
escript::Distribution_ptr col_distribution
Definition: SystemMatrix.h:331
#define MATRIX_FORMAT_CSC
Definition: Paso.h:61
void RHS_loadMM_toCSR(const char *filename, double *b, dim_t size)
Definition: SystemMatrix_loadMM.cpp:310
void print() const
Definition: SystemMatrix_debug.cpp:117
void solve_free(SystemMatrix *in)
Definition: solve.cpp:140
dim_t getColOverlap() const
Definition: SystemMatrix.h:220
virtual void resetValues(bool preserveSolverData=false)
resets the matrix entries
Definition: SystemMatrix.cpp:317
void mergeMainAndCouple_CSR_OFFSET0(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:76
void rowSum(double *row_sum) const
Definition: SystemMatrix.h:290
virtual void saveHB(const std::string &filename) const
writes the matrix to a file using the Harwell-Boeing file format
Definition: SystemMatrix.h:91
dim_t getGlobalNumCols() const
Definition: SystemMatrix.h:233
void copyBlockToMainDiagonal(const double *in)
Definition: SystemMatrix.h:267
dim_t getGlobalTotalNumRows() const
Definition: SystemMatrix.h:241
dim_t getGlobalTotalNumCols() const
Definition: SystemMatrix.h:246
void mergeMainAndCouple_CSC_OFFSET1(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:296
boost::shared_ptr< SystemMatrix > SystemMatrix_ptr
Definition: SystemMatrix.h:51
static int getPackage(int solver, int package, bool symmetry, const escript::JMPI &mpi_info)
Definition: Options.cpp:321
double getSparsity() const
Definition: SystemMatrix.h:251
ElementType * data()
Definition: DataVectorAlt.h:222
#define MPI_SUM
Definition: EsysMPI.h:50
void add(dim_t, index_t *, dim_t, dim_t, index_t *, dim_t, double *)
boost::shared_ptr< SystemMatrixPattern > SystemMatrixPattern_ptr
Definition: SystemMatrixPattern.h:50
void mergeMainAndCouple_CSR_OFFSET0_Block(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:188
static int mapEscriptOption(int escriptOption)
returns the corresponding paso option code for an escript option code
Definition: Options.cpp:361
FunctionSpace getColumnFunctionSpace() const
returns the column function space
Definition: AbstractSystemMatrix.h:102
void copyRemoteCoupleBlock(bool recreatePattern)
Definition: SystemMatrix_copyRemoteCoupleBlock.cpp:50
int getDataPointSize() const
Return the size of the data point. It is the product of the data point shape dimensions.
Definition: Data.cpp:1363
Definition: FunctionSpace.h:45
void applyBalanceInPlace(double *x, bool RHS) const
Definition: SystemMatrix.cpp:454
const FunctionSpace & getFunctionSpace() const
Return the function space.
Definition: Data.h:461
void setPreconditioner(Options *options)
Definition: SystemMatrix.cpp:160
#define PASO_MKL
Definition: Options.h:48
#define MATRIX_FORMAT_OFFSET1
Definition: Paso.h:63
double * finishCollect() const
Definition: SystemMatrix.h:170
void startCollect(const double *in) const
Definition: SystemMatrix.h:165
#define MPI_INT
Definition: EsysMPI.h:44
void applyBalance(double *x_out, const double *x, bool RHS) const
Definition: SystemMatrix.cpp:473
#define MPI_MAX
Definition: EsysMPI.h:52
index_t solver_package
package code controlling the solver pointer
Definition: SystemMatrix.h:359
double * balance_vector
Definition: SystemMatrix.h:353
Data represents a collection of datapoints.
Definition: Data.h:62
ASM_ptr getPtr()
Returns smart pointer which is managing this object. If one does not exist yet it creates one.
Definition: AbstractSystemMatrix.cpp:52
index_t dim_t
Definition: DataTypes.h:87
SparseMatrix_ptr mergeSystemMatrix() const
Definition: SystemMatrix.cpp:577
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:70
SystemMatrixType type
Definition: SystemMatrix.h:320
dim_t getGlobalNumRows() const
Definition: SystemMatrix.h:225
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:53
Coupler_ptr< real_t > col_coupler
Definition: SystemMatrix.h:334
index_t * borrowMainDiagonalPointer() const
Definition: SystemMatrix.cpp:198
void * solver_p
pointer to data needed by a solver
Definition: SystemMatrix.h:362
void balance()
Definition: SystemMatrix.cpp:492
SparseMatrix_ptr mainBlock
main block
Definition: SystemMatrix.h:338
boost::shared_ptr< Coupler< T > > Coupler_ptr
Definition: Coupler.h:53
void copyMain_CSC_OFFSET1(index_t **p_ptr, index_t **p_idx, double **p_val)
index_t * global_id
stores the global ids for all cols in col_coupleBlock
Definition: SystemMatrix.h:356
virtual void ypAx(escript::Data &y, escript::Data &x) const
performs y+=this*x
Definition: SystemMatrix.cpp:352
Coupler_ptr< real_t > row_coupler
Definition: SystemMatrix.h:335
SparseMatrix_ptr row_coupleBlock
coupling to neighbouring processors (col - row)
Definition: SystemMatrix.h:342
boost::shared_ptr< const SystemMatrix > const_SystemMatrix_ptr
Definition: SystemMatrix.h:53
dim_t col_block_size
Definition: SystemMatrix.h:327
#define PASO_PASO
Definition: Options.h:54
#define PASO_UMFPACK
Definition: Options.h:49
void extendedRowsForST(dim_t *degree_ST, index_t *offset_ST, index_t *ST)
Definition: SystemMatrix_extendedRows.cpp:52
dim_t getRowOverlap() const
Definition: SystemMatrix.h:215
void copyToMainDiagonal(const double *in)
Definition: SystemMatrix.h:277
dim_t getTotalNumCols() const
Definition: SystemMatrix.h:210
dim_t row_block_size
Definition: SystemMatrix.h:326
boost::shared_ptr< SparseMatrix > SparseMatrix_ptr
Definition: SparseMatrix.h:46
SystemMatrixPattern_ptr pattern
Definition: SystemMatrix.h:321
#define MPI_DOUBLE
Definition: EsysMPI.h:45
void fillWithGlobalCoordinates(double f1)
Definition: SystemMatrix_debug.cpp:54
Definition: Preconditioner.h:46
dim_t getTotalNumRows() const
Definition: SystemMatrix.h:205
void solvePreconditioner(double *x, double *b)
Definition: SystemMatrix.cpp:168
PasoException exception class.
Definition: PasoException.h:43
dim_t getNumCols() const
Definition: SystemMatrix.h:200
SparseMatrix_ptr remote_coupleBlock
coupling of rows-cols on neighbouring processors (may not be valid)
Definition: SystemMatrix.h:344
void startColCollect(const double *in) const
Definition: SystemMatrix.h:175
int SystemMatrixType
Definition: SystemMatrix.h:55
dim_t getNumOutput() const
Definition: SystemMatrix.h:257
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:82
dim_t logical_row_block_size
Definition: SystemMatrix.h:323
double * finishRowCollect()
Definition: SystemMatrix.h:190
Definition: AbstractContinuousDomain.cpp:22
void solve(double *out, double *in, Options *options) const
Definition: solve.cpp:51
void mergeMainAndCouple(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:60
dim_t getNumRows() const
Definition: SystemMatrix.h:195
Preconditioner * Preconditioner_alloc(SystemMatrix_ptr A, Options *options)
Definition: Preconditioner.cpp:59
void setValues(double value)
Definition: SystemMatrix.h:282
FunctionSpace getRowFunctionSpace() const
returns the row function space
Definition: AbstractSystemMatrix.h:113
boost::shared_ptr< Pattern > Pattern_ptr
Definition: Pattern.h:48
SystemMatrix()
default constructor - throws exception.
Definition: SystemMatrix.cpp:52
double * finishColCollect() const
Definition: SystemMatrix.h:180
void MatrixVector(double alpha, const double *in, double beta, double *out) const
Definition: SystemMatrix_MatrixVector.cpp:45
void makeZeroRowSums(double *left_over)
Definition: SystemMatrix.cpp:212
static int getSystemMatrixTypeId(int solver, int preconditioner, int package, bool symmetry, const escript::JMPI &mpi_info)
Definition: SystemMatrix.cpp:543
void startRowCollect(const double *in)
Definition: SystemMatrix.h:185
static SystemMatrix_ptr loadMM_toCSR(const char *filename)
Definition: SystemMatrix_loadMM.cpp:111
DataTypes::RealVectorType & getExpandedVectorReference(DataTypes::real_t dummy=0)
Ensures that the Data is expanded and returns its underlying vector Does not check for exclusive writ...
Definition: Data.cpp:5844
dim_t block_size
Definition: SystemMatrix.h:328
Definition: BiCGStab.cpp:25
void MatrixVector_CSR_OFFSET0(double alpha, const double *in, double beta, double *out) const
Definition: SystemMatrix_MatrixVector.cpp:74
void Preconditioner_free(Preconditioner *in)
Definition: Preconditioner.cpp:48
int getRowBlockSize() const
returns the row block size
Definition: AbstractSystemMatrix.h:124
void expand()
Whatever the current Data type make this into a DataExpanded.
Definition: Data.cpp:1183
int getColumnBlockSize() const
returns the column block size
Definition: AbstractSystemMatrix.h:135
virtual void setToSolution(escript::Data &out, escript::Data &in, boost::python::object &options) const
solves the linear system this*out=in
Definition: SystemMatrix.cpp:324
void Preconditioner_solve(Preconditioner *prec, SystemMatrix_ptr A, double *x, double *b)
Definition: Preconditioner.cpp:124
Definition: SparseMatrix.h:53
#define MATRIX_FORMAT_DEFAULT
Definition: Paso.h:60
#define MATRIX_FORMAT_DIAGONAL_BLOCK
Definition: Paso.h:64
escript::Distribution_ptr row_distribution
Definition: SystemMatrix.h:330
dim_t logical_col_block_size
Definition: SystemMatrix.h:324
virtual void saveMM(const std::string &filename) const
writes the matrix to a file using the Matrix Market file format
Definition: SystemMatrix.h:79
~SystemMatrix()
Definition: SystemMatrix.cpp:153
SparseMatrix_ptr col_coupleBlock
coupling to neighbouring processors (row - col)
Definition: SystemMatrix.h:340