Dense LU decompositionbased solve of full assembled linear system. VERY inefficient but useful to illustrate the principle. Only suitable for use with Serial matrices and vectors. This solver will only work with nondistributed matrices and vectors (note: DenseDoubleMatrix is not distributable) More...
#include <linear_solver.h>
Public Member Functions  
DenseLU ()  
Constructor, initialise storage. More...  
DenseLU (const DenseLU &dummy)=delete  
Broken copy constructor. More...  
void  operator= (const DenseLU &)=delete 
Broken assignment operator. More...  
~DenseLU ()  
Destructor, clean up the stored LU factors. More...  
void  solve (Problem *const &problem_pt, DoubleVector &result) 
Solver: Takes pointer to problem and returns the results Vector which contains the solution of the linear system defined by the problem's fully assembled Jacobian and residual Vector. More...  
void  solve (DoubleMatrixBase *const &matrix_pt, const DoubleVector &rhs, DoubleVector &result) 
Linearalgebratype solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system. More...  
void  solve (DoubleMatrixBase *const &matrix_pt, const Vector< double > &rhs, Vector< double > &result) 
Linearalgebratype solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system. More...  
double  jacobian_setup_time () const 
returns the time taken to assemble the jacobian matrix and residual vector More...  
virtual double  linear_solver_solution_time () const 
return the time taken to solve the linear system (needs to be overloaded for each linear solver) More...  
Public Member Functions inherited from oomph::LinearSolver  
LinearSolver ()  
Empty constructor, initialise the member data. More...  
LinearSolver (const LinearSolver &dummy)=delete  
Broken copy constructor. More...  
void  operator= (const LinearSolver &)=delete 
Broken assignment operator. More...  
virtual  ~LinearSolver () 
Empty virtual destructor. More...  
void  enable_doc_time () 
Enable documentation of solve times. More...  
void  disable_doc_time () 
Disable documentation of solve times. More...  
bool  is_doc_time_enabled () const 
Is documentation of solve times enabled? More...  
bool  is_resolve_enabled () const 
Boolean flag indicating if resolves are enabled. More...  
virtual void  enable_resolve () 
Enable resolve (i.e. store matrix and/or LU decomposition, say) Virtual so it can be overloaded to perform additional tasks. More...  
virtual void  disable_resolve () 
Disable resolve (i.e. store matrix and/or LU decomposition, say) This function simply resets an internal flag. It's virtual so it can be overloaded to perform additional tasks such as cleaning up memory that is only required for the resolve. More...  
virtual void  solve_transpose (Problem *const &problem_pt, DoubleVector &result) 
Solver: Takes pointer to problem and returns the results vector which contains the solution of the linear system defined by the problem's fully assembled Jacobian and residual vector (broken virtual). More...  
virtual void  solve_transpose (DoubleMatrixBase *const &matrix_pt, const DoubleVector &rhs, DoubleVector &result) 
Linearalgebratype solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system. More...  
virtual void  solve_transpose (DoubleMatrixBase *const &matrix_pt, const Vector< double > &rhs, Vector< double > &result) 
Linearalgebratype solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system. More...  
virtual void  resolve (const DoubleVector &rhs, DoubleVector &result) 
Resolve the system defined by the last assembled jacobian and the rhs vector. Solution is returned in the vector result. (broken virtual) More...  
virtual void  resolve_transpose (const DoubleVector &rhs, DoubleVector &result) 
Solver: Resolve the system defined by the last assembled jacobian and the rhs vector. Solution is returned in the vector result. (broken virtual) More...  
virtual void  enable_computation_of_gradient () 
function to enable the computation of the gradient required for the globally convergent Newton method More...  
void  disable_computation_of_gradient () 
function to disable the computation of the gradient required for the globally convergent Newton method More...  
void  reset_gradient () 
function to reset the size of the gradient before each Newton solve More...  
void  get_gradient (DoubleVector &gradient) 
function to access the gradient, provided it has been computed More...  
Public Member Functions inherited from oomph::DistributableLinearAlgebraObject  
DistributableLinearAlgebraObject ()  
Default constructor  create a distribution. More...  
DistributableLinearAlgebraObject (const DistributableLinearAlgebraObject &matrix)=delete  
Broken copy constructor. More...  
void  operator= (const DistributableLinearAlgebraObject &)=delete 
Broken assignment operator. More...  
virtual  ~DistributableLinearAlgebraObject () 
Destructor. More...  
LinearAlgebraDistribution *  distribution_pt () const 
access to the LinearAlgebraDistribution More...  
unsigned  nrow () const 
access function to the number of global rows. More...  
unsigned  nrow_local () const 
access function for the num of local rows on this processor. More...  
unsigned  nrow_local (const unsigned &p) const 
access function for the num of local rows on this processor. More...  
unsigned  first_row () const 
access function for the first row on this processor More...  
unsigned  first_row (const unsigned &p) const 
access function for the first row on this processor More...  
bool  distributed () const 
distribution is serial or distributed More...  
bool  distribution_built () const 
if the communicator_pt is null then the distribution is not setup then false is returned, otherwise return true More...  
void  build_distribution (const LinearAlgebraDistribution *const dist_pt) 
setup the distribution of this distributable linear algebra object More...  
void  build_distribution (const LinearAlgebraDistribution &dist) 
setup the distribution of this distributable linear algebra object More...  
Protected Member Functions  
void  factorise (DoubleMatrixBase *const &matrix_pt) 
Perform the LU decomposition of the matrix. More...  
void  backsub (const DoubleVector &rhs, DoubleVector &result) 
Do the backsubstitution step to solve the system LU result = rhs. More...  
void  backsub (const Vector< double > &rhs, Vector< double > &result) 
perform back substitution using Vector<double> More...  
void  clean_up_memory () 
Clean up the stored LU factors. More...  
Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject  
void  clear_distribution () 
clear the distribution of this distributable linear algebra object More...  
Protected Attributes  
double  Jacobian_setup_time 
Jacobian setup time. More...  
double  Solution_time 
Solution time. More...  
int  Sign_of_determinant_of_matrix 
Sign of the determinant of the matrix (obtained during the LU decomposition) More...  
Protected Attributes inherited from oomph::LinearSolver  
bool  Enable_resolve 
Boolean that indicates whether the matrix (or its factors, in the case of direct solver) should be stored so that the resolve function can be used. More...  
bool  Doc_time 
Boolean flag that indicates whether the time taken. More...  
bool  Compute_gradient 
flag that indicates whether the gradient required for the globally convergent Newton method should be computed or not More...  
bool  Gradient_has_been_computed 
flag that indicates whether the gradient was computed or not More...  
DoubleVector  Gradient_for_glob_conv_newton_solve 
DoubleVector storing the gradient for the globally convergent Newton method. More...  
Private Attributes  
long *  Index 
Pointer to storage for the index of permutations in the LU solve. More...  
double *  LU_factors 
Pointer to storage for the LU decomposition. More...  
Friends  
class  DenseDoubleMatrix 
The DenseDoubleMatrix class is a friend. More...  
Dense LU decompositionbased solve of full assembled linear system. VERY inefficient but useful to illustrate the principle. Only suitable for use with Serial matrices and vectors. This solver will only work with nondistributed matrices and vectors (note: DenseDoubleMatrix is not distributable)
Definition at line 333 of file linear_solver.h.

inline 
Constructor, initialise storage.
Definition at line 340 of file linear_solver.h.
References oomph::LinearSolver::Doc_time.

delete 
Broken copy constructor.

inline 
Destructor, clean up the stored LU factors.
Definition at line 358 of file linear_solver.h.
References clean_up_memory().

protected 
Do the backsubstitution step to solve the system LU result = rhs.
Do the backsubstitution for the DenseLU solver. WARNING: this class does not perform any PARANOID checks on the vectors  these are all performed in the solve(...) method.
Definition at line 320 of file linear_solver.cc.
References i, Index, LU_factors, oomph::DistributableLinearAlgebraObject::nrow(), and oomph::DoubleVector::values_pt().
Referenced by solve().
perform back substitution using Vector<double>
Do the backsubstitution for the DenseLU solver. WARNING: this class does not perform any PARANOID checks on the vectors  these are all performed in the solve(...) method. So, if you call backsub directly, you have been warned...
Definition at line 372 of file linear_solver.cc.
References i, Index, and LU_factors.

protectedvirtual 
Clean up the stored LU factors.
Delete the storage that has been allocated for the LU factors, if the matrix data is not itself being overwritten.
Reimplemented from oomph::LinearSolver.
Definition at line 106 of file linear_solver.cc.
References oomph::DistributableLinearAlgebraObject::clear_distribution(), Index, and LU_factors.
Referenced by factorise(), solve(), and ~DenseLU().

protected 
Perform the LU decomposition of the matrix.
LU decompose the matrix. WARNING: this class does not perform any PARANOID checks on the vectors  these are all performed in the solve(...) method.
Definition at line 131 of file linear_solver.cc.
References clean_up_memory(), i, Index, LU_factors, oomph::DoubleMatrixBase::nrow(), and Sign_of_determinant_of_matrix.
Referenced by solve().

inlinevirtual 
returns the time taken to assemble the jacobian matrix and residual vector
Reimplemented from oomph::LinearSolver.
Definition at line 382 of file linear_solver.h.
References Jacobian_setup_time.

inlinevirtual 
return the time taken to solve the linear system (needs to be overloaded for each linear solver)
Reimplemented from oomph::LinearSolver.
Definition at line 389 of file linear_solver.h.
References Solution_time.

delete 
Broken assignment operator.

virtual 
Linearalgebratype solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system.
Reimplemented from oomph::LinearSolver.
Reimplemented in oomph::FD_LU.
Definition at line 419 of file linear_solver.cc.
References backsub(), oomph::DoubleVector::build(), oomph::DistributableLinearAlgebraObject::build_distribution(), clean_up_memory(), oomph::LinearAlgebraDistribution::communicator_pt(), oomph::TimingHelpers::convert_secs_to_formatted_string(), oomph::LinearAlgebraDistribution::distributed(), oomph::DistributableLinearAlgebraObject::distribution_built(), oomph::DistributableLinearAlgebraObject::distribution_pt(), oomph::LinearSolver::Doc_time, oomph::LinearSolver::Enable_resolve, factorise(), oomph::DoubleMatrixBase::ncol(), oomph::DistributableLinearAlgebraObject::nrow(), oomph::DoubleMatrixBase::nrow(), oomph::oomph_info, Solution_time, and oomph::TimingHelpers::timer().

virtual 
Linearalgebratype solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system.
Reimplemented from oomph::LinearSolver.
Reimplemented in oomph::FD_LU.
Definition at line 541 of file linear_solver.cc.
References backsub(), clean_up_memory(), oomph::TimingHelpers::convert_secs_to_formatted_string(), oomph::LinearSolver::Doc_time, oomph::LinearSolver::Enable_resolve, factorise(), oomph::oomph_info, and Solution_time.

virtual 
Solver: Takes pointer to problem and returns the results Vector which contains the solution of the linear system defined by the problem's fully assembled Jacobian and residual Vector.
Implements oomph::LinearSolver.
Reimplemented in oomph::FD_LU.
Definition at line 51 of file linear_solver.cc.
References oomph::TimingHelpers::convert_secs_to_formatted_string(), oomph::LinearSolver::Doc_time, oomph::Problem::get_jacobian(), Jacobian_setup_time, oomph::Problem::ndof(), oomph::oomph_info, Sign_of_determinant_of_matrix, oomph::Problem::sign_of_jacobian(), solve(), and oomph::TimingHelpers::timer().
Referenced by oomph::FD_LU::solve(), and solve().

friend 
The DenseDoubleMatrix class is a friend.
Definition at line 336 of file linear_solver.h.

private 
Pointer to storage for the index of permutations in the LU solve.
Definition at line 419 of file linear_solver.h.
Referenced by backsub(), clean_up_memory(), and factorise().

protected 
Jacobian setup time.
Definition at line 408 of file linear_solver.h.
Referenced by jacobian_setup_time(), solve(), and oomph::FD_LU::solve().

private 
Pointer to storage for the LU decomposition.
Definition at line 422 of file linear_solver.h.
Referenced by backsub(), clean_up_memory(), and factorise().

protected 
Sign of the determinant of the matrix (obtained during the LU decomposition)
Definition at line 415 of file linear_solver.h.
Referenced by factorise(), solve(), and oomph::FD_LU::solve().

protected 
Solution time.
Definition at line 411 of file linear_solver.h.
Referenced by linear_solver_solution_time(), and solve().