Ifpack_AdditiveSchwarz: a class to define Additive Schwarz preconditioners of Epetra_RowMatrix's. More...

#include <Ifpack_AdditiveSchwarz.h>

Inheritance diagram for Ifpack_AdditiveSchwarz< T >:

[legend]

Collaboration diagram for Ifpack_AdditiveSchwarz< T >:

[legend]

Public Member Functions
	Ifpack_AdditiveSchwarz (Epetra_RowMatrix *Matrix_in, int OverlapLevel_in=0)
	Ifpack_AdditiveSchwarz constructor with given Epetra_RowMatrix.
virtual	~Ifpack_AdditiveSchwarz ()
	Destructor.
virtual int	SetUseTranspose (bool UseTranspose_in)
	If set true, transpose of this operator will be applied (not implemented).
virtual int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Applies the matrix to X, returns the result in Y.
virtual int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Applies the preconditioner to X, returns the result in Y.
virtual double	NormInf () const
	Returns the infinity norm of the global matrix (not implemented).
virtual const char *	Label () const
	Returns a character string describing the operator.
virtual bool	UseTranspose () const
	Returns the current UseTranspose setting.
virtual bool	HasNormInf () const
	Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual const Epetra_Comm &	Comm () const
	Returns a pointer to the Epetra_Comm communicator associated with this operator.
virtual const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this operator.
virtual const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this operator.
virtual bool	IsInitialized () const
	Returns `true` if the preconditioner has been successfully initialized.
virtual bool	IsComputed () const
	Returns `true` if the preconditioner has been successfully computed.
virtual int	SetParameters (Teuchos::ParameterList &List)
	Sets the parameters.
virtual int	Initialize ()
	Initialized the preconditioner.
virtual int	Compute ()
	Computes the preconditioner.
virtual double	Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix_in=0)
	Computes the estimated condition number and returns its value.
virtual double	Condest () const
	Returns the estimated condition number, or -1.0 if not computed.
virtual const Epetra_RowMatrix &	Matrix () const
	Returns a refernence to the internally stored matrix.
virtual bool	IsOverlapping () const
	Returns `true` is an overlapping matrix is present.
virtual std::ostream &	Print (std::ostream &) const
	Prints major information about this preconditioner.
virtual const T *	Inverse () const
virtual int	NumInitialize () const
	Returns the number of calls to Initialize().
virtual int	NumCompute () const
	Returns the number of calls to Compute().
virtual int	NumApplyInverse () const
	Returns the number of calls to ApplyInverse().
virtual double	InitializeTime () const
	Returns the time spent in Initialize().
virtual double	ComputeTime () const
	Returns the time spent in Compute().
virtual double	ApplyInverseTime () const
	Returns the time spent in ApplyInverse().
virtual double	InitializeFlops () const
	Returns the number of flops in the initialization phase.
virtual double	ComputeFlops () const
	Returns the number of flops in the computation phase.
virtual double	ApplyInverseFlops () const
	Returns the number of flops in the application of the preconditioner.
virtual int	OverlapLevel () const
	Returns the level of overlap.
virtual const Teuchos::ParameterList &	List () const
	Returns a reference to the internally stored list.

Protected Member Functions
	Ifpack_AdditiveSchwarz (const Ifpack_AdditiveSchwarz &RHS)
	Copy constructor (should never be used).
int	Setup ()
	Sets up the localized matrix and the singleton filter.

Protected Attributes
Teuchos::RefCountPtr< const Epetra_RowMatrix >	Matrix_
	Pointers to the matrix to be preconditioned.
Teuchos::RefCountPtr< Ifpack_OverlappingRowMatrix >	OverlappingMatrix_
	Pointers to the overlapping matrix.
Teuchos::RefCountPtr< Ifpack_LocalFilter >	LocalizedMatrix_
	Localized version of Matrix_ or OverlappingMatrix_.
std::string	Label_
	Contains the label of `this` object.
bool	IsInitialized_
	If true, the preconditioner has been successfully initialized.
bool	IsComputed_
	If true, the preconditioner has been successfully computed.
bool	UseTranspose_
	If `true`, solve with the transpose (not supported by all solvers).
bool	IsOverlapping_
	If true, overlapping is used.
int	OverlapLevel_
	Level of overlap among the processors.
Teuchos::ParameterList	List_
	Stores a copy of the list given in SetParameters().
Epetra_CombineMode	CombineMode_
	Combine mode for off-process elements (only if overlap is used).
double	Condest_
	Contains the estimated condition number.
bool	ComputeCondest_
	If `true`, compute the condition number estimate each time Compute() is called.
bool	UseReordering_
	If `true`, reorder the local matrix.
std::string	ReorderingType_
	Type of reordering of the local matrix.
Teuchos::RefCountPtr< Ifpack_Reordering >	Reordering_
	Pointer to a reordering object.
Teuchos::RefCountPtr< Ifpack_ReorderFilter >	ReorderedLocalizedMatrix_
	Pointer to the reorderd matrix.
bool	FilterSingletons_
	Filter for singletons.
Teuchos::RefCountPtr< Ifpack_SingletonFilter >	SingletonFilter_
	filtering object.
int	NumInitialize_
	Contains the number of successful calls to Initialize().
int	NumCompute_
	Contains the number of successful call to Compute().
int	NumApplyInverse_
	Contains the number of successful call to ApplyInverse().
double	InitializeTime_
	Contains the time for all successful calls to Initialize().
double	ComputeTime_
	Contains the time for all successful calls to Compute().
double	ApplyInverseTime_
	Contains the time for all successful calls to ApplyInverse().
double	InitializeFlops_
	Contains the number of flops for Initialize().
double	ComputeFlops_
	Contains the number of flops for Compute().
double	ApplyInverseFlops_
	Contain sthe number of flops for ApplyInverse().
Teuchos::RefCountPtr< Epetra_Time >	Time_
	Object used for timing purposes.
Teuchos::RefCountPtr< T >	Inverse_
	Pointer to the local solver.

Detailed Description

template<typename T>
class Ifpack_AdditiveSchwarz< T >

Ifpack_AdditiveSchwarz: a class to define Additive Schwarz preconditioners of Epetra_RowMatrix's.

Class Ifpack_AdditiveSchwarz enables the construction of Additive Schwarz (one-level overlapping domain decomposition) preconditioners, for a given Epetra_RowMatrix. Ifpack_AdditiveSchwarz is derived from Ifpack_Preconditioner, itself derived from Epetra_Operator. An application of the Additive Schwarz preconditioner can be obtained by calling method ApplyInverse().

One-level overlapping domain decomposition preconditioners use local solvers, of Dirichlet type. This means that the inverse of the local matrix (with minimal or wider overlap) is applied to the residual to be preconditioned.

The preconditioner can be written as:

\[P_{AS}^{-1} = \sum_{i=1}^M P_i A_i^{-1} R_i , \]

where \(M\) is the number of subdomains (that is, the number of processors in the computation), \(R_i\) is an operator that restricts the global vector to the vector lying on subdomain \(i\), \(P_i\) is the prolongator operator, and

\[A_i = R_i A P_i. \]

The construction of Schwarz preconditioners is mainly composed by two steps:

definition of the restriction and prolongation operator \(R_i\) and \(R_i^T\). If minimal overlap is chosen, their implementation is trivial, \(R_i\) will return all the local components. For wider overlaps, instead, Epetra_Import and Epetra_Export will be used to import/export data. The user must provide both the matrix to be preconditioned (which is suppose to have minimal-overlap) and the matrix with wider overlap.
definition of a technique to apply the inverse of \(A_i\). To solve on each subdomain, the user can adopt any class, derived from Ifpack_Preconditioner. This can be easily accomplished, as Ifpack_AdditiveSchwarz is templated with the solver for each subdomain.

The local matrix \(A_i\) can be filtered, to eliminate singletons, and reordered. At the present time, RCM and METIS can be used to reorder the local matrix.

The complete list of supported parameters is reported in page List of Supported Parameters.

Author: Marzio Sala, SNL 9214.

Date: Last modified on 22-Jan-05.

Definition at line 148 of file Ifpack_AdditiveSchwarz.h.

Constructor & Destructor Documentation

◆ Ifpack_AdditiveSchwarz() [1/2]

template<typename T>

Ifpack_AdditiveSchwarz< T >::Ifpack_AdditiveSchwarz	(	Epetra_RowMatrix *	Matrix_in,
		int	OverlapLevel_in = 0 )

Ifpack_AdditiveSchwarz constructor with given Epetra_RowMatrix.

Creates an Ifpack_AdditiveSchwarz preconditioner with overlap. To use minimal-overlap, OverlappingMatrix is omitted (as defaulted to 0).

Parameters

Matrix	- (In) Pointer to matrix to be preconditioned
OverlappingMatrix	- (In) Pointer to the matrix extended with the desired level of overlap.

Definition at line 514 of file Ifpack_AdditiveSchwarz.h.

References ApplyInverseFlops_, ApplyInverseTime_, CombineMode_, ComputeCondest_, ComputeFlops_, ComputeTime_, Condest_, FilterSingletons_, InitializeFlops_, InitializeTime_, IsComputed_, IsInitialized_, IsOverlapping_, Matrix_, NumApplyInverse_, NumCompute_, NumInitialize_, OverlapLevel_, ReorderingType_, SetParameters(), UseReordering_, and UseTranspose_.

Referenced by Ifpack_AdditiveSchwarz().

◆ ~Ifpack_AdditiveSchwarz()

template<typename T>

virtual Ifpack_AdditiveSchwarz< T >::~Ifpack_AdditiveSchwarz ( )

inlinevirtual

Destructor.

Definition at line 169 of file Ifpack_AdditiveSchwarz.h.

◆ Ifpack_AdditiveSchwarz() [2/2]

template<typename T>

Ifpack_AdditiveSchwarz< T >::Ifpack_AdditiveSchwarz ( const Ifpack_AdditiveSchwarz< T > & RHS )

inlineprotected

Copy constructor (should never be used).

Definition at line 388 of file Ifpack_AdditiveSchwarz.h.

References Ifpack_AdditiveSchwarz().

Member Function Documentation

◆ Apply()

template<typename T>

int Ifpack_AdditiveSchwarz< T >::Apply	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y ) const

virtual

Applies the matrix to X, returns the result in Y.

Parameters

X	- (In) A Epetra_MultiVector of dimension NumVectors to multiply with matrix.
Y	-(Out) A Epetra_MultiVector of dimension NumVectors containing the result.

Returns: Integer error code, set to 0 if successful.

Implements Epetra_Operator.

Definition at line 951 of file Ifpack_AdditiveSchwarz.h.

References Matrix_.

◆ ApplyInverse()

template<typename T>

int Ifpack_AdditiveSchwarz< T >::ApplyInverse	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y ) const

virtual

Applies the preconditioner to X, returns the result in Y.

Parameters

X	- (In) A Epetra_MultiVector of dimension NumVectors to be preconditioned.
Y	-(Out) A Epetra_MultiVector of dimension NumVectors containing result.

Returns: Integer error code, set to 0 if successful.

Warning: In order to work with AztecOO, any implementation of this method must support the case where X and Y are the same object.

Implements Ifpack_Preconditioner.

Definition at line 1009 of file Ifpack_AdditiveSchwarz.h.

References ApplyInverseFlops_, ApplyInverseTime_, CombineMode_, Comm(), FilterSingletons_, Inverse_, IsComputed(), IsOverlapping(), NumApplyInverse_, Epetra_MultiVector::NumVectors(), OverlappingMatrix_, Reordering_, SingletonFilter_, Time_, and UseReordering_.

◆ ApplyInverseFlops()

template<typename T>

virtual double Ifpack_AdditiveSchwarz< T >::ApplyInverseFlops ( ) const

inlinevirtual

Returns the number of flops in the application of the preconditioner.

Implements Ifpack_Preconditioner.

Definition at line 364 of file Ifpack_AdditiveSchwarz.h.

References ApplyInverseFlops_.

Referenced by Print().

◆ ApplyInverseTime()

template<typename T>

virtual double Ifpack_AdditiveSchwarz< T >::ApplyInverseTime ( ) const

inlinevirtual

Returns the time spent in ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 348 of file Ifpack_AdditiveSchwarz.h.

References ApplyInverseTime_.

Referenced by Print().

◆ Comm()

template<typename T>

const Epetra_Comm & Ifpack_AdditiveSchwarz< T >::Comm ( ) const

virtual

Returns a pointer to the Epetra_Comm communicator associated with this operator.

Implements Epetra_Operator.

Definition at line 988 of file Ifpack_AdditiveSchwarz.h.

References Matrix_.

Referenced by ApplyInverse(), Compute(), Initialize(), and Print().

◆ Compute()

template<typename T>

int Ifpack_AdditiveSchwarz< T >::Compute ( )

virtual

Computes the preconditioner.

Implements Ifpack_Preconditioner.

Definition at line 895 of file Ifpack_AdditiveSchwarz.h.

References Comm(), ComputeCondest_, ComputeFlops_, ComputeTime_, Condest(), Condest_, Initialize(), Inverse_, IsComputed_, IsInitialized(), Label_, NumCompute_, OverlapLevel_, ReorderingType_, Time_, and UseReordering_.

◆ ComputeFlops()

template<typename T>

virtual double Ifpack_AdditiveSchwarz< T >::ComputeFlops ( ) const

inlinevirtual

Returns the number of flops in the computation phase.

Implements Ifpack_Preconditioner.

Definition at line 359 of file Ifpack_AdditiveSchwarz.h.

References ComputeFlops_.

Referenced by Print().

◆ ComputeTime()

template<typename T>

virtual double Ifpack_AdditiveSchwarz< T >::ComputeTime ( ) const

inlinevirtual

Returns the time spent in Compute().

Implements Ifpack_Preconditioner.

Definition at line 342 of file Ifpack_AdditiveSchwarz.h.

References ComputeTime_.

Referenced by Print().

◆ Condest() [1/2]

template<typename T>

virtual double Ifpack_AdditiveSchwarz< T >::Condest ( ) const

inlinevirtual

Returns the estimated condition number, or -1.0 if not computed.

Implements Ifpack_Preconditioner.

Definition at line 292 of file Ifpack_AdditiveSchwarz.h.

References Condest_.

◆ Condest() [2/2]

template<typename T>

double Ifpack_AdditiveSchwarz< T >::Condest	(	const Ifpack_CondestType	CT = Ifpack_Cheap,
		const int	MaxIters = 1550,
		const double	Tol = 1e-9,
		Epetra_RowMatrix *	Matrix_in = 0 )

virtual

Computes the estimated condition number and returns its value.

Implements Ifpack_Preconditioner.

Definition at line 1229 of file Ifpack_AdditiveSchwarz.h.

References Condest_, and IsComputed().

Referenced by Compute().

◆ HasNormInf()

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::HasNormInf ( ) const

virtual

Returns true if the this object can provide an approximate Inf-norm, false otherwise.

Implements Epetra_Operator.

Definition at line 981 of file Ifpack_AdditiveSchwarz.h.

◆ Initialize()

template<typename T>

int Ifpack_AdditiveSchwarz< T >::Initialize ( )

virtual

Initialized the preconditioner.

Implements Ifpack_Preconditioner.

Definition at line 803 of file Ifpack_AdditiveSchwarz.h.

References Comm(), Condest_, InitializeFlops_, InitializeTime_, Inverse_, IsComputed_, IsInitialized_, IsOverlapping_, Label_, List_, LocalizedMatrix_, Matrix_, NumInitialize_, OverlapLevel_, OverlappingMatrix_, Setup(), Time_, and UseTranspose().

Referenced by Compute().

◆ InitializeFlops()

template<typename T>

virtual double Ifpack_AdditiveSchwarz< T >::InitializeFlops ( ) const

inlinevirtual

Returns the number of flops in the initialization phase.

Implements Ifpack_Preconditioner.

Definition at line 354 of file Ifpack_AdditiveSchwarz.h.

References InitializeFlops_.

Referenced by Print().

◆ InitializeTime()

template<typename T>

virtual double Ifpack_AdditiveSchwarz< T >::InitializeTime ( ) const

inlinevirtual

Returns the time spent in Initialize().

Implements Ifpack_Preconditioner.

Definition at line 336 of file Ifpack_AdditiveSchwarz.h.

References InitializeTime_.

Referenced by Print().

◆ Inverse()

template<typename T>

virtual const T * Ifpack_AdditiveSchwarz< T >::Inverse ( ) const

inlinevirtual

Definition at line 312 of file Ifpack_AdditiveSchwarz.h.

◆ IsComputed()

template<typename T>

virtual bool Ifpack_AdditiveSchwarz< T >::IsComputed ( ) const

inlinevirtual

Returns true if the preconditioner has been successfully computed.

Implements Ifpack_Preconditioner.

Definition at line 248 of file Ifpack_AdditiveSchwarz.h.

References IsComputed_.

Referenced by ApplyInverse(), and Condest().

◆ IsInitialized()

template<typename T>

virtual bool Ifpack_AdditiveSchwarz< T >::IsInitialized ( ) const

inlinevirtual

Returns true if the preconditioner has been successfully initialized.

Implements Ifpack_Preconditioner.

Definition at line 242 of file Ifpack_AdditiveSchwarz.h.

References IsInitialized_.

Referenced by Compute().

◆ IsOverlapping()

template<typename T>

virtual bool Ifpack_AdditiveSchwarz< T >::IsOverlapping ( ) const

inlinevirtual

Returns true is an overlapping matrix is present.

Definition at line 304 of file Ifpack_AdditiveSchwarz.h.

References IsOverlapping_.

Referenced by ApplyInverse().

◆ Label()

template<typename T>

const char * Ifpack_AdditiveSchwarz< T >::Label ( ) const

virtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 967 of file Ifpack_AdditiveSchwarz.h.

References Label_.

◆ List()

template<typename T>

virtual const Teuchos::ParameterList & Ifpack_AdditiveSchwarz< T >::List ( ) const

inlinevirtual

Returns a reference to the internally stored list.

Definition at line 376 of file Ifpack_AdditiveSchwarz.h.

References List_.

◆ Matrix()

template<typename T>

virtual const Epetra_RowMatrix & Ifpack_AdditiveSchwarz< T >::Matrix ( ) const

inlinevirtual

Returns a refernence to the internally stored matrix.

Implements Ifpack_Preconditioner.

Definition at line 298 of file Ifpack_AdditiveSchwarz.h.

References Matrix_.

Referenced by Print().

◆ NormInf()

template<typename T>

double Ifpack_AdditiveSchwarz< T >::NormInf ( ) const

virtual

Returns the infinity norm of the global matrix (not implemented).

Implements Epetra_Operator.

Definition at line 960 of file Ifpack_AdditiveSchwarz.h.

◆ NumApplyInverse()

template<typename T>

virtual int Ifpack_AdditiveSchwarz< T >::NumApplyInverse ( ) const

inlinevirtual

Returns the number of calls to ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 330 of file Ifpack_AdditiveSchwarz.h.

References NumApplyInverse_.

Referenced by Print().

◆ NumCompute()

template<typename T>

virtual int Ifpack_AdditiveSchwarz< T >::NumCompute ( ) const

inlinevirtual

Returns the number of calls to Compute().

Implements Ifpack_Preconditioner.

Definition at line 324 of file Ifpack_AdditiveSchwarz.h.

References NumCompute_.

Referenced by Print().

◆ NumInitialize()

template<typename T>

virtual int Ifpack_AdditiveSchwarz< T >::NumInitialize ( ) const

inlinevirtual

Returns the number of calls to Initialize().

Implements Ifpack_Preconditioner.

Definition at line 318 of file Ifpack_AdditiveSchwarz.h.

References NumInitialize_.

Referenced by Print().

◆ OperatorDomainMap()

template<typename T>

const Epetra_Map & Ifpack_AdditiveSchwarz< T >::OperatorDomainMap ( ) const

virtual

Returns the Epetra_Map object associated with the domain of this operator.

Implements Epetra_Operator.

Definition at line 995 of file Ifpack_AdditiveSchwarz.h.

References Matrix_.

◆ OperatorRangeMap()

template<typename T>

const Epetra_Map & Ifpack_AdditiveSchwarz< T >::OperatorRangeMap ( ) const

virtual

Returns the Epetra_Map object associated with the range of this operator.

Implements Epetra_Operator.

Definition at line 1002 of file Ifpack_AdditiveSchwarz.h.

References Matrix_.

◆ OverlapLevel()

template<typename T>

virtual int Ifpack_AdditiveSchwarz< T >::OverlapLevel ( ) const

inlinevirtual

Returns the level of overlap.

Definition at line 370 of file Ifpack_AdditiveSchwarz.h.

References OverlapLevel_.

◆ Print()

template<typename T>

std::ostream & Ifpack_AdditiveSchwarz< T >::Print ( std::ostream & os ) const

virtual

Prints major information about this preconditioner.

Implements Ifpack_Preconditioner.

Definition at line 1148 of file Ifpack_AdditiveSchwarz.h.

References ApplyInverseFlops(), ApplyInverseTime(), CombineMode_, Comm(), ComputeFlops(), ComputeTime(), Condest_, InitializeFlops(), InitializeTime(), Matrix(), Matrix_, NumApplyInverse(), NumCompute(), NumInitialize(), and OverlapLevel_.

◆ SetParameters()

template<typename T>

int Ifpack_AdditiveSchwarz< T >::SetParameters ( Teuchos::ParameterList & List )

virtual

Sets the parameters.

Sets the parameter for the additive Schwarz preconditioner, as well as for all the preconditioners that may need to be defined on each subblock. Parameters accepted by List are:

"schwarz: combine mode" : It must be an Epetra_CombineMode. Default: Zero. It Can be assume of the following values:
- Add: Components on the receiving processor will be added together;
- Zero: Off-processor components will be ignored;
- Insert: Off-processor components will be inserted into locations on receiving processor replacing existing values.
- Average: Off-processor components will be averaged with existing;
- AbsMax: Magnitudes of Off-processor components will be maxed with magnitudes of existing components on the receiving processor.
"schwarz: compute condest" : if true, Compute() will estimate the condition number of the preconditioner. Default: true.

Implements Ifpack_Preconditioner.

Definition at line 725 of file Ifpack_AdditiveSchwarz.h.

References CombineMode_, ComputeCondest_, FilterSingletons_, IsOverlapping_, List_, Matrix_, ReorderingType_, and UseReordering_.

Referenced by Ifpack_AdditiveSchwarz().

◆ Setup()

template<typename T>

int Ifpack_AdditiveSchwarz< T >::Setup ( )

protected

Sets up the localized matrix and the singleton filter.

Definition at line 564 of file Ifpack_AdditiveSchwarz.h.

References FilterSingletons_, Inverse_, List_, LocalizedMatrix_, Epetra_SrcDistObject::Map(), Matrix_, OverlappingMatrix_, ReorderedLocalizedMatrix_, Reordering_, ReorderingType_, Epetra_RowMatrix::RowMatrixRowMap(), SingletonFilter_, and UseReordering_.

Referenced by Initialize().

◆ SetUseTranspose()

template<typename T>

int Ifpack_AdditiveSchwarz< T >::SetUseTranspose ( bool UseTranspose_in )

virtual

If set true, transpose of this operator will be applied (not implemented).

This flag allows the transpose of the given operator to be used implicitly.

Parameters

UseTranspose_in - (In) If true, multiply by the transpose of operator, otherwise just use operator.

Returns: Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.

Implements Epetra_Operator.

Definition at line 937 of file Ifpack_AdditiveSchwarz.h.

References Inverse_, and UseTranspose_.

◆ UseTranspose()

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 974 of file Ifpack_AdditiveSchwarz.h.

References UseTranspose_.

Referenced by Initialize().

Member Data Documentation

◆ ApplyInverseFlops_

template<typename T>

double Ifpack_AdditiveSchwarz< T >::ApplyInverseFlops_

mutableprotected

Contain sthe number of flops for ApplyInverse().

Definition at line 495 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), ApplyInverseFlops(), and Ifpack_AdditiveSchwarz().

◆ ApplyInverseTime_

template<typename T>

double Ifpack_AdditiveSchwarz< T >::ApplyInverseTime_

mutableprotected

Contains the time for all successful calls to ApplyInverse().

Definition at line 489 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), ApplyInverseTime(), and Ifpack_AdditiveSchwarz().

◆ CombineMode_

template<typename T>

Epetra_CombineMode Ifpack_AdditiveSchwarz< T >::CombineMode_

protected

Combine mode for off-process elements (only if overlap is used).

Definition at line 461 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), Ifpack_AdditiveSchwarz(), Print(), and SetParameters().

◆ ComputeCondest_

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::ComputeCondest_

protected

If true, compute the condition number estimate each time Compute() is called.

Definition at line 465 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), Ifpack_AdditiveSchwarz(), and SetParameters().

◆ ComputeFlops_

template<typename T>

double Ifpack_AdditiveSchwarz< T >::ComputeFlops_

protected

Contains the number of flops for Compute().

Definition at line 493 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), ComputeFlops(), and Ifpack_AdditiveSchwarz().

◆ ComputeTime_

template<typename T>

double Ifpack_AdditiveSchwarz< T >::ComputeTime_

protected

Contains the time for all successful calls to Compute().

Definition at line 487 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), ComputeTime(), and Ifpack_AdditiveSchwarz().

◆ Condest_

template<typename T>

double Ifpack_AdditiveSchwarz< T >::Condest_

protected

Contains the estimated condition number.

Definition at line 463 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), Condest(), Condest(), Ifpack_AdditiveSchwarz(), Initialize(), and Print().

◆ FilterSingletons_

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::FilterSingletons_

protected

Filter for singletons.

Definition at line 475 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), Ifpack_AdditiveSchwarz(), SetParameters(), and Setup().

◆ InitializeFlops_

template<typename T>

double Ifpack_AdditiveSchwarz< T >::InitializeFlops_

protected

Contains the number of flops for Initialize().

Definition at line 491 of file Ifpack_AdditiveSchwarz.h.

Referenced by Ifpack_AdditiveSchwarz(), Initialize(), and InitializeFlops().

◆ InitializeTime_

template<typename T>

double Ifpack_AdditiveSchwarz< T >::InitializeTime_

protected

Contains the time for all successful calls to Initialize().

Definition at line 485 of file Ifpack_AdditiveSchwarz.h.

Referenced by Ifpack_AdditiveSchwarz(), Initialize(), and InitializeTime().

◆ Inverse_

template<typename T>

Teuchos::RefCountPtr<T> Ifpack_AdditiveSchwarz< T >::Inverse_

protected

Pointer to the local solver.

Definition at line 499 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), Compute(), Initialize(), Setup(), and SetUseTranspose().

◆ IsComputed_

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::IsComputed_

protected

If true, the preconditioner has been successfully computed.

Definition at line 451 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), Ifpack_AdditiveSchwarz(), Initialize(), and IsComputed().

◆ IsInitialized_

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::IsInitialized_

protected

If true, the preconditioner has been successfully initialized.

Definition at line 449 of file Ifpack_AdditiveSchwarz.h.

Referenced by Ifpack_AdditiveSchwarz(), Initialize(), and IsInitialized().

◆ IsOverlapping_

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::IsOverlapping_

protected

If true, overlapping is used.

Definition at line 455 of file Ifpack_AdditiveSchwarz.h.

Referenced by Ifpack_AdditiveSchwarz(), Initialize(), IsOverlapping(), and SetParameters().

◆ Label_

template<typename T>

std::string Ifpack_AdditiveSchwarz< T >::Label_

protected

Contains the label of this object.

Definition at line 447 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), Initialize(), and Label().

◆ List_

template<typename T>

Teuchos::ParameterList Ifpack_AdditiveSchwarz< T >::List_

protected

Stores a copy of the list given in SetParameters().

Definition at line 459 of file Ifpack_AdditiveSchwarz.h.

Referenced by Initialize(), List(), SetParameters(), and Setup().

◆ LocalizedMatrix_

template<typename T>

Teuchos::RefCountPtr<Ifpack_LocalFilter> Ifpack_AdditiveSchwarz< T >::LocalizedMatrix_

protected

Localized version of Matrix_ or OverlappingMatrix_.

Definition at line 430 of file Ifpack_AdditiveSchwarz.h.

Referenced by Initialize(), and Setup().

◆ Matrix_

template<typename T>

Teuchos::RefCountPtr<const Epetra_RowMatrix> Ifpack_AdditiveSchwarz< T >::Matrix_

protected

Pointers to the matrix to be preconditioned.

Definition at line 399 of file Ifpack_AdditiveSchwarz.h.

Referenced by Apply(), Comm(), Ifpack_AdditiveSchwarz(), Initialize(), Matrix(), OperatorDomainMap(), OperatorRangeMap(), Print(), SetParameters(), and Setup().

◆ NumApplyInverse_

template<typename T>

int Ifpack_AdditiveSchwarz< T >::NumApplyInverse_

mutableprotected

Contains the number of successful call to ApplyInverse().

Definition at line 483 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), Ifpack_AdditiveSchwarz(), and NumApplyInverse().

◆ NumCompute_

template<typename T>

int Ifpack_AdditiveSchwarz< T >::NumCompute_

protected

Contains the number of successful call to Compute().

Definition at line 481 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), Ifpack_AdditiveSchwarz(), and NumCompute().

◆ NumInitialize_

template<typename T>

int Ifpack_AdditiveSchwarz< T >::NumInitialize_

protected

Contains the number of successful calls to Initialize().

Definition at line 479 of file Ifpack_AdditiveSchwarz.h.

Referenced by Ifpack_AdditiveSchwarz(), Initialize(), and NumInitialize().

◆ OverlapLevel_

template<typename T>

int Ifpack_AdditiveSchwarz< T >::OverlapLevel_

protected

Level of overlap among the processors.

Definition at line 457 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), Ifpack_AdditiveSchwarz(), Initialize(), OverlapLevel(), and Print().

◆ OverlappingMatrix_

template<typename T>

Teuchos::RefCountPtr<Ifpack_OverlappingRowMatrix> Ifpack_AdditiveSchwarz< T >::OverlappingMatrix_

protected

Pointers to the overlapping matrix.

Definition at line 401 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), Initialize(), and Setup().

◆ ReorderedLocalizedMatrix_

template<typename T>

Teuchos::RefCountPtr<Ifpack_ReorderFilter> Ifpack_AdditiveSchwarz< T >::ReorderedLocalizedMatrix_

protected

Pointer to the reorderd matrix.

Definition at line 473 of file Ifpack_AdditiveSchwarz.h.

Referenced by Setup().

◆ Reordering_

template<typename T>

Teuchos::RefCountPtr<Ifpack_Reordering> Ifpack_AdditiveSchwarz< T >::Reordering_

protected

Pointer to a reordering object.

Definition at line 471 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), and Setup().

◆ ReorderingType_

template<typename T>

std::string Ifpack_AdditiveSchwarz< T >::ReorderingType_

protected

Type of reordering of the local matrix.

Definition at line 469 of file Ifpack_AdditiveSchwarz.h.

Referenced by Compute(), Ifpack_AdditiveSchwarz(), SetParameters(), and Setup().

◆ SingletonFilter_

template<typename T>

Teuchos::RefCountPtr<Ifpack_SingletonFilter> Ifpack_AdditiveSchwarz< T >::SingletonFilter_

protected

filtering object.

Definition at line 477 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), and Setup().

◆ Time_

template<typename T>

Teuchos::RefCountPtr<Epetra_Time> Ifpack_AdditiveSchwarz< T >::Time_

protected

Object used for timing purposes.

Definition at line 497 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), Compute(), and Initialize().

◆ UseReordering_

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::UseReordering_

protected

If true, reorder the local matrix.

Definition at line 467 of file Ifpack_AdditiveSchwarz.h.

Referenced by ApplyInverse(), Compute(), Ifpack_AdditiveSchwarz(), SetParameters(), and Setup().

◆ UseTranspose_

template<typename T>

bool Ifpack_AdditiveSchwarz< T >::UseTranspose_

protected

If true, solve with the transpose (not supported by all solvers).

Definition at line 453 of file Ifpack_AdditiveSchwarz.h.

Referenced by Ifpack_AdditiveSchwarz(), SetUseTranspose(), and UseTranspose().

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

Ifpack_AdditiveSchwarz.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Ifpack_AdditiveSchwarz() [1/2]

◆ ~Ifpack_AdditiveSchwarz()

◆ Ifpack_AdditiveSchwarz() [2/2]

Member Function Documentation

◆ Apply()

◆ ApplyInverse()

◆ ApplyInverseFlops()

◆ ApplyInverseTime()

◆ Comm()

◆ Compute()

◆ ComputeFlops()

◆ ComputeTime()

◆ Condest() [1/2]

◆ Condest() [2/2]

◆ HasNormInf()

◆ Initialize()

◆ InitializeFlops()

◆ InitializeTime()

◆ Inverse()

◆ IsComputed()

◆ IsInitialized()

◆ IsOverlapping()

◆ Label()

◆ List()

◆ Matrix()

◆ NormInf()

◆ NumApplyInverse()

◆ NumCompute()

◆ NumInitialize()

◆ OperatorDomainMap()

◆ OperatorRangeMap()

◆ OverlapLevel()

◆ Print()

◆ SetParameters()

◆ Setup()

◆ SetUseTranspose()

◆ UseTranspose()

Member Data Documentation

◆ ApplyInverseFlops_

◆ ApplyInverseTime_

◆ CombineMode_

◆ ComputeCondest_

◆ ComputeFlops_

◆ ComputeTime_

◆ Condest_

◆ FilterSingletons_

◆ InitializeFlops_

◆ InitializeTime_

◆ Inverse_

◆ IsComputed_

◆ IsInitialized_

◆ IsOverlapping_

◆ Label_

◆ List_

◆ LocalizedMatrix_

◆ Matrix_

◆ NumApplyInverse_

◆ NumCompute_

◆ NumInitialize_

◆ OverlapLevel_

◆ OverlappingMatrix_

◆ ReorderedLocalizedMatrix_

◆ Reordering_

◆ ReorderingType_

◆ SingletonFilter_

◆ Time_

◆ UseReordering_

◆ UseTranspose_