#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)

void	solve (DoubleMatrixBase *const &matrix_pt, const DoubleVector &rhs, DoubleVector &result)

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

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

virtual double	linear_solver_solution_time () const

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 ()

virtual void	disable_resolve ()

virtual void	solve_transpose (Problem *const &problem_pt, DoubleVector &result)

virtual void	solve_transpose (DoubleMatrixBase *const &matrix_pt, const DoubleVector &rhs, DoubleVector &result)

virtual void	solve_transpose (DoubleMatrixBase *const &matrix_pt, const Vector< double > &rhs, Vector< double > &result)

virtual void	resolve (const DoubleVector &rhs, DoubleVector &result)

virtual void	resolve_transpose (const DoubleVector &rhs, DoubleVector &result)

virtual void	enable_computation_of_gradient ()

void	disable_computation_of_gradient ()

void	reset_gradient ()

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

void	build_distribution (const LinearAlgebraDistribution *const dist_pt)

void	build_distribution (const LinearAlgebraDistribution &dist)

Additional Inherited Members
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 ()

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

Protected Attributes inherited from oomph::LinearSolver
bool	Enable_resolve

bool	Doc_time
	Boolean flag that indicates whether the time taken. More...

bool	Compute_gradient

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

DoubleVector	Gradient_for_glob_conv_newton_solve

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!

Constructor & Destructor Documentation

◆ FD_LU() [1/2]

oomph::FD_LU::FD_LU ( )

inline

Constructor: empty.

435 : DenseLU() {}

oomph::DenseLU::DenseLU

DenseLU()

Constructor, initialise storage.

Definition: linear_solver.h:340

◆ FD_LU() [2/2]

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

delete

Broken copy constructor.

Member Function Documentation

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

     {
       DenseLU::solve(matrix_pt, rhs, result);
     }

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.

     {
       LinearSolver::solve(matrix_pt, rhs, result);
     }

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.

   {
     // Initialise timer
     clock_t t_start = clock();
  
 #ifdef PARANOID
     // if the result vector is setup then check it is not distributed and has
     // the same communicator as the rhs vector
     if (result.built())
     {
       if (result.distributed())
       {
         std::ostringstream error_message_stream;
         error_message_stream << "The result vector must not be distributed";
         throw OomphLibError(error_message_stream.str(),
                             OOMPH_CURRENT_FUNCTION,
                             OOMPH_EXCEPTION_LOCATION);
       }
     }
 #endif
  
     // Find # of degrees of freedom
     unsigned long n_dof = problem_pt->ndof();
  
     // Allocate storage for the residuals vector and the jacobian matrix
     DoubleVector residuals;
     DenseDoubleMatrix jacobian(n_dof);
  
     {
       // initialise timer
       clock_t t_start = clock();
  
       // Get the full jacobian by finite differencing)  VERY INEFFICIENT!
       problem_pt->get_fd_jacobian(residuals, jacobian);
  
       // compute jacobian setup time
       clock_t t_end = clock();
       Jacobian_setup_time = double(t_end - t_start) / CLOCKS_PER_SEC;
  
       // Report the time
       if (Doc_time)
       {
         oomph_info << std::endl
                    << "CPU for setup of Dense Jacobian: "
                    << TimingHelpers::convert_secs_to_formatted_string(
                         Jacobian_setup_time)
                    << std::endl
                    << std::endl;
       }
     }
  
     // Solve by dense LU decomposition (not efficient)
     solve(&jacobian, residuals, result);
  
     // Set the sign of the determinant of the jacobian
     problem_pt->sign_of_jacobian() = Sign_of_determinant_of_matrix;
  
     // Finalise/doc timings
     clock_t t_end = clock();
     double total_time = double(t_end - t_start) / CLOCKS_PER_SEC;
     if (Doc_time)
     {
       oomph_info << "CPU for FD DenseLU LinearSolver: "
                  << TimingHelpers::convert_secs_to_formatted_string(total_time)
                  << std::endl
                  << std::endl;
     }
   }

References oomph::DoubleVector::built(), oomph::TimingHelpers::convert_secs_to_formatted_string(), oomph::DistributableLinearAlgebraObject::distributed(), oomph::LinearSolver::Doc_time, oomph::Problem::get_fd_jacobian(), oomph::DenseLU::Jacobian_setup_time, oomph::Problem::ndof(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::oomph_info, oomph::DenseLU::Sign_of_determinant_of_matrix, and oomph::Problem::sign_of_jacobian().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FD_LU() [1/2]

◆ FD_LU() [2/2]

Member Function Documentation

◆ operator=()

◆ solve() [1/3]

◆ solve() [2/3]

◆ solve() [3/3]