PETScWrappers

Collaboration diagram for PETScWrappers:

Modules
	SLEPcWrappers

Namespaces
namespace	PETScWrappers
namespace	PETScWrappers::MPI
namespace	internal

Classes
class	PETScWrappers::MPI::BlockSparseMatrix
class	PETScWrappers::MPI::BlockVector
class	PETScWrappers::FullMatrix
class	PETScWrappers::MatrixIterators::const_iterator
class	PETScWrappers::MatrixBase
class	PETScWrappers::MatrixFree
class	PETScWrappers::PreconditionBase
class	PETScWrappers::PreconditionJacobi
class	PETScWrappers::PreconditionBlockJacobi
class	PETScWrappers::PreconditionSOR
class	PETScWrappers::PreconditionSSOR
class	PETScWrappers::PreconditionICC
class	PETScWrappers::PreconditionILU
class	PETScWrappers::PreconditionLU
class	PETScWrappers::PreconditionBoomerAMG
class	PETScWrappers::PreconditionParaSails
class	PETScWrappers::PreconditionNone
class	PETScWrappers::PreconditionBDDC< dim >
class	PETScWrappers::NonlinearSolver< VectorType, PMatrixType, AMatrixType >
class	PETScWrappers::SolverBase
class	PETScWrappers::SolverRichardson
class	PETScWrappers::SolverChebychev
class	PETScWrappers::SolverCG
class	PETScWrappers::SolverBiCG
class	PETScWrappers::SolverGMRES
class	PETScWrappers::SolverBicgstab
class	PETScWrappers::SolverCGS
class	PETScWrappers::SolverTFQMR
class	PETScWrappers::SolverTCQMR
class	PETScWrappers::SolverCR
class	PETScWrappers::SolverLSQR
class	PETScWrappers::SolverPreOnly
class	PETScWrappers::SparseDirectMUMPS
class	PETScWrappers::SparseMatrix
class	PETScWrappers::MPI::SparseMatrix
class	PETScWrappers::TimeStepper< VectorType, PMatrixType, AMatrixType >
class	PETScWrappers::MPI::Vector
class	PETScWrappers::VectorBase

Functions
	PETScWrappers::NonlinearSolverData::NonlinearSolverData (const std::string &options_prefix="", const std::string &snes_type="", const std::string &snes_linesearch_type="", const real_type absolute_tolerance=0, const real_type relative_tolerance=0, const real_type step_tolerance=0, const int maximum_non_linear_iterations=-1, const int max_n_function_evaluations=-1)
	PETScWrappers::TimeStepperData::TimeStepperData (const std::string &options_prefix="", const std::string &ts_type="", const real_type initial_time=0.0, const real_type final_time=0.0, const real_type initial_step_size=0.0, const int max_steps=-1, const bool match_step=false, const std::string &ts_adapt_type="none", const real_type minimum_step_size=-1.0, const real_type maximum_step_size=-1.0, const real_type absolute_tolerance=-1.0, const real_type relative_tolerance=-1.0, const bool ignore_algebraic_lte=true)

Detailed Description

The classes in this module are wrappers around functionality provided by the PETSc library. They provide a modern object-oriented interface that is compatible with the interfaces of the other linear algebra classes in deal.II. All classes and functions in this group reside in a namespace PETScWrappers.

These classes are only available if a PETSc installation was detected during configuration of deal.II. Refer to the README file for more details about this.

Function Documentation

NonlinearSolverData()

PETScWrappers::NonlinearSolverData::NonlinearSolverData ( const std::string &  options_prefix = "", const std::string &  snes_type = "", const std::string &  snes_linesearch_type = "", const real_type  absolute_tolerance = 0, const real_type  relative_tolerance = 0, const real_type  step_tolerance = 0, const int  maximum_non_linear_iterations = -1, const int  max_n_function_evaluations = -1  )

inline

Initialization parameters for NonlinearSolverData.

Running parameters:

Parameters

options_prefix	The string indicating the options prefix for command line customization.
snes_type	The string indicating the PETSc SNES solver type.
snes_linesearch_type	The string indicating the PETSc linesearch type.
absolute_tolerance	Absolute error tolerance.
relative_tolerance	Relative error tolerance.
step_tolerance	Step tolerance.
maximum_non_linear_iterations	Maximum number of iterations allowed.
max_n_function_evaluations	Maximum number of function evaluations allowed.

Note

All parameters values specified here can be overridden by command line choices.

Definition at line 74 of file petsc_snes.h.

TimeStepperData()

PETScWrappers::TimeStepperData::TimeStepperData ( const std::string &  options_prefix = "", const std::string &  ts_type = "", const real_type  initial_time = 0.0, const real_type  final_time = 0.0, const real_type  initial_step_size = 0.0, const int  max_steps = -1, const bool  match_step = false, const std::string &  ts_adapt_type = "none", const real_type  minimum_step_size = -1.0, const real_type  maximum_step_size = -1.0, const real_type  absolute_tolerance = -1.0, const real_type  relative_tolerance = -1.0, const bool  ignore_algebraic_lte = true  )

inline

Initialization parameters for TimeStepper.

Running parameters:

Parameters

options_prefix	The string indicating the options prefix for command line customization.
ts_type	The string indicating the PETSc solver type.
initial_time	Initial simulation time.
final_time	Final simulation time.
initial_step_size	Initial step size.
max_steps	Maximum number of steps allowed.
match_step	Whether or not to exactly stop at final time or step over it.

Error parameters:

Parameters

ts_adapt_type	The string indicating the PETSc time step adaptor type.
minimum_step_size	Minimum step size allowed.
maximum_step_size	Maximum step size allowed.
absolute_tolerance	Absolute error tolerance.
relative_tolerance	Relative error tolerance.
ignore_algebraic_lte	Ignore algebraic terms for error computations

Note that one between final_time or max_steps must be specified by the user, otherwise PETSc will complain. Adaptive time stepping is disabled by default. Negative values indicate using PETSc's default.

Note

All parameters values specified here can be overridden by command line choices.

Definition at line 88 of file petsc_ts.h.