Public Member Functions | Private Attributes | List of all members
oomph::AugmentedBlockFoldLinearSolver Class Reference

#include <assembly_handler.h>

+ Inheritance diagram for oomph::AugmentedBlockFoldLinearSolver:

Public Member Functions

 AugmentedBlockFoldLinearSolver (LinearSolver *const linear_solver_pt)
 Constructor, inherits the original linear solver. More...
 
 ~AugmentedBlockFoldLinearSolver ()
 Destructor: clean up the allocated memory. More...
 
void solve (Problem *const &problem_pt, DoubleVector &result)
 The solve function uses the block factorisation. More...
 
void solve (DoubleMatrixBase *const &matrix_pt, const DoubleVector &rhs, DoubleVector &result)
 The linear-algebra-type solver does not make sense. The interface is deliberately broken. More...
 
void solve (DoubleMatrixBase *const &matrix_pt, const Vector< double > &rhs, Vector< double > &result)
 The linear-algebra-type solver does not make sense. The interface is deliberately broken. More...
 
void resolve (const DoubleVector &rhs, DoubleVector &result)
 The resolve function also uses the block factorisation. More...
 
LinearSolverlinear_solver_pt () const
 Access function to the original linear solver. More...
 
- Public Member Functions inherited from oomph::LinearSolver
 LinearSolver ()
 Empty constructor, initialise the member data. More...
 
 LinearSolver (const LinearSolver &dummy)
 Broken copy constructor. More...
 
void operator= (const LinearSolver &)
 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 clean_up_memory ()
 Empty virtual function that can be overloaded in specific linear solvers to clean up any memory that may have been allocated (e.g. when preparing for a re-solve). More...
 
virtual double jacobian_setup_time () const
 returns the time taken to assemble the Jacobian matrix and residual vector (needs to be overloaded for each solver) 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...
 
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)
 Broken copy constructor. More...
 
void operator= (const DistributableLinearAlgebraObject &)
 Broken assignment operator. More...
 
virtual ~DistributableLinearAlgebraObject ()
 Destructor. More...
 
LinearAlgebraDistributiondistribution_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)
 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...
 

Private Attributes

LinearSolverLinear_solver_pt
 Pointer to the original linear solver. More...
 
ProblemProblem_pt
 
DoubleVectorAlpha_pt
 Pointer to the storage for the vector alpha. More...
 
DoubleVectorE_pt
 Pointer to the storage for the vector e. More...
 

Additional Inherited Members

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

Detailed Description

A custom linear solver class that is used to solve a block-factorised version of the Fold bifurcation detection problem.

Definition at line 388 of file assembly_handler.h.

Constructor & Destructor Documentation

oomph::AugmentedBlockFoldLinearSolver::AugmentedBlockFoldLinearSolver ( LinearSolver *const  linear_solver_pt)
inline

Constructor, inherits the original linear solver.

Definition at line 405 of file assembly_handler.h.

oomph::AugmentedBlockFoldLinearSolver::~AugmentedBlockFoldLinearSolver ( )

Destructor: clean up the allocated memory.

Clean up the memory that may have been allocated by the solver.

Definition at line 377 of file assembly_handler.cc.

References Alpha_pt, and E_pt.

Member Function Documentation

LinearSolver* oomph::AugmentedBlockFoldLinearSolver::linear_solver_pt ( ) const
inline

Access function to the original linear solver.

Definition at line 442 of file assembly_handler.h.

References Linear_solver_pt.

Referenced by oomph::FoldHandler::~FoldHandler().

void oomph::AugmentedBlockFoldLinearSolver::resolve ( const DoubleVector rhs,
DoubleVector result 
)
virtual
void oomph::AugmentedBlockFoldLinearSolver::solve ( Problem *const &  problem_pt,
DoubleVector result 
)
virtual
void oomph::AugmentedBlockFoldLinearSolver::solve ( DoubleMatrixBase *const &  matrix_pt,
const DoubleVector rhs,
DoubleVector result 
)
inlinevirtual

The linear-algebra-type solver does not make sense. The interface is deliberately broken.

Reimplemented from oomph::LinearSolver.

Definition at line 416 of file assembly_handler.h.

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

The linear-algebra-type solver does not make sense. The interface is deliberately broken.

Reimplemented from oomph::LinearSolver.

Definition at line 428 of file assembly_handler.h.

Member Data Documentation

DoubleVector* oomph::AugmentedBlockFoldLinearSolver::Alpha_pt
private

Pointer to the storage for the vector alpha.

Definition at line 397 of file assembly_handler.h.

Referenced by resolve(), solve(), and ~AugmentedBlockFoldLinearSolver().

DoubleVector* oomph::AugmentedBlockFoldLinearSolver::E_pt
private

Pointer to the storage for the vector e.

Definition at line 400 of file assembly_handler.h.

Referenced by solve(), and ~AugmentedBlockFoldLinearSolver().

LinearSolver* oomph::AugmentedBlockFoldLinearSolver::Linear_solver_pt
private

Pointer to the original linear solver.

Definition at line 391 of file assembly_handler.h.

Referenced by linear_solver_pt(), resolve(), and solve().

Problem* oomph::AugmentedBlockFoldLinearSolver::Problem_pt
private

Definition at line 394 of file assembly_handler.h.

Referenced by resolve(), and solve().


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