oomph::FD_LU Class Reference

Dense LU decomposition-based solve of linear system assembled via finite differencing of the residuals Vector. Even more inefficient than DenseLU but excellent sanity check! More...

`#include <linear_solver.h>`

Inheritance diagram for oomph::FD_LU:

## Public Member Functions

FD_LU ()
Constructor: empty. More...

FD_LU (const FD_LU &dummy)=delete
Broken copy constructor. More...

void operator= (const FD_LU &)=delete
Broken assignment operator. 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 residual Vector (Jacobian computed by FD approx.) More...

void solve (DoubleMatrixBase *const &matrix_pt, const DoubleVector &rhs, DoubleVector &result)
Linear-algebra-type 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)
Linear-algebra-type solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system Call the broken base-class version. If you want this, please implement it. More...

Public Member Functions inherited from oomph::DenseLU
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...

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)
Linear-algebra-type 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)
Linear-algebra-type 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...

function to enable the computation of the gradient required for the globally convergent Newton method More...

function to disable the computation of the gradient required for the globally convergent Newton method More...

function to reset the size of the gradient before each Newton solve More...

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...

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...

setup the distribution of this distributable linear algebra object More...

Protected Member Functions inherited from oomph::DenseLU
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 inherited from oomph::DenseLU
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...

flag that indicates whether the gradient required for the globally convergent Newton method should be computed or not More...

flag that indicates whether the gradient was computed or not More...

DoubleVector storing the gradient for the globally convergent Newton method. More...

## Detailed Description

Dense LU decomposition-based solve of linear system assembled via finite differencing of the residuals Vector. Even more inefficient than DenseLU but excellent sanity check!

Definition at line 431 of file linear_solver.h.

## ◆ FD_LU() [1/2]

 oomph::FD_LU::FD_LU ( )
inline

Constructor: empty.

Definition at line 435 of file linear_solver.h.

## ◆ FD_LU() [2/2]

 oomph::FD_LU::FD_LU ( const FD_LU & dummy )
delete

Broken copy constructor.

## ◆ operator=()

 void oomph::FD_LU::operator= ( const FD_LU & )
delete

Broken assignment operator.

## ◆ solve() [1/3]

 void oomph::FD_LU::solve ( DoubleMatrixBase *const & matrix_pt, const DoubleVector & rhs, DoubleVector & result )
inlinevirtual

Linear-algebra-type solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system.

Reimplemented from oomph::DenseLU.

Definition at line 450 of file linear_solver.h.

References oomph::DenseLU::solve().

## ◆ solve() [2/3]

 void oomph::FD_LU::solve ( DoubleMatrixBase *const & matrix_pt, const Vector< double > & rhs, Vector< double > & result )
inlinevirtual

Linear-algebra-type solver: Takes pointer to a matrix and rhs vector and returns the solution of the linear system Call the broken base-class version. If you want this, please implement it.

Reimplemented from oomph::DenseLU.

Definition at line 461 of file linear_solver.h.

References oomph::LinearSolver::solve().

## ◆ solve() [3/3]

 void oomph::FD_LU::solve ( Problem *const & problem_pt, DoubleVector & result )
virtual

Solver: Takes pointer to problem and returns the results Vector which contains the solution of the linear system defined by the problem's residual Vector (Jacobian computed by FD approx.)

Solver: Takes pointer to problem and returns the results Vector which contains the solution of the linear system defined by the problem's residual Vector. (Jacobian assembled by FD).

Reimplemented from oomph::DenseLU.

Definition at line 575 of file linear_solver.cc.

Referenced by solve().

The documentation for this class was generated from the following files: