Reference documentation for deal.II version 8.5.1
Public Member Functions | Public Attributes | List of all members
SolverCG< VectorType >::AdditionalData Struct Reference

#include <deal.II/lac/solver_cg.h>

Public Member Functions

 AdditionalData (const bool log_coefficients, const bool compute_condition_number=false, const bool compute_all_condition_numbers=false, const bool compute_eigenvalues=false) 1
 
 AdditionalData ()
 

Public Attributes

bool log_coefficients
 
bool compute_condition_number
 
bool compute_all_condition_numbers
 
bool compute_eigenvalues
 

Detailed Description

template<typename VectorType = Vector<double>>
struct SolverCG< VectorType >::AdditionalData

Standardized data struct to pipe additional data to the solver.

Definition at line 110 of file solver_cg.h.

Constructor & Destructor Documentation

◆ AdditionalData() [1/2]

template<typename VectorType = Vector<double>>
SolverCG< VectorType >::AdditionalData::AdditionalData ( const bool  log_coefficients,
const bool  compute_condition_number = false,
const bool  compute_all_condition_numbers = false,
const bool  compute_eigenvalues = false 
)
explicit

Constructor. Initialize data fields. Confer the description of those.

Deprecated:
Instead use: connect_coefficients_slot, connect_condition_number_slot, and connect_eigenvalues_slot.

◆ AdditionalData() [2/2]

template<typename VectorType = Vector<double>>
SolverCG< VectorType >::AdditionalData::AdditionalData ( )

Constructor. Initializes all data fields to false.

Member Data Documentation

◆ log_coefficients

template<typename VectorType = Vector<double>>
bool SolverCG< VectorType >::AdditionalData::log_coefficients

Write coefficients alpha and beta to the log file for later use in eigenvalue estimates.

Definition at line 116 of file solver_cg.h.

◆ compute_condition_number

template<typename VectorType = Vector<double>>
bool SolverCG< VectorType >::AdditionalData::compute_condition_number

Compute the condition number of the projected matrix.

Note
Requires LAPACK support.

Definition at line 123 of file solver_cg.h.

◆ compute_all_condition_numbers

template<typename VectorType = Vector<double>>
bool SolverCG< VectorType >::AdditionalData::compute_all_condition_numbers

Compute the condition number of the projected matrix in each step.

Note
Requires LAPACK support.

Definition at line 130 of file solver_cg.h.

◆ compute_eigenvalues

template<typename VectorType = Vector<double>>
bool SolverCG< VectorType >::AdditionalData::compute_eigenvalues

Compute all eigenvalues of the projected matrix.

Note
Requires LAPACK support.

Definition at line 137 of file solver_cg.h.


The documentation for this struct was generated from the following file: