Go to the documentation of this file.
30 #ifndef __PASO_SYSTEMMATRIX_H__
31 #define __PASO_SYSTEMMATRIX_H__
36 #include <escript/AbstractSystemMatrix.h>
67 double main_diagonal_value);
69 virtual inline void saveMM(
const std::string& filename)
const
75 merged->saveMM(filename.c_str());
81 virtual inline void saveHB(
const std::string& filename)
const
84 throw PasoException(
"SystemMatrix::saveHB: Only single rank supported.");
86 throw PasoException(
"SystemMatrix::saveHB: Only CSC format supported.");
92 virtual void resetValues(
bool preserveSolverData =
false);
98 void nullifyRows(
double* mask_row,
double main_diagonal_value);
137 void applyBalance(
double* x_out,
const double* x,
bool RHS)
const;
218 return pattern->input_distribution->getGlobalNumComponents();
220 return pattern->output_distribution->getGlobalNumComponents();
226 return pattern->output_distribution->getGlobalNumComponents();
228 return pattern->input_distribution->getGlobalNumComponents();
249 return pattern->getNumOutput();
254 mainBlock->copyBlockFromMainDiagonal(out);
280 inline void rowSum(
double* row_sum)
const
283 throw PasoException(
"SystemMatrix::rowSum: No normalization "
284 "available for compressed sparse column or index offset 1.");
287 #pragma omp parallel for
288 for (
index_t irow=0; irow<nrow; ++irow) {
296 void MatrixVector(
double alpha,
const double* in,
double beta,
307 int package,
bool symmetry,
356 boost::python::object& options)
const;
360 void solve(
double* out,
double* in,
Options* options)
const;
369 #endif // __PASO_SYSTEMMATRIX_H__
#define MATRIX_FORMAT_BLK1
Definition: Paso.h:63
void copyFromMainDiagonal(double *out) const
Definition: SystemMatrix.h:274
bool isComplex() const
True if components of this data are stored as complex.
Definition: Data.cpp:1164
virtual void nullifyRowsAndCols(escript::Data &mask_row, escript::Data &mask_col, double main_diagonal_value)
Definition: SystemMatrix.cpp:257
double getGlobalSize() const
Definition: SystemMatrix.cpp:184
static SystemMatrix_ptr loadMM_toCSC(const char *filename)
Definition: SystemMatrix_loadMM.cpp:213
void nullifyRows(double *mask_row, double main_diagonal_value)
Definition: SystemMatrix.cpp:236
escript::JMPI mpi_info
Definition: SystemMatrix.h:334
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:1243
bool is_balanced
Definition: SystemMatrix.h:348
void freePreconditioner()
Definition: SystemMatrix.cpp:177
void copyBlockFromMainDiagonal(double *out) const
Definition: SystemMatrix.h:264
boost::shared_ptr< Distribution > Distribution_ptr
Definition: Distribution.h:37
void copyColCoupleBlock()
Definition: SystemMatrix.cpp:378
escript::Distribution_ptr col_distribution
Definition: SystemMatrix.h:333
#define MATRIX_FORMAT_CSC
Definition: Paso.h:62
void RHS_loadMM_toCSR(const char *filename, double *b, dim_t size)
Definition: SystemMatrix_loadMM.cpp:312
void print() const
Definition: SystemMatrix_debug.cpp:119
void solve_free(SystemMatrix *in)
Definition: solve.cpp:142
dim_t getColOverlap() const
Definition: SystemMatrix.h:222
virtual void resetValues(bool preserveSolverData=false)
resets the matrix entries
Definition: SystemMatrix.cpp:319
void mergeMainAndCouple_CSR_OFFSET0(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:78
void rowSum(double *row_sum) const
Definition: SystemMatrix.h:292
virtual void saveHB(const std::string &filename) const
writes the matrix to a file using the Harwell-Boeing file format
Definition: SystemMatrix.h:93
dim_t getGlobalNumCols() const
Definition: SystemMatrix.h:235
void copyBlockToMainDiagonal(const double *in)
Definition: SystemMatrix.h:269
dim_t getGlobalTotalNumRows() const
Definition: SystemMatrix.h:243
dim_t getGlobalTotalNumCols() const
Definition: SystemMatrix.h:248
void mergeMainAndCouple_CSC_OFFSET1(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:298
boost::shared_ptr< SystemMatrix > SystemMatrix_ptr
Definition: SystemMatrix.h:53
static int getPackage(int solver, int package, bool symmetry, const escript::JMPI &mpi_info)
Definition: Options.cpp:323
double getSparsity() const
Definition: SystemMatrix.h:253
ElementType * data()
Definition: DataVectorAlt.h:225
#define MPI_SUM
Definition: EsysMPI.h:51
void add(dim_t, index_t *, dim_t, dim_t, index_t *, dim_t, double *)
boost::shared_ptr< SystemMatrixPattern > SystemMatrixPattern_ptr
Definition: SystemMatrixPattern.h:52
void mergeMainAndCouple_CSR_OFFSET0_Block(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:190
static int mapEscriptOption(int escriptOption)
returns the corresponding paso option code for an escript option code
Definition: Options.cpp:363
FunctionSpace getColumnFunctionSpace() const
returns the column function space
Definition: AbstractSystemMatrix.h:104
void copyRemoteCoupleBlock(bool recreatePattern)
Definition: SystemMatrix_copyRemoteCoupleBlock.cpp:52
int getDataPointSize() const
Return the size of the data point. It is the product of the data point shape dimensions.
Definition: Data.cpp:1364
Definition: FunctionSpace.h:47
void applyBalanceInPlace(double *x, bool RHS) const
Definition: SystemMatrix.cpp:456
const FunctionSpace & getFunctionSpace() const
Return the function space.
Definition: Data.h:462
void setPreconditioner(Options *options)
Definition: SystemMatrix.cpp:162
#define PASO_MKL
Definition: Options.h:49
#define MATRIX_FORMAT_OFFSET1
Definition: Paso.h:64
double * finishCollect() const
Definition: SystemMatrix.h:172
void startCollect(const double *in) const
Definition: SystemMatrix.h:167
#define MPI_INT
Definition: EsysMPI.h:45
void applyBalance(double *x_out, const double *x, bool RHS) const
Definition: SystemMatrix.cpp:475
#define MPI_MAX
Definition: EsysMPI.h:53
index_t solver_package
package code controlling the solver pointer
Definition: SystemMatrix.h:361
double * balance_vector
Definition: SystemMatrix.h:355
Data represents a collection of datapoints.
Definition: Data.h:63
ASM_ptr getPtr()
Returns smart pointer which is managing this object. If one does not exist yet it creates one.
Definition: AbstractSystemMatrix.cpp:54
index_t dim_t
Definition: DataTypes.h:90
SparseMatrix_ptr mergeSystemMatrix() const
Definition: SystemMatrix.cpp:579
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:71
SystemMatrixType type
Definition: SystemMatrix.h:322
dim_t getGlobalNumRows() const
Definition: SystemMatrix.h:227
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:55
Coupler_ptr< real_t > col_coupler
Definition: SystemMatrix.h:336
index_t * borrowMainDiagonalPointer() const
Definition: SystemMatrix.cpp:200
void * solver_p
pointer to data needed by a solver
Definition: SystemMatrix.h:364
void balance()
Definition: SystemMatrix.cpp:494
SparseMatrix_ptr mainBlock
main block
Definition: SystemMatrix.h:340
boost::shared_ptr< Coupler< T > > Coupler_ptr
Definition: Coupler.h:55
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:358
virtual void ypAx(escript::Data &y, escript::Data &x) const
performs y+=this*x
Definition: SystemMatrix.cpp:354
Coupler_ptr< real_t > row_coupler
Definition: SystemMatrix.h:337
SparseMatrix_ptr row_coupleBlock
coupling to neighbouring processors (col - row)
Definition: SystemMatrix.h:344
boost::shared_ptr< const SystemMatrix > const_SystemMatrix_ptr
Definition: SystemMatrix.h:55
dim_t col_block_size
Definition: SystemMatrix.h:329
#define PASO_PASO
Definition: Options.h:55
#define PASO_UMFPACK
Definition: Options.h:50
void extendedRowsForST(dim_t *degree_ST, index_t *offset_ST, index_t *ST)
Definition: SystemMatrix_extendedRows.cpp:54
dim_t getRowOverlap() const
Definition: SystemMatrix.h:217
void copyToMainDiagonal(const double *in)
Definition: SystemMatrix.h:279
dim_t getTotalNumCols() const
Definition: SystemMatrix.h:212
dim_t row_block_size
Definition: SystemMatrix.h:328
boost::shared_ptr< SparseMatrix > SparseMatrix_ptr
Definition: SparseMatrix.h:48
SystemMatrixPattern_ptr pattern
Definition: SystemMatrix.h:323
#define MPI_DOUBLE
Definition: EsysMPI.h:46
void fillWithGlobalCoordinates(double f1)
Definition: SystemMatrix_debug.cpp:56
Definition: Preconditioner.h:48
dim_t getTotalNumRows() const
Definition: SystemMatrix.h:207
void solvePreconditioner(double *x, double *b)
Definition: SystemMatrix.cpp:170
PasoException exception class.
Definition: PasoException.h:45
dim_t getNumCols() const
Definition: SystemMatrix.h:202
SparseMatrix_ptr remote_coupleBlock
coupling of rows-cols on neighbouring processors (may not be valid)
Definition: SystemMatrix.h:346
void startColCollect(const double *in) const
Definition: SystemMatrix.h:177
int SystemMatrixType
Definition: SystemMatrix.h:57
dim_t getNumOutput() const
Definition: SystemMatrix.h:259
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:85
dim_t logical_row_block_size
Definition: SystemMatrix.h:325
double * finishRowCollect()
Definition: SystemMatrix.h:192
Definition: AbstractContinuousDomain.cpp:23
void solve(double *out, double *in, Options *options) const
Definition: solve.cpp:53
void mergeMainAndCouple(index_t **p_ptr, index_t **p_idx, double **p_val) const
Definition: SystemMatrix_mergeMainAndCouple.cpp:62
dim_t getNumRows() const
Definition: SystemMatrix.h:197
Preconditioner * Preconditioner_alloc(SystemMatrix_ptr A, Options *options)
Definition: Preconditioner.cpp:61
void setValues(double value)
Definition: SystemMatrix.h:284
FunctionSpace getRowFunctionSpace() const
returns the row function space
Definition: AbstractSystemMatrix.h:115
boost::shared_ptr< Pattern > Pattern_ptr
Definition: Pattern.h:50
SystemMatrix()
default constructor - throws exception.
Definition: SystemMatrix.cpp:54
double * finishColCollect() const
Definition: SystemMatrix.h:182
void MatrixVector(double alpha, const double *in, double beta, double *out) const
Definition: SystemMatrix_MatrixVector.cpp:47
void makeZeroRowSums(double *left_over)
Definition: SystemMatrix.cpp:214
static int getSystemMatrixTypeId(int solver, int preconditioner, int package, bool symmetry, const escript::JMPI &mpi_info)
Definition: SystemMatrix.cpp:545
void startRowCollect(const double *in)
Definition: SystemMatrix.h:187
static SystemMatrix_ptr loadMM_toCSR(const char *filename)
Definition: SystemMatrix_loadMM.cpp:113
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:5845
dim_t block_size
Definition: SystemMatrix.h:330
Definition: BiCGStab.cpp:26
void MatrixVector_CSR_OFFSET0(double alpha, const double *in, double beta, double *out) const
Definition: SystemMatrix_MatrixVector.cpp:76
void Preconditioner_free(Preconditioner *in)
Definition: Preconditioner.cpp:50
int getRowBlockSize() const
returns the row block size
Definition: AbstractSystemMatrix.h:126
void expand()
Whatever the current Data type make this into a DataExpanded.
Definition: Data.cpp:1184
int getColumnBlockSize() const
returns the column block size
Definition: AbstractSystemMatrix.h:137
virtual void setToSolution(escript::Data &out, escript::Data &in, boost::python::object &options) const
solves the linear system this*out=in
Definition: SystemMatrix.cpp:326
void Preconditioner_solve(Preconditioner *prec, SystemMatrix_ptr A, double *x, double *b)
Definition: Preconditioner.cpp:126
Definition: SparseMatrix.h:55
#define MATRIX_FORMAT_DEFAULT
Definition: Paso.h:61
#define MATRIX_FORMAT_DIAGONAL_BLOCK
Definition: Paso.h:65
escript::Distribution_ptr row_distribution
Definition: SystemMatrix.h:332
dim_t logical_col_block_size
Definition: SystemMatrix.h:326
virtual void saveMM(const std::string &filename) const
writes the matrix to a file using the Matrix Market file format
Definition: SystemMatrix.h:81
~SystemMatrix()
Definition: SystemMatrix.cpp:155
SparseMatrix_ptr col_coupleBlock
coupling to neighbouring processors (row - col)
Definition: SystemMatrix.h:342