ML_Epetra Namespace Reference

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


Classes

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

Functions

int SetDefaults (string ProblemType, Teuchos::ParameterList &List, int *options=0, double *params=0)
 Sets default parameters for aggregation-based 2-level domain decomposition preconditioners.
int SetDefaultsDD (Teuchos::ParameterList &List, int *options=0, double *params=0)
 Sets default parameters for aggregation-based 2-level domain decomposition preconditioners.
int SetDefaultsDD_LU (Teuchos::ParameterList &List, int *options=0, double *params=0)
 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)
 Sets default parameters for aggregation-based 3-level domain decomposition preconditioners.
int SetDefaultsDD_3Levels_LU (Teuchos::ParameterList &List, int *options=0, double *params=0)
 Sets default parameters for aggregation-based 3-level domain decomposition preconditioners with LU.
int SetDefaultsMaxwell (Teuchos::ParameterList &List, int *options=0, double *params=0)
 Sets default parameters for Maxwell's equations.
int SetDefaultsSA (Teuchos::ParameterList &List, int *options=0, double *params=0)
 Sets classical smoothed aggregation.
int SetParameters (int argc, char *argv[], Teuchos::ParameterList &List)
 Sets parameters in the given list from the command line.


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
 

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

This function, defined in the namespace ML_Epetra, can be used to set default values in a user's defined Teuchos::ParameterList.

Parameters:
ProblemType (In) : a string, whose possible values are:
  • "DD" : defaults for 2-level domain decomposition preconditioners based on aggregation;
  • "DD-ML" : 3-level domain decomposition preconditioners, with coarser spaces defined by aggregation;
  • "SA" : classical smoothed aggregation preconditioners;
  • "maxwell" : default values for Maxwell.
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.

int ML_Epetra::SetDefaultsDD Teuchos::ParameterList List,
int *  options = 0,
double *  params = 0
 

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" = 8
  • "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
 

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" = 8
  • "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
 

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
 

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
 

Sets default parameters for Maxwell's equations.

Set values for Maxwell:

  • "default values" = "maxwell"
  • "max levels" = 10
  • "output" = 10
  • "PDE equations" = 1
  • "increasing or decreasing" = "decreasing"
  • "aggregation: type" = "Uncoupled-MIS"
  • "aggregation: damping factor" = 1.3333
  • "coarse: max size" = 75
  • "aggregation: threshold" = 0.0
  • "smoother: sweeps" = 2
  • "smoother: damping factor" = 0.67
  • "smoother: type" = "MLS"
  • "smoother: MLS polynomial order" = 4
  • "smoother: pre or post" = "both"
  • "coarse: type" = "Amesos-Klu"
  • "prec type" = "MGV"
  • "print unused" = -2

int ML_Epetra::SetDefaultsSA Teuchos::ParameterList List,
int *  options = 0,
double *  params = 0
 

Sets classical smoothed aggregation.

Set default values for classical smoothed aggregation:

  • "default values" = "SA"
  • "max levels" = 10
  • "output" = 8
  • "PDE equations" = 1
  • "increasing or decreasing" = "increasing"
  • "aggregation: type" = "Uncoupled"
  • "aggregation: damping factor" = 1.3333
  • "coarse: max size" = 16
  • "aggregation: threshold" = 0.0
  • "smoother: sweeps" = 2
  • "smoother: damping factor" = 0.67
  • "smoother: type" = "Gauss-Seidel
  • "smoother: pre or post" = "both"
  • "coarse: type" = "Amesos-KLU"
  • "prec type" = "MGV"
  • "print unused" = -2


Generated on Thu Sep 18 12:42:34 2008 for ML by doxygen 1.3.9.1