Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Stokhos::SGPreconditionerFactory Class Reference

Factory for generating stochastic Galerkin preconditioners. More...

#include <Stokhos_SGPreconditionerFactory.hpp>

Public Member Functions

 SGPreconditionerFactory (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Constructor. More...
 
virtual ~SGPreconditionerFactory ()
 Destructor. More...
 
virtual bool isPrecSupported () const
 Return whether a preconditioner will be supported. More...
 
virtual Teuchos::RCP
< Stokhos::SGPreconditioner
build (const Teuchos::RCP< const EpetraExt::MultiComm > &sg_comm, const Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > &sg_basis, const Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > &epetraCijk, const Teuchos::RCP< const Epetra_Map > &base_map, const Teuchos::RCP< const Epetra_Map > &sg_map)
 Build preconditioner operator. More...
 

Protected Member Functions

Teuchos::RCP
< Stokhos::AbstractPreconditionerFactory
buildMeanPreconditionerFactory ()
 Build preconditioner factory for mean. More...
 

Protected Attributes

Teuchos::RCP
< Teuchos::ParameterList
params
 Preconditioner parameters. More...
 
std::string prec_method
 Preconditioner method. More...
 

Private Member Functions

 SGPreconditionerFactory (const SGPreconditionerFactory &)
 Private to prohibit copying. More...
 
SGPreconditionerFactoryoperator= (const SGPreconditionerFactory &)
 Private to prohibit copying. More...
 

Detailed Description

Factory for generating stochastic Galerkin preconditioners.

Definition at line 25 of file Stokhos_SGPreconditionerFactory.hpp.

Constructor & Destructor Documentation

Stokhos::SGPreconditionerFactory::SGPreconditionerFactory ( const Teuchos::RCP< Teuchos::ParameterList > &  params)

Constructor.

Definition at line 23 of file Stokhos_SGPreconditionerFactory.cpp.

virtual Stokhos::SGPreconditionerFactory::~SGPreconditionerFactory ( )
inlinevirtual

Destructor.

Definition at line 33 of file Stokhos_SGPreconditionerFactory.hpp.

Stokhos::SGPreconditionerFactory::SGPreconditionerFactory ( const SGPreconditionerFactory )
private

Private to prohibit copying.

Member Function Documentation

bool Stokhos::SGPreconditionerFactory::isPrecSupported ( ) const
virtual

Return whether a preconditioner will be supported.

Definition at line 31 of file Stokhos_SGPreconditionerFactory.cpp.

Teuchos::RCP< Stokhos::SGPreconditioner > Stokhos::SGPreconditionerFactory::build ( const Teuchos::RCP< const EpetraExt::MultiComm > &  sg_comm,
const Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > &  sg_basis,
const Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > &  epetraCijk,
const Teuchos::RCP< const Epetra_Map > &  base_map,
const Teuchos::RCP< const Epetra_Map > &  sg_map 
)
virtual

Build preconditioner operator.

Definition at line 38 of file Stokhos_SGPreconditionerFactory.cpp.

Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > Stokhos::SGPreconditionerFactory::buildMeanPreconditionerFactory ( )
protected

Build preconditioner factory for mean.

Definition at line 124 of file Stokhos_SGPreconditionerFactory.cpp.

SGPreconditionerFactory& Stokhos::SGPreconditionerFactory::operator= ( const SGPreconditionerFactory )
private

Private to prohibit copying.

Member Data Documentation

Teuchos::RCP<Teuchos::ParameterList> Stokhos::SGPreconditionerFactory::params
protected

Preconditioner parameters.

Definition at line 64 of file Stokhos_SGPreconditionerFactory.hpp.

std::string Stokhos::SGPreconditionerFactory::prec_method
protected

Preconditioner method.

Definition at line 67 of file Stokhos_SGPreconditionerFactory.hpp.


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