File pcr_thomas.hxx#

class LaplacePCR_THOMAS : public Laplacian #

Public Functions

LaplacePCR_THOMAS(Options *opt = nullptr, CELL_LOC loc = CELL_CENTRE, Mesh *mesh_in = nullptr, Solver *solver = nullptr)#

~LaplacePCR_THOMAS() = default#

inline virtual void setCoefA(const Field2D &val) override#: Set coefficients for inversion. Re-builds matrices if necessary.

inline virtual void setCoefC(const Field2D &val) override#

inline virtual void setCoefC1(const Field2D &val) override#

inline virtual void setCoefC2(const Field2D &val) override#

inline virtual void setCoefD(const Field2D &val) override#

inline virtual void setCoefEx(const Field2D &val) override#

inline virtual void setCoefEz(const Field2D &val) override#

inline virtual FieldPerp solve(const FieldPerp &b) override#

virtual FieldPerp solve(const FieldPerp &rhs, const FieldPerp &x0) override#

inline virtual Field3D solve(const Field3D &b) override#

virtual Field3D solve(const Field3D &rhs, const Field3D &x0) override#

Performs the laplacian inversion y-slice by y-slice

Parameters:

b – [in] All the y-slices of b_slice, which is the right hand side of the equation A*x_slice = b_slice
x0 – [in] All the y-slices of the variable eventually used to set BC

Returns:

x All the y-slices of x_slice in the equation A*x_slice = b_slice

void cr_solver(double *a_mpi, double *b_mpi, double *c_mpi, double *r_mpi, double *x_mpi)#

void cr_pcr_solver(Matrix<dcomplex> &a_mpi, Matrix<dcomplex> &b_mpi, Matrix<dcomplex> &c_mpi, Matrix<dcomplex> &r_mpi, Matrix<dcomplex> &x_mpi)#

void pcr_thomas_solver(Matrix<dcomplex> &a_mpi, Matrix<dcomplex> &b_mpi, Matrix<dcomplex> &c_mpi, Matrix<dcomplex> &r_mpi, Matrix<dcomplex> &x_mpi)#

Thomas-PCR solver: pThomas_forward_multiple + pcr_forward_double + pThomas_backward_multiple.

Parameters:

a_mpi – (input) Lower off-diagonal coeff., which is assigned to local private pointer a
b_mpi – (input) Diagonal coeff., which is assigned to local private pointer b
c_mpi – (input) Upper off-diagonal coeff.,, which is assigned to local private pointer c
r_mpi – (input) RHS vector, which is assigned to local private pointer r
x_mpi – (output) Solution vector, which is assigned to local private pointer x

void Thomas_pcr_solver(double *a_mpi, double *b_mpi, double *c_mpi, double *r_mpi, double *x_mpi)#

void verify_solution(double *a_ver, double *b_ver, double *c_ver, double *r_ver, double *x_sol)#

void setCoefA(const Field2D &val) = 0: Set coefficients for inversion. Re-builds matrices if necessary.

inline void setCoefA(const Field3D &val)#

inline void setCoefA(BoutReal r)#

void setCoefC(const Field2D &val) = 0

inline void setCoefC(const Field3D &val)#

inline void setCoefC(BoutReal r)#

inline void setCoefC1(const Field2D &val)

inline void setCoefC1(const Field3D &val)#

inline void setCoefC1(BoutReal r)#

inline void setCoefC2(const Field2D &val)

inline void setCoefC2(const Field3D &val)#

inline void setCoefC2(BoutReal r)#

void setCoefD(const Field2D &val) = 0

inline void setCoefD(const Field3D &val)#

inline void setCoefD(BoutReal r)#

void setCoefEx(const Field2D &val) = 0

inline void setCoefEx(const Field3D &val)#

inline void setCoefEx(BoutReal r)#

void setCoefEz(const Field2D &val) = 0

inline void setCoefEz(const Field3D &val)#

inline void setCoefEz(BoutReal r)#

FieldPerp solve(const FieldPerp &b) = 0

Field3D solve(const Field3D &b)

Field2D solve(const Field2D &b)#

inline FieldPerp solve(const FieldPerp &b, const FieldPerp &x0)

Field3D solve(const Field3D &b, const Field3D &x0)

Performs the laplacian inversion y-slice by y-slice

Parameters:

b – [in] All the y-slices of b_slice, which is the right hand side of the equation A*x_slice = b_slice
x0 – [in] All the y-slices of the variable eventually used to set BC

Returns:

x All the y-slices of x_slice in the equation A*x_slice = b_slice

Field2D solve(const Field2D &b, const Field2D &x0)#

Private Functions

void cr_forward_multiple_row(Matrix<dcomplex> &a, Matrix<dcomplex> &b, Matrix<dcomplex> &c, Matrix<dcomplex> &r) const#

Forward elimination of CR until a single row per MPI process remains.

After a single row per MPI process remains, PCR or CR between a single row is performed.

void cr_backward_multiple_row(Matrix<dcomplex> &a, Matrix<dcomplex> &b, Matrix<dcomplex> &c, Matrix<dcomplex> &r, Matrix<dcomplex> &x) const#: Backward substitution of CR after single-row solution per MPI process is obtained.

void apply_boundary_conditions(const Matrix<dcomplex> &a, const Matrix<dcomplex> &b, const Matrix<dcomplex> &c, const Matrix<dcomplex> &r, Matrix<dcomplex> &x)#: Apply the boundary conditions on the first and last X processors

void eliminate_boundary_rows(const Matrix<dcomplex> &a, Matrix<dcomplex> &b, const Matrix<dcomplex> &c, Matrix<dcomplex> &r)#: Eliminate boundary rows - perform row elimination to uncouple the first and last interior rows from their respective boundary rows. This is necessary to ensure we pass a square system of interior rows to the PCR library.

void cr_forward_single_row()#

void cr_backward_single_row()#

void pcr_forward_single_row(Matrix<dcomplex> &a, Matrix<dcomplex> &b, Matrix<dcomplex> &c, Matrix<dcomplex> &r, Matrix<dcomplex> &x) const#: PCR between a single row per MPI process and 2x2 matrix solver between i and i+nprocs/2 rows.

void pThomas_forward_multiple_row(Matrix<dcomplex> &a, Matrix<dcomplex> &b, Matrix<dcomplex> &c, Matrix<dcomplex> &r) const#: First phase of hybrid Thomas and PCR algorithm @detail Forward and backward elimination to remain two equations of first and last rows for each MPI processes.

void pcr_double_row_substitution(Matrix<dcomplex> &a, Matrix<dcomplex> &b, Matrix<dcomplex> &c, Matrix<dcomplex> &r, Matrix<dcomplex> &x)#: PCR solver for two equations per each MPI process @detail Forward CR to remain a single equation per each MPI process. PCR solver for single row is, then, executed. Substitution is also performed to obtain every solution.

void verify_solution(const Matrix<dcomplex> &a_ver, const Matrix<dcomplex> &b_ver, const Matrix<dcomplex> &c_ver, const Matrix<dcomplex> &r_ver, const Matrix<dcomplex> &x_sol) const#