Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ML_Epetra Namespace Reference

ML_Epetra: default namespace for all Epetra interfaces. More...


Classes

class  ML_Epetra::CrsGraphWrapper
 ML_Epetra::CrsGraphWrapper: a class to wrap an Epetra_CrsGraph as Epetra_RowMatrix. More...
class  ML_Epetra::Ifpack_ML
 Wraps an ML preconditioner as an Ifpack_Preconditioner. More...
class  ML_Epetra::MultiLevelOperator
 MultiLevelOperator: An implementation of the Epetra_Operator class. More...
class  ML_Epetra::MultiLevelPreconditioner
 MultiLevelPreconditioner: a class to define black-box multilevel preconditioners using aggregation methods. More...
class  ML_Epetra::RowMatrix
 Basic wrapper from ML_Operator to Epetra_RowMatrix. More...
class  ML_Epetra::MatrixFreePreconditioner
 MatrixFreePreconditioner: a class to define preconditioners for Epetra_Operator's. More...

Functions

int SetDefaults (string ProblemType, Teuchos::ParameterList &List, int *options=0, double *params=0, const bool Overwrite=true)
 Sets default parameters for aggregation-based multigrid preconditioners.
int SetDefaultsDD (Teuchos::ParameterList &List, int *options=0, double *params=0, const bool Overwrite=true)
 Sets default parameters for aggregation-based 2-level domain decomposition preconditioners.
int SetDefaultsDD_LU (Teuchos::ParameterList &List, int *options=0, double *params=0, const bool Overwrite=true)
 Sets default parameters for aggregation-based 2-level domain decomposition preconditioners, using LU on each subdomain.
int SetDefaultsDD_3Levels (Teuchos::ParameterList &List, int *options=0, double *params=0, const bool Overwrite=true)
 Sets default parameters for aggregation-based 3-level domain decomposition preconditioners.
int SetDefaultsDD_3Levels_LU (Teuchos::ParameterList &List, int *options=0, double *params=0, const bool Overwrite=true)
 Sets default parameters for aggregation-based 3-level domain decomposition preconditioners with LU.
int SetDefaultsMaxwell (Teuchos::ParameterList &List, int *options=0, double *params=0, const bool Overwrite=true)
 Sets default parameters for Maxwell's equations.
int SetDefaultsSA (Teuchos::ParameterList &List, int *options=0, double *params=0, const bool Overwrite=true)
 Sets classical smoothed aggregation.

Detailed Description

ML_Epetra: default namespace for all Epetra interfaces.

Function Documentation

int ML_Epetra::SetDefaults (  string  ProblemType,
Teuchos::ParameterList &  List,
int *  options = 0,
double *  params = 0,
const bool  Overwrite = true
) 
 

Sets default parameters for aggregation-based multigrid preconditioners.

This function, defined in the namespace ML_Epetra, can be used to set appropriate default values in a user-provided Teuchos::ParameterList for different problem types.

Parameters:
ProblemType (In) : a string describing the desired preconditioner:
  • "SA" : classical smoothed aggregation multigrid;
  • "maxwell" : multigrid for Maxwell's equations;
  • "DD" : 2-level domain decomposition preconditioners based on aggregation;
  • "DD-LU" : Like "DD", but use exact LU decompositions on each subdomain;
  • "DD-ML" : 3-level domain decomposition preconditioners, with coarser spaces defined by aggregation;
  • "DD-ML-LU" : Like "DD-ML", but with LU decompositions on each subdomain.
List (Out) : list which will populated by the default parameters
options (In) : integer array, of size AZ_OPTIONS_SIZE, that will be populated with suitable values. A pointer to options will be stick into the parameters list. Note that this array is still required to apply the preconditioner! Do not delete options, nor let it go out of scope. The default value is 0, meaning that SetDefaults() will allocate the array. It is responsibility of the user to free this memory.
params (Out) : double array, of size AZ_PARAMS_SIZE. See comments for options.
Overwrite (In) : boolean. If false, any pre-existing values in the parameter list will be preserved. Default value is true, i.e., any pre-existing values may be overwritten.

int ML_Epetra::SetDefaultsDD (  Teuchos::ParameterList &  List,
int *  options = 0,
double *  params = 0,
const bool  OverWrite = true
) 
 

Sets default parameters for aggregation-based 2-level domain decomposition preconditioners.

Sets the following default values for "DD":

  • "default values" = DD"
  • "max levels" = 2
  • "output" = 0
  • "increasing or decreasing" = increasing"
  • "PDE equations" = 1
  • "aggregation: type" = METIS"
  • "aggregation: local aggregates" = 1
  • "aggregation: damping factor" = 1.333
  • "coarse: max size" = 128
  • "aggregation: threshold" = 0.0
  • "smoother: sweeps" = 2
  • "smoother: damping factor" = 0.67
  • "smoother: pre or post" = both"
  • "smoother: type" = Aztec".
  • "smoother: Aztec options" = options
  • "smoother: Aztec params" = params
  • "smoother: Aztec as solver" = false
  • "coarse: type" = Amesos-KLU"
  • "prec type" = MGV"
  • "print unused" = -2

int ML_Epetra::SetDefaultsDD_3Levels (  Teuchos::ParameterList &  List,
int *  options = 0,
double *  params = 0,
const bool  OverWrite = true
) 
 

Sets default parameters for aggregation-based 3-level domain decomposition preconditioners.

Sets the following default values for "DD"

  • "default values" = "DD-ML"
  • "max levels" = 3
  • "output" = 0
  • "increasing or decreasing" = "increasing"
  • "PDE equations" = 1
  • "aggregation: type" = "METIS"
  • "aggregation: type" = "METIS"
  • "aggregation: nodes per aggregate" = 64
  • "aggregation: damping factor" = 4.0/3
  • "coarse: max size" = 128
  • "aggregation: threshold" = 0.0
  • "smoother: sweeps" = 2
  • "smoother: damping factor" = 0.67
  • "smoother: pre or post" = "both"
  • "smoother: type" = "Aztec".
  • "smoother: Aztec options" = options
  • "smoother: Aztec params" = params
  • "smoother: Aztec as solver" = false
  • "coarse: type" = "Amesos-KLU"
  • "prec type" = "MGV"
  • "print unused" = -2

int ML_Epetra::SetDefaultsDD_3Levels_LU (  Teuchos::ParameterList &  List,
int *  options = 0,
double *  params = 0,
const bool  OverWrite = true
) 
 

Sets default parameters for aggregation-based 3-level domain decomposition preconditioners with LU.

As for SetDefaultsDD_3Levels, but with LU factorizations on each subdomain for each level

int ML_Epetra::SetDefaultsDD_LU (  Teuchos::ParameterList &  List,
int *  options = 0,
double *  params = 0,
const bool  OverWrite = true
) 
 

Sets default parameters for aggregation-based 2-level domain decomposition preconditioners, using LU on each subdomain.

As for SetDefaultsDD(), but used exact LU decompositions on each subdomains.

int ML_Epetra::SetDefaultsMaxwell (  Teuchos::ParameterList &  List,
int *  options = 0,
double *  params = 0,
const bool  OverWrite = true
) 
 

Sets default parameters for Maxwell's equations.

Set values for Maxwell:

  • "default values" = "maxwell"
  • General
    • "max levels" = 10
    • "output" = 0
    • "prec type" = "MGV"
    • "PDE equations" = 1
    • "print unused" = -2
  • Coarsening
    • "increasing or decreasing" = "decreasing"
    • "aggregation: type" = "Uncoupled-MIS"
    • "aggregation: damping factor" = 1.3333
    • "coarse: max size" = 75
    • "aggregation: threshold" = 0.0
    • "aggregation: edge prolongator drop threshold" = 0.0
  • Smoothing
    • "smoother: type" = "Hiptmair"
    • "smoother: sweeps" = 2
    • "smoother: Hiptmair efficient symmetric" = true
    • "smoother: damping factor" = 1.0
    • "smoother: type" = "MLS"
    • "smoother: MLS polynomial order" = 2
    • "smoother: pre or post" = "both"
  • Coarse Solution
    • "coarse: type" = "Amesos-KLU"

int ML_Epetra::SetDefaultsSA (  Teuchos::ParameterList &  List,
int *  options = 0,
double *  params = 0,
const bool  OverWrite = true
) 
 

Sets classical smoothed aggregation.

Set default values for classical smoothed aggregation:

  • "default values" = "SA"
    • General
      • "max levels" = 10
      • "output" = 0
      • "PDE equations" = 1
      • "prec type" = "MGV"
      • "print unused" = -2
    • Coarsening
      • "increasing or decreasing" = "increasing"
      • "aggregation: type" = "Uncoupled-MIS"
      • "aggregation: damping factor" = $\frac{4}{3}$
      • "coarse: max size" = 16
      • "aggregation: threshold" = 0.0
    • Smoothing
      • "smoother: sweeps" = 2
      • "smoother: damping factor" = $\frac{2}{3}$
      • "smoother: type" = "symmetric Gauss-Seidel"
      • "smoother: pre or post" = "both"
    • Coarse Solution
      • "coarse: type" = "Amesos-KLU"

Generated on Thu Sep 18 12:38:46 2008 for ML by doxygen 1.3.9.1