Helmholtz smoother class: The smoother class is designed for the Helmholtz equation to be used in conjunction with multigrid. The action of the smoother should reduce the high frequency errors. These methods are inefficient as stand-alone solvers. More...
#include <complex_smoother.h>
Inheritance diagram for oomph::HelmholtzSmoother:
Public Member Functions | |
| HelmholtzSmoother () | |
| Empty constructor. More... | |
| virtual | ~HelmholtzSmoother () |
| Virtual empty destructor. More... | |
| virtual void | complex_smoother_solve (const Vector< DoubleVector > &rhs, Vector< DoubleVector > &result)=0 |
| The smoother_solve function performs fixed number of iterations on the system A*result=rhs. The number of (smoothing) iterations is the same as the max. number of iterations in the underlying IterativeLinearSolver class. More... | |
| virtual void | complex_smoother_setup (Vector< CRDoubleMatrix * > matrix_pt)=0 |
| Setup the smoother for the matrix specified by the pointer. More... | |
| void | complex_matrix_multiplication (Vector< CRDoubleMatrix * > matrices_pt, const Vector< DoubleVector > &x, Vector< DoubleVector > &soln) |
| Helper function to calculate a complex matrix-vector product. Assumes the matrix has been provided as a Vector of length two; the first entry containing the real part of the system matrix and the second entry containing the imaginary part. More... | |
| template<typename MATRIX > | |
| void | check_validity_of_solve_helper_inputs (CRDoubleMatrix *const &real_matrix_pt, CRDoubleMatrix *const &imag_matrix_pt, const Vector< DoubleVector > &rhs, Vector< DoubleVector > &solution, const double &n_dof) |
| Self-test to check that all the dimensions of the inputs to solve helper are consistent and everything that needs to be built, is. More... | |
| Public Member Functions inherited from oomph::IterativeLinearSolver | |
| IterativeLinearSolver () | |
| Constructor: Set (default) trivial preconditioner and set defaults for tolerance and max. number of iterations. More... | |
| IterativeLinearSolver (const IterativeLinearSolver &)=delete | |
| Broken copy constructor. More... | |
| void | operator= (const IterativeLinearSolver &)=delete |
| Broken assignment operator. More... | |
| virtual | ~IterativeLinearSolver () |
| Destructor (empty) More... | |
| Preconditioner *& | preconditioner_pt () |
| Access function to preconditioner. More... | |
| Preconditioner *const & | preconditioner_pt () const |
| Access function to preconditioner (const version) More... | |
| double & | tolerance () |
| Access to convergence tolerance. More... | |
| unsigned & | max_iter () |
| Access to max. number of iterations. More... | |
| virtual unsigned | iterations () const =0 |
| Number of iterations taken. More... | |
| void | enable_doc_convergence_history () |
| Enable documentation of the convergence history. More... | |
| void | disable_doc_convergence_history () |
| Disable documentation of the convergence history. More... | |
| void | open_convergence_history_file_stream (const std::string &file_name, const std::string &zone_title="") |
| Write convergence history into file with specified filename (automatically switches on doc). Optional second argument is a string that can be used (as a zone title) to identify what case we're running (e.g. what combination of linear solver and preconditioner or parameter values are used). More... | |
| void | close_convergence_history_file_stream () |
| Close convergence history output stream. More... | |
| double | jacobian_setup_time () const |
| returns the time taken to assemble the jacobian matrix and residual vector More... | |
| double | linear_solver_solution_time () const |
| return the time taken to solve the linear system More... | |
| virtual double | preconditioner_setup_time () const |
| returns the the time taken to setup the preconditioner More... | |
| void | enable_setup_preconditioner_before_solve () |
| Setup the preconditioner before the solve. More... | |
| void | disable_setup_preconditioner_before_solve () |
| Don't set up the preconditioner before the solve. More... | |
| void | enable_error_after_max_iter () |
| Throw an error if we don't converge within max_iter. More... | |
| void | disable_error_after_max_iter () |
| Don't throw an error if we don't converge within max_iter (default). More... | |
| void | enable_iterative_solver_as_preconditioner () |
| Enables the iterative solver be used as preconditioner (when calling the solve method it bypass the setup solver method – currently only used by Trilinos solver —) More... | |
| void | disable_iterative_solver_as_preconditioner () |
| Disables the iterative solver be used as preconditioner (when calling the solve method it bypass the setup solver method – currently only used by Trilinos 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 (Problem *const &problem_pt, DoubleVector &result)=0 |
| 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... | |
| virtual 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... | |
| virtual 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. 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... | |
| 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 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 Attributes | |
| bool | Use_as_smoother |
| When a derived class object is being used as a smoother in the MG algorithm the residual norm does not need to be calculated. This boolean is used as a flag to indicate this in solve_helper(...) More... | |
| Protected Attributes inherited from oomph::IterativeLinearSolver | |
| bool | Doc_convergence_history |
| Flag indicating if the convergence history is to be documented. More... | |
| std::ofstream | Output_file_stream |
| Output file stream for convergence history. More... | |
| double | Tolerance |
| Convergence tolerance. More... | |
| unsigned | Max_iter |
| Maximum number of iterations. More... | |
| Preconditioner * | Preconditioner_pt |
| Pointer to the preconditioner. More... | |
| double | Jacobian_setup_time |
| Jacobian setup time. More... | |
| double | Solution_time |
| linear solver solution time More... | |
| double | Preconditioner_setup_time |
| Preconditioner setup time. More... | |
| bool | Setup_preconditioner_before_solve |
| indicates whether the preconditioner should be setup before solve. Default = true; More... | |
| bool | Throw_error_after_max_iter |
| Should we throw an error instead of just returning when we hit the max iterations? More... | |
| bool | Use_iterative_solver_as_preconditioner |
| Use the iterative solver as preconditioner. More... | |
| bool | First_time_solve_when_used_as_preconditioner |
| When the iterative solver is used a preconditioner then we call the setup of solver method only once (the first time the solve method is called) 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject | |
| void | clear_distribution () |
| clear the distribution of this distributable linear algebra object More... | |
| Static Protected Attributes inherited from oomph::IterativeLinearSolver | |
| static IdentityPreconditioner | Default_preconditioner |
| Default preconditioner: The base class for preconditioners is a fully functional (if trivial!) preconditioner. More... | |
Detailed Description
Helmholtz smoother class: The smoother class is designed for the Helmholtz equation to be used in conjunction with multigrid. The action of the smoother should reduce the high frequency errors. These methods are inefficient as stand-alone solvers.
Definition at line 45 of file complex_smoother.h.
Constructor & Destructor Documentation
◆ HelmholtzSmoother()
|
inline |
Empty constructor.
Definition at line 49 of file complex_smoother.h.
◆ ~HelmholtzSmoother()
|
inlinevirtual |
Virtual empty destructor.
Definition at line 52 of file complex_smoother.h.
Member Function Documentation
◆ check_validity_of_solve_helper_inputs()
template<typename MATRIX >
| void oomph::HelmholtzSmoother::check_validity_of_solve_helper_inputs | ( | CRDoubleMatrix *const & | real_matrix_pt, |
| CRDoubleMatrix *const & | imag_matrix_pt, | ||
| const Vector< DoubleVector > & | rhs, | ||
| Vector< DoubleVector > & | solution, | ||
| const double & | n_dof | ||
| ) |
Self-test to check that all the dimensions of the inputs to solve helper are consistent and everything that needs to be built, is.
Self-test to be called inside solve_helper to ensure that all inputs are consistent and everything that needs to be built, is.
Definition at line 185 of file complex_smoother.h.
References oomph::DistributableLinearAlgebraObject::distributed(), oomph::DistributableLinearAlgebraObject::distribution_pt(), and oomph::DistributableLinearAlgebraObject::nrow().
◆ complex_matrix_multiplication()
|
inline |
Helper function to calculate a complex matrix-vector product. Assumes the matrix has been provided as a Vector of length two; the first entry containing the real part of the system matrix and the second entry containing the imaginary part.
Definition at line 69 of file complex_smoother.h.
References oomph::DistributableLinearAlgebraObject::distribution_pt().
◆ complex_smoother_setup()
|
pure virtual |
Setup the smoother for the matrix specified by the pointer.
Implemented in oomph::ComplexGMRES< MATRIX >, and oomph::ComplexDampedJacobi< MATRIX >.
◆ complex_smoother_solve()
|
pure virtual |
The smoother_solve function performs fixed number of iterations on the system A*result=rhs. The number of (smoothing) iterations is the same as the max. number of iterations in the underlying IterativeLinearSolver class.
Implemented in oomph::ComplexGMRES< MATRIX >, and oomph::ComplexDampedJacobi< MATRIX >.
Member Data Documentation
◆ Use_as_smoother
|
protected |
When a derived class object is being used as a smoother in the MG algorithm the residual norm does not need to be calculated. This boolean is used as a flag to indicate this in solve_helper(...)
Definition at line 176 of file complex_smoother.h.
Referenced by oomph::ComplexDampedJacobi< MATRIX >::complex_smoother_solve(), and oomph::ComplexGMRES< MATRIX >::complex_smoother_solve().
The documentation for this class was generated from the following file: