Stokhos Development
Loading...
Searching...
No Matches
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.
virtual ~SGPreconditionerFactory ()
 Destructor.
virtual bool isPrecSupported () const
 Return whether a preconditioner will be supported.
virtual Teuchos::RCP< Stokhos::SGPreconditionerbuild (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.

Protected Member Functions

Teuchos::RCP< Stokhos::AbstractPreconditionerFactorybuildMeanPreconditionerFactory ()
 Build preconditioner factory for mean.

Protected Attributes

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

Detailed Description

Factory for generating stochastic Galerkin preconditioners.

Constructor & Destructor Documentation

◆ SGPreconditionerFactory()

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

Constructor.

References params, and prec_method.

Member Function Documentation

◆ build()

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.

References buildMeanPreconditionerFactory(), params, and prec_method.

◆ buildMeanPreconditionerFactory()

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

Build preconditioner factory for mean.

References params.

Referenced by build().

◆ isPrecSupported()

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

Return whether a preconditioner will be supported.

References prec_method.

Member Data Documentation

◆ params

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

Preconditioner parameters.

Referenced by build(), buildMeanPreconditionerFactory(), and SGPreconditionerFactory().

◆ prec_method

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

Preconditioner method.

Referenced by build(), isPrecSupported(), and SGPreconditionerFactory().


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