Belos Package Browser (Single Doxygen Collection) Development
|The template parameter of this class; the type of an inner product result. |
< Scalar >::magnitudeType
|The type of a norm result. |
|Destructor (virtual for memory safety of derived classes) |
|virtual void||operator() (Teuchos::ArrayView< magnitude_type > normsBeforeFirstPass, Teuchos::ArrayView< magnitude_type > normsAfterFirstPass)=0|
|Callback invoked by TsqrOrthoManager on reorthogonalization. |
Interface of callback invoked by TsqrOrthoManager on reorthogonalization.
|Scalar||The same type as the template parameter of TsqrOrthoManagerImpl.|
This callback's operator() is invoked by TsqrOrthoManagerImpl, and therefore by TsqrOrthoManager. It is invoked right after discovering the need to reorthogonalize (for the first time), but before actually reorthogonalizing. It is only invoked if reorthogonalization is necessary. You can define your own callback by implementing this interface.
This callback lets you collect metrics on reorthogonalization. For example, you might want to measure how often it occurs, or by how much the norms of the vectors drop each time. You can use this information in order to adjust parameters (such as the reorthogonalization parameters) dynamically for your desired balance of accuracy and performance. You might also use it as a numerical debugging aid.
Why a reorthgonalization callback, but not other kinds of callbacks? Reorthogonalization is an event that affects performance, and happens in a data-driven way. Even if you have enabled reorthogonalization, it may not happen at all, or only infrequently. Other kinds of data-driven events (such as a normalization discovering numerical rank deficiency) immediately return to the user with useful diagnostics. Reorthogonalization does not; it happens silently. We could have the orthogonalization method itself gather metrics on reorthogonalization, but the callback lets you define what metrics you want to collect and how you want to display them yourself.
|typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Belos::ReorthogonalizationCallback< Scalar >::magnitude_type|
|Belos::ReorthogonalizationCallback< Scalar >::~ReorthogonalizationCallback||(||)||
|virtual void Belos::ReorthogonalizationCallback< Scalar >::operator()||(||Teuchos::ArrayView< magnitude_type >||normsBeforeFirstPass,|
|Teuchos::ArrayView< magnitude_type >||normsAfterFirstPass|
Callback invoked by TsqrOrthoManager on reorthogonalization.